cefpython/src/include/cef_render_handler.h at cefpython58 · 2php/cefpython · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

// Redistribution and use in source and binary forms, with or without

// modification, are permitted provided that the following conditions are

// met:

// * Redistributions of source code must retain the above copyright

// notice, this list of conditions and the following disclaimer.

// * Redistributions in binary form must reproduce the above

// copyright notice, this list of conditions and the following disclaimer

// in the documentation and/or other materials provided with the

// distribution.

// * Neither the name of Google Inc. nor the name Chromium Embedded

// Framework nor the names of its contributors may be used to endorse

// or promote products derived from this software without specific prior

// written permission.

// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// ---------------------------------------------------------------------------

// The contents of this file must follow a specific format in order to

// support the CEF translator tool. See the translator.README.txt file in the

// tools directory for more information.

#ifndef CEF_INCLUDE_CEF_RENDER_HANDLER_H_

#define CEF_INCLUDE_CEF_RENDER_HANDLER_H_

#pragma once

#include <vector>

#include "include/cef_base.h"

#include "include/cef_browser.h"

#include "include/cef_drag_data.h"

///

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

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

///

/*--cef(source=client)--*/

class CefRenderHandler : public virtual CefBaseRefCounted {

public:

typedef cef_cursor_type_t CursorType;

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;

///

// Called to retrieve the root window rectangle in screen coordinates. Return

// true if the rectangle was provided.

///

/*--cef()--*/

virtual bool GetRootScreenRect(CefRefPtr<CefBrowser> browser,

CefRect& rect) { return false; }

///

// Called to retrieve the view rectangle which is relative to screen

// coordinates. Return true if the rectangle was provided.

///

/*--cef()--*/

virtual bool GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) =0;

///

// Called to retrieve the translation from view coordinates to actual screen

// coordinates. Return true if the screen coordinates were provided.

///

/*--cef()--*/

virtual bool GetScreenPoint(CefRefPtr<CefBrowser> browser,

int viewX,

int viewY,

int& screenX,

int& screenY) { return false; }

///

// 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.

///

/*--cef()--*/

virtual bool GetScreenInfo(CefRefPtr<CefBrowser> browser,

CefScreenInfo& screen_info) { return false; }

///

// 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.

///

/*--cef()--*/

virtual void OnPopupShow(CefRefPtr<CefBrowser> browser,

bool show) {}

///

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

// contains the new location and size in view coordinates.

///

/*--cef()--*/

virtual void OnPopupSize(CefRefPtr<CefBrowser> browser,

const CefRect& rect) {}

///

// 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.

///

/*--cef()--*/

virtual void OnPaint(CefRefPtr<CefBrowser> browser,

PaintElementType type,

const RectList& dirtyRects,

const void* buffer,

int width, int height) =0;

///

// 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.

///

/*--cef()--*/

virtual void OnCursorChange(CefRefPtr<CefBrowser> browser,

CefCursorHandle cursor,

CursorType type,

const CefCursorInfo& custom_cursor_info) {}

///

// 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.

///

/*--cef()--*/

virtual bool StartDragging(CefRefPtr<CefBrowser> browser,

CefRefPtr<CefDragData> drag_data,

DragOperationsMask allowed_ops,

int x, int y) { return false; }

///

// 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).

///

/*--cef()--*/

virtual void UpdateDragCursor(CefRefPtr<CefBrowser> browser,

DragOperation operation) {}

///

// Called when the scroll offset has changed.

///

/*--cef()--*/

virtual void OnScrollOffsetChanged(CefRefPtr<CefBrowser> browser,

double x,

double y) {}

///

// 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.

///

/*--cef()--*/

virtual void OnImeCompositionRangeChanged(CefRefPtr<CefBrowser> browser,

const CefRange& selected_range,

const RectList& character_bounds) {}

};

#endif // CEF_INCLUDE_CEF_RENDER_HANDLER_H_

cefpython/src/include/cef_render_handler.h at cefpython58 · 2php/cefpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

cef_render_handler.h

Latest commit

History

Breadcrumbs

cef_render_handler.h

File metadata and controls