Implement this interface to handle events when window rendering is disabled. More...

#include "include/cef_render_handler.h"

Inheritance diagram for CefRenderHandler:

Public Types
typedef cef_drag_operations_mask_t	DragOperation

typedef cef_drag_operations_mask_t	DragOperationsMask

typedef cef_paint_element_type_t	PaintElementType

typedef std::vector< CefRect >	RectList

typedef cef_text_input_mode_t	TextInputMode

Public Member Functions
virtual CefRefPtr< CefAccessibilityHandler >	GetAccessibilityHandler ()
	Return the handler for accessibility notifications. More...

virtual bool	GetRootScreenRect (CefRefPtr< CefBrowser > browser, CefRect &rect)
	Called to retrieve the root window rectangle in screen DIP coordinates. More...

virtual void	GetViewRect (CefRefPtr< CefBrowser > browser, CefRect &rect)=0
	Called to retrieve the view rectangle in screen DIP coordinates. More...

virtual bool	GetScreenPoint (CefRefPtr< CefBrowser > browser, int viewX, int viewY, int &screenX, int &screenY)
	Called to retrieve the translation from view DIP coordinates to screen coordinates. More...

virtual bool	GetScreenInfo (CefRefPtr< CefBrowser > browser, CefScreenInfo &screen_info)
	Called to allow the client to fill in the CefScreenInfo object with appropriate values. More...

virtual void	OnPopupShow (CefRefPtr< CefBrowser > browser, bool show)
	Called when the browser wants to show or hide the popup widget. More...

virtual void	OnPopupSize (CefRefPtr< CefBrowser > browser, const CefRect &rect)
	Called when the browser wants to move or resize the popup widget. More...

virtual void	OnPaint (CefRefPtr< CefBrowser > browser, PaintElementType type, const RectList &dirtyRects, const void *buffer, int width, int height)=0
	Called when an element should be painted. More...

virtual void	OnAcceleratedPaint (CefRefPtr< CefBrowser > browser, PaintElementType type, const RectList &dirtyRects, const CefAcceleratedPaintInfo &info)
	Called when an element has been rendered to the shared texture handle. More...

virtual void	GetTouchHandleSize (CefRefPtr< CefBrowser > browser, cef_horizontal_alignment_t orientation, CefSize &size)
	Called to retrieve the size of the touch handle for the specified \|orientation\|. More...

virtual void	OnTouchHandleStateChanged (CefRefPtr< CefBrowser > browser, const CefTouchHandleState &state)
	Called when touch handle state is updated. More...

virtual bool	StartDragging (CefRefPtr< CefBrowser > browser, CefRefPtr< CefDragData > drag_data, DragOperationsMask allowed_ops, int x, int y)
	Called when the user starts dragging content in the web view. More...

virtual void	UpdateDragCursor (CefRefPtr< CefBrowser > browser, DragOperation operation)
	Called when the web view wants to update the mouse cursor during a drag & drop operation. More...

virtual void	OnScrollOffsetChanged (CefRefPtr< CefBrowser > browser, double x, double y)
	Called when the scroll offset has changed. More...

virtual void	OnImeCompositionRangeChanged (CefRefPtr< CefBrowser > browser, const CefRange &selected_range, const RectList &character_bounds)
	Called when the IME composition range has changed. More...

virtual void	OnTextSelectionChanged (CefRefPtr< CefBrowser > browser, const CefString &selected_text, const CefRange &selected_range)
	Called when text selection has changed for the specified \|browser\|. More...

virtual void	OnVirtualKeyboardRequested (CefRefPtr< CefBrowser > browser, TextInputMode input_mode)
	Called when an on-screen keyboard should be shown or hidden for the specified \|browser\|. 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 when window rendering is disabled.

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

Member Typedef Documentation

◆ DragOperation

typedef cef_drag_operations_mask_t CefRenderHandler::DragOperation

◆ DragOperationsMask

typedef cef_drag_operations_mask_t CefRenderHandler::DragOperationsMask

◆ PaintElementType

typedef cef_paint_element_type_t CefRenderHandler::PaintElementType

◆ RectList

typedef std::vector<CefRect> CefRenderHandler::RectList

◆ TextInputMode

