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:
@ -43,14 +43,14 @@
|
||||
#include "include/cef_frame.h"
|
||||
|
||||
///
|
||||
// Implement this interface to handle events related to browser display state.
|
||||
// The methods of this class will be called on the UI thread.
|
||||
/// Implement this interface to handle events related to browser display state.
|
||||
/// The methods of this class will be called on the UI thread.
|
||||
///
|
||||
/*--cef(source=client)--*/
|
||||
class CefDisplayHandler : public virtual CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// Called when a frame's address has changed.
|
||||
/// Called when a frame's address has changed.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnAddressChange(CefRefPtr<CefBrowser> browser,
|
||||
@ -58,37 +58,37 @@ class CefDisplayHandler : public virtual CefBaseRefCounted {
|
||||
const CefString& url) {}
|
||||
|
||||
///
|
||||
// Called when the page title changes.
|
||||
/// Called when the page title changes.
|
||||
///
|
||||
/*--cef(optional_param=title)--*/
|
||||
virtual void OnTitleChange(CefRefPtr<CefBrowser> browser,
|
||||
const CefString& title) {}
|
||||
|
||||
///
|
||||
// Called when the page icon changes.
|
||||
/// Called when the page icon changes.
|
||||
///
|
||||
/*--cef(optional_param=icon_urls)--*/
|
||||
virtual void OnFaviconURLChange(CefRefPtr<CefBrowser> browser,
|
||||
const std::vector<CefString>& icon_urls) {}
|
||||
|
||||
///
|
||||
// Called when web content in the page has toggled fullscreen mode. If
|
||||
// |fullscreen| is true the content will automatically be sized to fill the
|
||||
// browser content area. If |fullscreen| is false the content will
|
||||
// automatically return to its original size and position. The client is
|
||||
// responsible for resizing the browser if desired.
|
||||
/// Called when web content in the page has toggled fullscreen mode. If
|
||||
/// |fullscreen| is true the content will automatically be sized to fill the
|
||||
/// browser content area. If |fullscreen| is false the content will
|
||||
/// automatically return to its original size and position. The client is
|
||||
/// responsible for resizing the browser if desired.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnFullscreenModeChange(CefRefPtr<CefBrowser> browser,
|
||||
bool fullscreen) {}
|
||||
|
||||
///
|
||||
// Called when the browser is about to display a tooltip. |text| contains the
|
||||
// text that will be displayed in the tooltip. To handle the display of the
|
||||
// tooltip yourself return true. Otherwise, you can optionally modify |text|
|
||||
// and then return false to allow the browser to display the tooltip.
|
||||
// When window rendering is disabled the application is responsible for
|
||||
// drawing tooltips and the return value is ignored.
|
||||
/// Called when the browser is about to display a tooltip. |text| contains the
|
||||
/// text that will be displayed in the tooltip. To handle the display of the
|
||||
/// tooltip yourself return true. Otherwise, you can optionally modify |text|
|
||||
/// and then return false to allow the browser to display the tooltip.
|
||||
/// When window rendering is disabled the application is responsible for
|
||||
/// drawing tooltips and the return value is ignored.
|
||||
///
|
||||
/*--cef(optional_param=text)--*/
|
||||
virtual bool OnTooltip(CefRefPtr<CefBrowser> browser, CefString& text) {
|
||||
@ -96,16 +96,16 @@ class CefDisplayHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called when the browser receives a status message. |value| contains the
|
||||
// text that will be displayed in the status message.
|
||||
/// Called when the browser receives a status message. |value| contains the
|
||||
/// text that will be displayed in the status message.
|
||||
///
|
||||
/*--cef(optional_param=value)--*/
|
||||
virtual void OnStatusMessage(CefRefPtr<CefBrowser> browser,
|
||||
const CefString& value) {}
|
||||
|
||||
///
|
||||
// Called to display a console message. Return true to stop the message from
|
||||
// being output to the console.
|
||||
/// Called to display a console message. Return true to stop the message from
|
||||
/// being output to the console.
|
||||
///
|
||||
/*--cef(optional_param=message,optional_param=source)--*/
|
||||
virtual bool OnConsoleMessage(CefRefPtr<CefBrowser> browser,
|
||||
@ -117,10 +117,10 @@ class CefDisplayHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called when auto-resize is enabled via CefBrowserHost::SetAutoResizeEnabled
|
||||
// and the contents have auto-resized. |new_size| will be the desired size in
|
||||
// view coordinates. Return true if the resize was handled or false for
|
||||
// default handling.
|
||||
/// Called when auto-resize is enabled via
|
||||
/// CefBrowserHost::SetAutoResizeEnabled and the contents have auto-resized.
|
||||
/// |new_size| will be the desired size in view coordinates. Return true if
|
||||
/// the resize was handled or false for default handling.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool OnAutoResize(CefRefPtr<CefBrowser> browser,
|
||||
@ -129,17 +129,18 @@ class CefDisplayHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called when the overall page loading progress has changed. |progress|
|
||||
// ranges from 0.0 to 1.0.
|
||||
/// Called when the overall page loading progress has changed. |progress|
|
||||
/// ranges from 0.0 to 1.0.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnLoadingProgressChange(CefRefPtr<CefBrowser> browser,
|
||||
double progress) {}
|
||||
|
||||
///
|
||||
// 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.
|
||||
// Return true if the cursor change was handled or false for default handling.
|
||||
/// 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.
|
||||
/// Return true if the cursor change was handled or false for default
|
||||
/// handling.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool OnCursorChange(CefRefPtr<CefBrowser> browser,
|
||||
@ -150,8 +151,8 @@ class CefDisplayHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called when the browser's access to an audio and/or video source has
|
||||
// changed.
|
||||
/// Called when the browser's access to an audio and/or video source has
|
||||
/// changed.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnMediaAccessChange(CefRefPtr<CefBrowser> browser,
|
||||
|
Reference in New Issue
Block a user