Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 80.1.4+g8927396+chromium-80.0.3987.149
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

(default)
Class CefRenderHandler

CefBaseRefCounted
   |
   +--CefRenderHandler

   in cef_render_handler.h

class CefRenderHandler
extends CefBaseRefCounted

Implement this interface to handle events when window rendering is disabled. The methods of this class will be called on the UI thread.


Inner Classes, Typedefs, and Enums
typedef CefRenderHandler::CursorType
          
typedef CefRenderHandler::DragOperation
          
typedef CefRenderHandler::DragOperationsMask
          
typedef CefRenderHandler::PaintElementType
          
typedef CefRenderHandler::RectList
          
typedef CefRenderHandler::TextInputMode
          
 
Method Summary
 virtual CefRefPtr< CefAccessibilityHandler > GetAccessibilityHandler()
          Return the handler for accessibility notifications.
 virtual bool GetRootScreenRect( CefRefPtr< CefBrowser > browser, CefRect& rect )
          Called to retrieve the root window rectangle in screen coordinates.
 virtual bool GetScreenInfo( CefRefPtr< CefBrowser > browser, CefScreenInfo& screen_info )
          Called to allow the client to fill in the CefScreenInfo object with appropriate values.
 virtual bool GetScreenPoint( CefRefPtr< CefBrowser > browser, int viewX, int viewY, int& screenX, int& screenY )
          Called to retrieve the translation from view coordinates to actual screen coordinates.
 virtual void GetViewRect( CefRefPtr< CefBrowser > browser, CefRect& rect )= 0
          Called to retrieve the view rectangle which is relative to screen coordinates.
 virtual void OnAcceleratedPaint( CefRefPtr< CefBrowser > browser, CefRenderHandler::PaintElementType type, const CefRenderHandler::RectList& dirtyRects, void* shared_handle )
          Called when an element has been rendered to the shared texture handle.
 virtual void OnCursorChange( CefRefPtr< CefBrowser > browser, CefCursorHandle cursor, CefRenderHandler::CursorType type, const CefCursorInfo& custom_cursor_info )
          Called when the browser's cursor has changed.
 virtual void OnImeCompositionRangeChanged( CefRefPtr< CefBrowser > browser, const CefRange& selected_range, const CefRenderHandler::RectList& character_bounds )
          Called when the IME composition range has changed.
 virtual void OnPaint( CefRefPtr< CefBrowser > browser, CefRenderHandler::PaintElementType type, const CefRenderHandler::RectList& dirtyRects, const void* buffer, int width, int height )= 0
          Called when an element should be painted.
 virtual void OnPopupShow( CefRefPtr< CefBrowser > browser, bool show )
          Called when the browser wants to show or hide the popup widget.
 virtual void OnPopupSize( CefRefPtr< CefBrowser > browser, const CefRect& rect )
          Called when the browser wants to move or resize the popup widget.
 virtual void OnScrollOffsetChanged( CefRefPtr< CefBrowser > browser, double x, double y )
          Called when the scroll offset has changed.
 virtual void OnTextSelectionChanged( CefRefPtr< CefBrowser > browser, const CefString& selected_text, const CefRange& selected_range )
          Called when text selection has changed for the specified |browser|.
 virtual void OnVirtualKeyboardRequested( CefRefPtr< CefBrowser > browser, CefRenderHandler::TextInputMode input_mode )
          Called when an on-screen keyboard should be shown or hidden for the specified |browser|.
 virtual bool StartDragging( CefRefPtr< CefBrowser > browser, CefRefPtr< CefDragData > drag_data, CefRenderHandler::DragOperationsMask allowed_ops, int x, int y )
          Called when the user starts dragging content in the web view.
 virtual void UpdateDragCursor( CefRefPtr< CefBrowser > browser, CefRenderHandler::DragOperation operation )
          Called when the web view wants to update the mouse cursor during a drag & drop operation.
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef, HasAtLeastOneRef
 

Method Detail

GetAccessibilityHandler

public virtual CefRefPtr< CefAccessibilityHandler > GetAccessibilityHandler();
Return the handler for accessibility notifications. If no handler is provided the default implementation will be used.

GetRootScreenRect

public virtual bool GetRootScreenRect( CefRefPtr< CefBrowser > browser, CefRect& rect );
Called to retrieve the root window rectangle in screen coordinates. Return true if the rectangle was provided. If this method returns false the rectangle from GetViewRect will be used.

GetScreenInfo

public virtual bool GetScreenInfo( CefRefPtr< CefBrowser > browser, CefScreenInfo& screen_info );
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

public virtual bool GetScreenPoint( CefRefPtr< CefBrowser > browser, int viewX, int viewY, int& screenX, int& screenY );
Called to retrieve the translation from view coordinates to actual screen coordinates. Return true if the screen coordinates were provided.

GetViewRect

public virtual void GetViewRect( CefRefPtr< CefBrowser > browser, CefRect& rect )= 0;
Called to retrieve the view rectangle which is relative to screen coordinates. This method must always provide a non-empty rectangle.

OnAcceleratedPaint

public virtual void OnAcceleratedPaint( CefRefPtr< CefBrowser > browser, CefRenderHandler::PaintElementType type, const CefRenderHandler::RectList& dirtyRects, void* shared_handle );
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. |shared_handle| is the handle for a D3D11 Texture2D that can be accessed via ID3D11Device using the OpenSharedResource method. This method is only called when CefWindowInfo::shared_texture_enabled is set to true, and is currently only supported on Windows.

OnCursorChange

public virtual void OnCursorChange( CefRefPtr< CefBrowser > browser, CefCursorHandle cursor, CefRenderHandler::CursorType type, const CefCursorInfo& custom_cursor_info );
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.

OnImeCompositionRangeChanged

public virtual void OnImeCompositionRangeChanged( CefRefPtr< CefBrowser > browser, const CefRange& selected_range, const CefRenderHandler::RectList& character_bounds );
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

public virtual void OnPaint( CefRefPtr< CefBrowser > browser, CefRenderHandler::PaintElementType type, const CefRenderHandler::RectList& dirtyRects, const void* buffer, int width, int height )= 0;
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

public virtual void OnPopupShow( CefRefPtr< CefBrowser > browser, bool show );
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

public virtual void OnPopupSize( CefRefPtr< CefBrowser > browser, const CefRect& rect );
Called when the browser wants to move or resize the popup widget. |rect| contains the new location and size in view coordinates.

OnScrollOffsetChanged

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

OnTextSelectionChanged

public virtual void OnTextSelectionChanged( CefRefPtr< CefBrowser > browser, const CefString& selected_text, const CefRange& selected_range );
Called when text selection has changed for the specified |browser|. |selected_text| is the currently selected text and |selected_range| is the character range.

OnVirtualKeyboardRequested

public virtual void OnVirtualKeyboardRequested( CefRefPtr< CefBrowser > browser, CefRenderHandler::TextInputMode input_mode );
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

public virtual bool StartDragging( CefRefPtr< CefBrowser > browser, CefRefPtr< CefDragData > drag_data, CefRenderHandler::DragOperationsMask allowed_ops, int x, int y );
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

public virtual void UpdateDragCursor( CefRefPtr< CefBrowser > browser, CefRenderHandler::DragOperation operation );
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).

 Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 80.1.4+g8927396+chromium-80.0.3987.149
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

Chromium Embedded Framework (CEF) Copyright © 2016 Marshall A. Greenblatt