typedef cef_text_input_mode_t CefRenderHandler::TextInputMode

Member Function Documentation

◆ GetAccessibilityHandler()

virtual CefRefPtr<CefAccessibilityHandler> CefRenderHandler::GetAccessibilityHandler ( )

inlinevirtual

Return the handler for accessibility notifications.

If no handler is provided the default implementation will be used.

◆ GetRootScreenRect()

virtual bool CefRenderHandler::GetRootScreenRect	(	CefRefPtr< CefBrowser >	browser,
		CefRect &	rect
	)

inlinevirtual

Called to retrieve the root window rectangle in screen DIP coordinates.

Return true if the rectangle was provided. If this method returns false the rectangle from GetViewRect will be used.

◆ GetScreenInfo()

virtual bool CefRenderHandler::GetScreenInfo	(	CefRefPtr< CefBrowser >	browser,
		CefScreenInfo &	screen_info
	)

inlinevirtual

Called to allow the client to fill in the CefScreenInfo object with appropriate values.

Return true if the |screen_info| structure has been modified.

If the screen info rectangle is left empty the rectangle from GetViewRect will be used. If the rectangle is still empty or invalid popups may not be drawn correctly.

◆ GetScreenPoint()

virtual bool CefRenderHandler::GetScreenPoint	(	CefRefPtr< CefBrowser >	browser,
		int	viewX,
		int	viewY,
		int &	screenX,
		int &	screenY
	)

inlinevirtual

Called to retrieve the translation from view DIP coordinates to screen coordinates.

Windows/Linux should provide screen device (pixel) coordinates and MacOS should provide screen DIP coordinates. Return true if the requested coordinates were provided.

◆ GetTouchHandleSize()

virtual void CefRenderHandler::GetTouchHandleSize	(	CefRefPtr< CefBrowser >	browser,
		cef_horizontal_alignment_t	orientation,
		CefSize &	size
	)

inlinevirtual

Called to retrieve the size of the touch handle for the specified |orientation|.

◆ GetViewRect()

virtual void CefRenderHandler::GetViewRect	(	CefRefPtr< CefBrowser >	browser,
		CefRect &	rect
	)

pure virtual

Called to retrieve the view rectangle in screen DIP coordinates.

This method must always provide a non-empty rectangle.

◆ OnAcceleratedPaint()

virtual void CefRenderHandler::OnAcceleratedPaint	(	CefRefPtr< CefBrowser >	browser,
		PaintElementType	type,
		const RectList &	dirtyRects,
		const CefAcceleratedPaintInfo &	info
	)

inlinevirtual

Called when an element has been rendered to the shared texture handle.

|type| indicates whether the element is the view or the popup widget. |dirtyRects| contains the set of rectangles in pixel coordinates that need to be repainted. |info| contains the shared handle; on Windows it is a HANDLE to a texture that can be opened with D3D11 OpenSharedResource, on macOS it is an IOSurface pointer that can be opened with Metal or OpenGL, and on Linux it contains several planes, each with an fd to the underlying system native buffer.

The underlying implementation uses a pool to deliver frames. As a result, the handle may differ every frame depending on how many frames are in-progress. The handle's resource cannot be cached and cannot be accessed outside of this callback. It should be reopened each time this callback is executed and the contents should be copied to a texture owned by the client application. The contents of |info| will be released back to the pool after this callback returns.

◆ OnImeCompositionRangeChanged()

virtual void CefRenderHandler::OnImeCompositionRangeChanged	(	CefRefPtr< CefBrowser >	browser,
		const CefRange &	selected_range,
		const RectList &	character_bounds
	)

inlinevirtual

Called when the IME composition range has changed.

|selected_range| is the range of characters that have been selected. |character_bounds| is the bounds of each character in view coordinates.

◆ OnPaint()

virtual void CefRenderHandler::OnPaint	(	CefRefPtr< CefBrowser >	browser,
		PaintElementType	type,
		const RectList &	dirtyRects,
		const void *	buffer,
		int	width,
		int	height
	)

pure virtual

Called when an element should be painted.

Pixel values passed to this method are scaled relative to view coordinates based on the value of CefScreenInfo.device_scale_factor returned from GetScreenInfo. |type| indicates whether the element is the view or the popup widget. |buffer| contains the pixel data for the whole image. |dirtyRects| contains the set of rectangles in pixel coordinates that need to be repainted. |buffer| will be |width|*|height|*4 bytes in size and represents a BGRA image with an upper-left origin. This method is only called when CefWindowInfo::shared_texture_enabled is set to false.

◆ OnPopupShow()

virtual void CefRenderHandler::OnPopupShow	(	CefRefPtr< CefBrowser >	browser,
		bool	show
	)

inlinevirtual

Called when the browser wants to show or hide the popup widget.

The popup should be shown if |show| is true and hidden if |show| is false.

◆ OnPopupSize()

virtual void CefRenderHandler::OnPopupSize	(	CefRefPtr< CefBrowser >	browser,
		const CefRect &	rect
	)

inlinevirtual

Called when the browser wants to move or resize the popup widget.

|rect| contains the new location and size in view coordinates.

◆ OnScrollOffsetChanged()

virtual void CefRenderHandler::OnScrollOffsetChanged	(	CefRefPtr< CefBrowser >	browser,
		double	x,
		double	y
	)

inlinevirtual

Called when the scroll offset has changed.

◆ OnTextSelectionChanged()

virtual void CefRenderHandler::OnTextSelectionChanged	(	CefRefPtr< CefBrowser >	browser,
		const CefString &	selected_text,
		const CefRange &	selected_range
	)

inlinevirtual

Called when text selection has changed for the specified |browser|.

|selected_text| is the currently selected text and |selected_range| is the character range.

◆ OnTouchHandleStateChanged()

virtual void CefRenderHandler::OnTouchHandleStateChanged	(	CefRefPtr< CefBrowser >	browser,
		const CefTouchHandleState &	state
	)

inlinevirtual

Called when touch handle state is updated.

The client is responsible for rendering the touch handles.

◆ OnVirtualKeyboardRequested()

virtual void CefRenderHandler::OnVirtualKeyboardRequested	(	CefRefPtr< CefBrowser >	browser,
		TextInputMode	input_mode
	)

inlinevirtual

Called when an on-screen keyboard should be shown or hidden for the specified |browser|.

|input_mode| specifies what kind of keyboard should be opened. If |input_mode| is CEF_TEXT_INPUT_MODE_NONE, any existing keyboard for this browser should be hidden.

◆ StartDragging()

virtual bool CefRenderHandler::StartDragging	(	CefRefPtr< CefBrowser >	browser,
		CefRefPtr< CefDragData >	drag_data,
		DragOperationsMask	allowed_ops,
		int	x,
		int	y
	)

inlinevirtual

Called when the user starts dragging content in the web view.

Contextual information about the dragged content is supplied by |drag_data|. (|x|, |y|) is the drag start location in screen coordinates. OS APIs that run a system message loop may be used within the StartDragging call.

Return false to abort the drag operation. Don't call any of CefBrowserHost::DragSource*Ended* methods after returning false.

Return true to handle the drag operation. Call CefBrowserHost::DragSourceEndedAt and DragSourceSystemDragEnded either synchronously or asynchronously to inform the web view that the drag operation has ended.

◆ UpdateDragCursor()

virtual void CefRenderHandler::UpdateDragCursor	(	CefRefPtr< CefBrowser >	browser,
		DragOperation	operation
	)

inlinevirtual

Called when the web view wants to update the mouse cursor during a drag & drop operation.

|operation| describes the allowed operation (none, move, copy, link).

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

include/cef_render_handler.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DragOperation

◆ DragOperationsMask

◆ PaintElementType

◆ RectList

◆ TextInputMode

Member Function Documentation

◆ GetAccessibilityHandler()

◆ GetRootScreenRect()

◆ GetScreenInfo()

◆ GetScreenPoint()

◆ GetTouchHandleSize()

◆ GetViewRect()

◆ OnAcceleratedPaint()

◆ OnImeCompositionRangeChanged()

◆ OnPaint()

◆ OnPopupShow()

◆ OnPopupSize()

◆ OnScrollOffsetChanged()

◆ OnTextSelectionChanged()

◆ OnTouchHandleStateChanged()

◆ OnVirtualKeyboardRequested()

◆ StartDragging()

◆ UpdateDragCursor()