Skip to content

Latest commit

 

History

History
157 lines (101 loc) · 4.14 KB

File metadata and controls

157 lines (101 loc) · 4.14 KB

API categories | API index

RenderHandler (interface)

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

Table of contents:

Callbacks

GetRootScreenRect

Parameter Type
browser Browser
out rect list
Return bool

Called to retrieve the root window rectangle in screen coordinates. Return true if the rectangle was provided.

GetViewRect

Parameter Type
browser Browser
out rect list
Return bool

Called to retrieve the view rectangle which is relative to screen coordinates. Return true if the rectangle was provided.

The rect list should contain 4 elements: [x, y, width, height].

GetScreenRect

Parameter Type
browser Browser
out rect list
Return bool

Called to retrieve the simulated screen rectangle. Return true if the rectangle was provided.

The rect list should contain 4 elements: [x, y, width, height].

GetScreenPoint

Parameter Type
browser Browser
viewX int
viewY int
out screenCoordinates list
Return bool

Called to retrieve the translation from view coordinates to actual screen coordinates. Return true if the screen coordinates were provided.

The screenCoordinates list should contain 2 elements: [x, y].

GetScreenInfo

Parameter Type
browser Browser
screen_info CefScreenInfo&
Return bool

Not yet implemented.

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.

OnPopupShow

Parameter Type
browser Browser
show bool
Return void

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

Parameter Type
browser Browser
rect list
Return void

Called when the browser wants to move or resize the popup widget. |rect| contains the new location and size.

The rect list should contain 4 elements: [x, y, width, height].

OnPaint

Parameter Type
browser Browser
paintElementType int
out dirtyRects list
buffer PaintBuffer
width int
height int
Return void

Called when an element should be painted. |paintElementType| 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 that need to be repainted. On Windows |buffer| will be width*height*4 bytes in size and represents a BGRA image with an upper-left origin. The BrowserSettings.animation_frame_rate value controls the rate at which this method is called.

paintElementType is one of:

cefpython.PET_VIEW
cefpython.PET_POPUP

dirtyRects is a list of rects: [[x, y, width, height], [..]]

OnCursorChange

Parameter Type
browser Browser
cursor CursorHandle
Return void

Called when the browser window's cursor has changed.

CursorHandle is an int pointer.

OnScrollOffsetChanged

Parameter Type
browser Browser
Return void

Called when the scroll offset has changed.