mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2025-06-05 21:39:12 +02:00
Update include/ comments to Doxygen formatting (see issue #3384)
See related guidelines in the issue.
This commit is contained in:
Marshall Greenblatt
@ -46,8 +46,8 @@
|
||||
#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.
|
||||
/// 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 {
|
||||
@ -59,8 +59,8 @@ class CefRenderHandler : public virtual CefBaseRefCounted {
|
||||
typedef cef_text_input_mode_t TextInputMode;
|
||||
|
||||
///
|
||||
// Return the handler for accessibility notifications. If no handler is
|
||||
// provided the default implementation will be used.
|
||||
/// Return the handler for accessibility notifications. If no handler is
|
||||
/// provided the default implementation will be used.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefRefPtr<CefAccessibilityHandler> GetAccessibilityHandler() {
|
||||
@ -68,9 +68,9 @@ class CefRenderHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// 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.
|
||||
/// 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.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool GetRootScreenRect(CefRefPtr<CefBrowser> browser, CefRect& rect) {
|
||||
@ -78,17 +78,17 @@ class CefRenderHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called to retrieve the view rectangle in screen DIP coordinates. This
|
||||
// method must always provide a non-empty rectangle.
|
||||
/// Called to retrieve the view rectangle in screen DIP coordinates. This
|
||||
/// method must always provide a non-empty rectangle.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) = 0;
|
||||
|
||||
///
|
||||
// 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.
|
||||
/// 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.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool GetScreenPoint(CefRefPtr<CefBrowser> browser,
|
||||
@ -100,13 +100,13 @@ class CefRenderHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// 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.
|
||||
/// 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,
|
||||
@ -115,30 +115,30 @@ class CefRenderHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// 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.
|
||||
/// 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.
|
||||
/// 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. This method is only called when
|
||||
// CefWindowInfo::shared_texture_enabled is set to false.
|
||||
/// 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.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnPaint(CefRefPtr<CefBrowser> browser,
|
||||
@ -149,13 +149,13 @@ class CefRenderHandler : public virtual CefBaseRefCounted {
|
||||
int height) = 0;
|
||||
|
||||
///
|
||||
// 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.
|
||||
/// 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.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnAcceleratedPaint(CefRefPtr<CefBrowser> browser,
|
||||
@ -164,8 +164,8 @@ class CefRenderHandler : public virtual CefBaseRefCounted {
|
||||
void* shared_handle) {}
|
||||
|
||||
///
|
||||
// Called to retrieve the size of the touch handle for the specified
|
||||
// |orientation|.
|
||||
/// Called to retrieve the size of the touch handle for the specified
|
||||
/// |orientation|.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void GetTouchHandleSize(CefRefPtr<CefBrowser> browser,
|
||||
@ -173,27 +173,27 @@ class CefRenderHandler : public virtual CefBaseRefCounted {
|
||||
CefSize& size) {}
|
||||
|
||||
///
|
||||
// Called when touch handle state is updated. The client is responsible for
|
||||
// rendering the touch handles.
|
||||
/// Called when touch handle state is updated. The client is responsible for
|
||||
/// rendering the touch handles.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnTouchHandleStateChanged(CefRefPtr<CefBrowser> browser,
|
||||
const CefTouchHandleState& state) {}
|
||||
|
||||
///
|
||||
// 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.
|
||||
/// 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,
|
||||
@ -205,16 +205,16 @@ class CefRenderHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// 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).
|
||||
/// 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.
|
||||
/// Called when the scroll offset has changed.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnScrollOffsetChanged(CefRefPtr<CefBrowser> browser,
|
||||
@ -222,9 +222,9 @@ class CefRenderHandler : public virtual CefBaseRefCounted {
|
||||
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.
|
||||
/// 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,
|
||||
@ -232,9 +232,9 @@ class CefRenderHandler : public virtual CefBaseRefCounted {
|
||||
const RectList& character_bounds) {}
|
||||
|
||||
///
|
||||
// Called when text selection has changed for the specified |browser|.
|
||||
// |selected_text| is the currently selected text and |selected_range| is
|
||||
// the character 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.
|
||||
///
|
||||
/*--cef(optional_param=selected_text,optional_param=selected_range)--*/
|
||||
virtual void OnTextSelectionChanged(CefRefPtr<CefBrowser> browser,
|
||||
@ -242,10 +242,10 @@ class CefRenderHandler : public virtual CefBaseRefCounted {
|
||||
const CefRange& selected_range) {}
|
||||
|
||||
///
|
||||
// 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.
|
||||
/// 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.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnVirtualKeyboardRequested(CefRefPtr<CefBrowser> browser,
|
||||
|
||||
Reference in New Issue
Block a user