Chromium Embedded Framework (CEF)  115.2.0+g096e3eb+chromium-115.0.5790.13
CefLoadHandler Class Reference

Implement this interface to handle events related to browser load status. More...

#include "include/cef_load_handler.h"

Inheritance diagram for CefLoadHandler:
CefBaseRefCounted

Public Types

typedef cef_errorcode_t ErrorCode
 
typedef cef_transition_type_t TransitionType
 

Public Member Functions

virtual void OnLoadingStateChange (CefRefPtr< CefBrowser > browser, bool isLoading, bool canGoBack, bool canGoForward)
 Called when the loading state has changed. More...
 
virtual void OnLoadStart (CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, TransitionType transition_type)
 Called after a navigation has been committed and before the browser begins loading contents in the frame. More...
 
virtual void OnLoadEnd (CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, int httpStatusCode)
 Called when the browser is done loading a frame. More...
 
virtual void OnLoadError (CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, ErrorCode errorCode, const CefString &errorText, const CefString &failedUrl)
 Called when a navigation fails or is canceled. More...
 
- Public Member Functions inherited from CefBaseRefCounted
virtual void AddRef () const =0
 Called to increment the reference count for the object. More...
 
virtual bool Release () const =0
 Called to decrement the reference count for the object. More...
 
virtual bool HasOneRef () const =0
 Returns true if the reference count is 1. More...
 
virtual bool HasAtLeastOneRef () const =0
 Returns true if the reference count is at least 1. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CefBaseRefCounted
virtual ~CefBaseRefCounted ()
 

Detailed Description

Implement this interface to handle events related to browser load status.

The methods of this class will be called on the browser process UI thread or render process main thread (TID_RENDERER).

Member Typedef Documentation

◆ ErrorCode

◆ TransitionType

Member Function Documentation

◆ OnLoadEnd()

virtual void CefLoadHandler::OnLoadEnd ( CefRefPtr< CefBrowser browser,
CefRefPtr< CefFrame frame,
int  httpStatusCode 
)
inlinevirtual

Called when the browser is done loading a frame.

The |frame| value will never be empty – call the IsMain() method to check if this frame is the main frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This method will not be called for same page navigations (fragments, history state, etc.) or for navigations that fail or are canceled before commit. For notification of overall browser load status use OnLoadingStateChange instead.

◆ OnLoadError()

virtual void CefLoadHandler::OnLoadError ( CefRefPtr< CefBrowser browser,
CefRefPtr< CefFrame frame,
ErrorCode  errorCode,
const CefString errorText,
const CefString failedUrl 
)
inlinevirtual

Called when a navigation fails or is canceled.

This method may be called by itself if before commit or in combination with OnLoadStart/OnLoadEnd if after commit. |errorCode| is the error code number, |errorText| is the error text and |failedUrl| is the URL that failed to load. See net\base\net_error_list.h for complete descriptions of the error codes.

◆ OnLoadingStateChange()

virtual void CefLoadHandler::OnLoadingStateChange ( CefRefPtr< CefBrowser browser,
bool  isLoading,
bool  canGoBack,
bool  canGoForward 
)
inlinevirtual

Called when the loading state has changed.

This callback will be executed twice – once when loading is initiated either programmatically or by user action, and once when loading is terminated due to completion, cancellation of failure. It will be called before any calls to OnLoadStart and after all calls to OnLoadError and/or OnLoadEnd.

◆ OnLoadStart()

virtual void CefLoadHandler::OnLoadStart ( CefRefPtr< CefBrowser browser,
CefRefPtr< CefFrame frame,
TransitionType  transition_type 
)
inlinevirtual

Called after a navigation has been committed and before the browser begins loading contents in the frame.

The |frame| value will never be empty – call the IsMain() method to check if this frame is the main frame. |transition_type| provides information about the source of the navigation and an accurate value is only available in the browser process. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This method will not be called for same page navigations (fragments, history state, etc.) or for navigations that fail or are canceled before commit. For notification of overall browser load status use OnLoadingStateChange instead.


The documentation for this class was generated from the following file: