Implement this interface to handle events related to browser display state. More...

#include "include/cef_display_handler.h"

Inheritance diagram for CefDisplayHandler:

Public Member Functions
virtual void	OnAddressChange (CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, const CefString &url)
	Called when a frame's address has changed. More...

virtual void	OnTitleChange (CefRefPtr< CefBrowser > browser, const CefString &title)
	Called when the page title changes. More...

virtual void	OnFaviconURLChange (CefRefPtr< CefBrowser > browser, const std::vector< CefString > &icon_urls)
	Called when the page icon changes. More...

virtual void	OnFullscreenModeChange (CefRefPtr< CefBrowser > browser, bool fullscreen)
	Called when web content in the page has toggled fullscreen mode. More...

virtual bool	OnTooltip (CefRefPtr< CefBrowser > browser, CefString &text)
	Called when the browser is about to display a tooltip. More...

virtual void	OnStatusMessage (CefRefPtr< CefBrowser > browser, const CefString &value)
	Called when the browser receives a status message. More...

virtual bool	OnConsoleMessage (CefRefPtr< CefBrowser > browser, cef_log_severity_t level, const CefString &message, const CefString &source, int line)
	Called to display a console message. More...

virtual bool	OnAutoResize (CefRefPtr< CefBrowser > browser, const CefSize &new_size)
	Called when auto-resize is enabled via CefBrowserHost::SetAutoResizeEnabled and the contents have auto-resized. More...

virtual void	OnLoadingProgressChange (CefRefPtr< CefBrowser > browser, double progress)
	Called when the overall page loading progress has changed. More...

virtual bool	OnCursorChange (CefRefPtr< CefBrowser > browser, CefCursorHandle cursor, cef_cursor_type_t type, const CefCursorInfo &custom_cursor_info)
	Called when the browser's cursor has changed. More...

virtual void	OnMediaAccessChange (CefRefPtr< CefBrowser > browser, bool has_video_access, bool has_audio_access)
	Called when the browser's access to an audio and/or video source has changed. More...

virtual bool	OnContentsBoundsChange (CefRefPtr< CefBrowser > browser, const CefRect &new_bounds)
	Called when JavaScript is requesting new bounds via window.moveTo/By() or window.resizeTo/By(). More...

virtual bool	GetRootWindowScreenRect (CefRefPtr< CefBrowser > browser, CefRect &rect)
	Called to retrieve the external (client-provided) root window rectangle in screen DIP coordinates. 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 display state.

The methods of this class will be called on the UI thread.

Member Function Documentation

◆ GetRootWindowScreenRect()

virtual bool CefDisplayHandler::GetRootWindowScreenRect	(	CefRefPtr< CefBrowser >	browser,
		CefRect &	rect
	)

inlinevirtual

Called to retrieve the external (client-provided) root window rectangle in screen DIP coordinates.

Only called for windowed browsers on Windows and Linux. Return true if the rectangle was provided. Return false to use the root window bounds on Windows or the browser content bounds on Linux. For additional usage details see CefBrowserHost::NotifyScreenInfoChanged.

◆ OnAddressChange()

virtual void CefDisplayHandler::OnAddressChange	(	CefRefPtr< CefBrowser >	browser,
		CefRefPtr< CefFrame >	frame,
		const CefString &	url
	)

inlinevirtual

Called when a frame's address has changed.

◆ OnAutoResize()

virtual bool CefDisplayHandler::OnAutoResize	(	CefRefPtr< CefBrowser >	browser,
		const CefSize &	new_size
	)

inlinevirtual

Called when auto-resize is enabled via CefBrowserHost::SetAutoResizeEnabled and the contents have auto-resized.

|new_size| will be the desired size in DIP coordinates. Return true if the resize was handled or false for default handling.

◆ OnConsoleMessage()

virtual bool CefDisplayHandler::OnConsoleMessage	(	CefRefPtr< CefBrowser >	browser,
		cef_log_severity_t	level,
		const CefString &	message,
		const CefString &	source,
		int	line
	)

inlinevirtual

Called to display a console message.

Return true to stop the message from being output to the console.

◆ OnContentsBoundsChange()

virtual bool CefDisplayHandler::OnContentsBoundsChange	(	CefRefPtr< CefBrowser >	browser,
		const CefRect &	new_bounds
	)

inlinevirtual

Called when JavaScript is requesting new bounds via window.moveTo/By() or window.resizeTo/By().

|new_bounds| are in DIP screen coordinates.

With Views-hosted browsers |new_bounds| are the desired bounds for the containing CefWindow and may be passed directly to CefWindow::SetBounds. With external (client-provided) parent on macOS and Windows |new_bounds| are the desired frame bounds for the containing root window. With other non-Views browsers |new_bounds| are the desired bounds for the browser content only unless the client implements either CefDisplayHandler::GetRootWindowScreenRect for windowed browsers or CefRenderHandler::GetWindowScreenRect for windowless browsers. Clients may expand browser content bounds to window bounds using OS-specific or CefDisplay methods.

Return true if this method was handled or false for default handling. Default move/resize behavior is only provided with Views-hosted Chrome style browsers.

◆ OnCursorChange()

virtual bool CefDisplayHandler::OnCursorChange	(	CefRefPtr< CefBrowser >	browser,
		CefCursorHandle	cursor,
		cef_cursor_type_t	type,
		const CefCursorInfo &	custom_cursor_info
	)

inlinevirtual

Called when the browser's cursor has changed.

If |type| is CT_CUSTOM then |custom_cursor_info| will be populated with the custom cursor information. Return true if the cursor change was handled or false for default handling.

◆ OnFaviconURLChange()

virtual void CefDisplayHandler::OnFaviconURLChange	(	CefRefPtr< CefBrowser >	browser,
		const std::vector< CefString > &	icon_urls
	)

inlinevirtual

Called when the page icon changes.

◆ OnFullscreenModeChange()

virtual void CefDisplayHandler::OnFullscreenModeChange	(	CefRefPtr< CefBrowser >	browser,
		bool	fullscreen
	)

inlinevirtual

Called when web content in the page has toggled fullscreen mode.

If |fullscreen| is true the content will automatically be sized to fill the browser content area. If |fullscreen| is false the content will automatically return to its original size and position. With Alloy style the client is responsible for triggering the fullscreen transition (for example, by calling CefWindow::SetFullscreen when using Views). With Chrome style the fullscreen transition will be triggered automatically. The CefWindowDelegate::OnWindowFullscreenTransition method will be called during the fullscreen transition for notification purposes.

◆ OnLoadingProgressChange()

virtual void CefDisplayHandler::OnLoadingProgressChange	(	CefRefPtr< CefBrowser >	browser,
		double	progress
	)

inlinevirtual

Called when the overall page loading progress has changed.

|progress| ranges from 0.0 to 1.0.

◆ OnMediaAccessChange()

virtual void CefDisplayHandler::OnMediaAccessChange	(	CefRefPtr< CefBrowser >	browser,
		bool	has_video_access,
		bool	has_audio_access
	)

inlinevirtual

Called when the browser's access to an audio and/or video source has changed.

◆ OnStatusMessage()

virtual void CefDisplayHandler::OnStatusMessage	(	CefRefPtr< CefBrowser >	browser,
		const CefString &	value
	)

inlinevirtual

Called when the browser receives a status message.

|value| contains the text that will be displayed in the status message.

◆ OnTitleChange()

virtual void CefDisplayHandler::OnTitleChange	(	CefRefPtr< CefBrowser >	browser,
		const CefString &	title
	)

inlinevirtual

Called when the page title changes.

◆ OnTooltip()

virtual bool CefDisplayHandler::OnTooltip	(	CefRefPtr< CefBrowser >	browser,
		CefString &	text
	)

inlinevirtual

Called when the browser is about to display a tooltip.

|text| contains the text that will be displayed in the tooltip. To handle the display of the tooltip yourself return true. Otherwise, you can optionally modify |text| and then return false to allow the browser to display the tooltip. When window rendering is disabled the application is responsible for drawing tooltips and the return value is ignored.

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

include/cef_display_handler.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetRootWindowScreenRect()

◆ OnAddressChange()

◆ OnAutoResize()

◆ OnConsoleMessage()

◆ OnContentsBoundsChange()

◆ OnCursorChange()

◆ OnFaviconURLChange()

◆ OnFullscreenModeChange()

◆ OnLoadingProgressChange()

◆ OnMediaAccessChange()

◆ OnStatusMessage()

◆ OnTitleChange()

◆ OnTooltip()