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,48 +46,48 @@
|
||||
class CefContextMenuParams;
|
||||
|
||||
///
|
||||
// Callback interface used for continuation of custom context menu display.
|
||||
/// Callback interface used for continuation of custom context menu display.
|
||||
///
|
||||
/*--cef(source=library)--*/
|
||||
class CefRunContextMenuCallback : public virtual CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// Complete context menu display by selecting the specified |command_id| and
|
||||
// |event_flags|.
|
||||
/// Complete context menu display by selecting the specified |command_id| and
|
||||
/// |event_flags|.
|
||||
///
|
||||
/*--cef(capi_name=cont)--*/
|
||||
virtual void Continue(int command_id, cef_event_flags_t event_flags) = 0;
|
||||
|
||||
///
|
||||
// Cancel context menu display.
|
||||
/// Cancel context menu display.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void Cancel() = 0;
|
||||
};
|
||||
|
||||
///
|
||||
// Callback interface used for continuation of custom quick menu display.
|
||||
/// Callback interface used for continuation of custom quick menu display.
|
||||
///
|
||||
/*--cef(source=library)--*/
|
||||
class CefRunQuickMenuCallback : public virtual CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// Complete quick menu display by selecting the specified |command_id| and
|
||||
// |event_flags|.
|
||||
/// Complete quick menu display by selecting the specified |command_id| and
|
||||
/// |event_flags|.
|
||||
///
|
||||
/*--cef(capi_name=cont)--*/
|
||||
virtual void Continue(int command_id, cef_event_flags_t event_flags) = 0;
|
||||
|
||||
///
|
||||
// Cancel quick menu display.
|
||||
/// Cancel quick menu display.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void Cancel() = 0;
|
||||
};
|
||||
|
||||
///
|
||||
// Implement this interface to handle context menu events. The methods of this
|
||||
// class will be called on the UI thread.
|
||||
/// Implement this interface to handle context menu events. The methods of this
|
||||
/// class will be called on the UI thread.
|
||||
///
|
||||
/*--cef(source=client)--*/
|
||||
class CefContextMenuHandler : public virtual CefBaseRefCounted {
|
||||
@ -96,11 +96,11 @@ class CefContextMenuHandler : public virtual CefBaseRefCounted {
|
||||
typedef cef_quick_menu_edit_state_flags_t QuickMenuEditStateFlags;
|
||||
|
||||
///
|
||||
// Called before a context menu is displayed. |params| provides information
|
||||
// about the context menu state. |model| initially contains the default
|
||||
// context menu. The |model| can be cleared to show no context menu or
|
||||
// modified to show a custom menu. Do not keep references to |params| or
|
||||
// |model| outside of this callback.
|
||||
/// Called before a context menu is displayed. |params| provides information
|
||||
/// about the context menu state. |model| initially contains the default
|
||||
/// context menu. The |model| can be cleared to show no context menu or
|
||||
/// modified to show a custom menu. Do not keep references to |params| or
|
||||
/// |model| outside of this callback.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnBeforeContextMenu(CefRefPtr<CefBrowser> browser,
|
||||
@ -109,12 +109,12 @@ class CefContextMenuHandler : public virtual CefBaseRefCounted {
|
||||
CefRefPtr<CefMenuModel> model) {}
|
||||
|
||||
///
|
||||
// Called to allow custom display of the context menu. |params| provides
|
||||
// information about the context menu state. |model| contains the context menu
|
||||
// model resulting from OnBeforeContextMenu. For custom display return true
|
||||
// and execute |callback| either synchronously or asynchronously with the
|
||||
// selected command ID. For default display return false. Do not keep
|
||||
// references to |params| or |model| outside of this callback.
|
||||
/// Called to allow custom display of the context menu. |params| provides
|
||||
/// information about the context menu state. |model| contains the context
|
||||
/// menu model resulting from OnBeforeContextMenu. For custom display return
|
||||
/// true and execute |callback| either synchronously or asynchronously with
|
||||
/// the selected command ID. For default display return false. Do not keep
|
||||
/// references to |params| or |model| outside of this callback.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool RunContextMenu(CefRefPtr<CefBrowser> browser,
|
||||
@ -126,13 +126,13 @@ class CefContextMenuHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called to execute a command selected from the context menu. Return true if
|
||||
// the command was handled or false for the default implementation. See
|
||||
// cef_menu_id_t for the command ids that have default implementations. All
|
||||
// user-defined command ids should be between MENU_ID_USER_FIRST and
|
||||
// MENU_ID_USER_LAST. |params| will have the same values as what was passed to
|
||||
// OnBeforeContextMenu(). Do not keep a reference to |params| outside of this
|
||||
// callback.
|
||||
/// Called to execute a command selected from the context menu. Return true if
|
||||
/// the command was handled or false for the default implementation. See
|
||||
/// cef_menu_id_t for the command ids that have default implementations. All
|
||||
/// user-defined command ids should be between MENU_ID_USER_FIRST and
|
||||
/// MENU_ID_USER_LAST. |params| will have the same values as what was passed
|
||||
/// to OnBeforeContextMenu(). Do not keep a reference to |params| outside of
|
||||
/// this callback.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool OnContextMenuCommand(CefRefPtr<CefBrowser> browser,
|
||||
@ -144,20 +144,20 @@ class CefContextMenuHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called when the context menu is dismissed irregardless of whether the menu
|
||||
// was canceled or a command was selected.
|
||||
/// Called when the context menu is dismissed irregardless of whether the menu
|
||||
/// was canceled or a command was selected.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnContextMenuDismissed(CefRefPtr<CefBrowser> browser,
|
||||
CefRefPtr<CefFrame> frame) {}
|
||||
|
||||
///
|
||||
// Called to allow custom display of the quick menu for a windowless browser.
|
||||
// |location| is the top left corner of the selected region. |size| is the
|
||||
// size of the selected region. |edit_state_flags| is a combination of flags
|
||||
// that represent the state of the quick menu. Return true if the menu will be
|
||||
// handled and execute |callback| either synchronously or asynchronously with
|
||||
// the selected command ID. Return false to cancel the menu.
|
||||
/// Called to allow custom display of the quick menu for a windowless browser.
|
||||
/// |location| is the top left corner of the selected region. |size| is the
|
||||
/// size of the selected region. |edit_state_flags| is a combination of flags
|
||||
/// that represent the state of the quick menu. Return true if the menu will
|
||||
/// be handled and execute |callback| either synchronously or asynchronously
|
||||
/// with the selected command ID. Return false to cancel the menu.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool RunQuickMenu(CefRefPtr<CefBrowser> browser,
|
||||
@ -170,10 +170,10 @@ class CefContextMenuHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called to execute a command selected from the quick menu for a windowless
|
||||
// browser. Return true if the command was handled or false for the default
|
||||
// implementation. See cef_menu_id_t for command IDs that have default
|
||||
// implementations.
|
||||
/// Called to execute a command selected from the quick menu for a windowless
|
||||
/// browser. Return true if the command was handled or false for the default
|
||||
/// implementation. See cef_menu_id_t for command IDs that have default
|
||||
/// implementations.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool OnQuickMenuCommand(CefRefPtr<CefBrowser> browser,
|
||||
@ -184,8 +184,8 @@ class CefContextMenuHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called when the quick menu for a windowless browser is dismissed
|
||||
// irregardless of whether the menu was canceled or a command was selected.
|
||||
/// Called when the quick menu for a windowless browser is dismissed
|
||||
/// irregardless of whether the menu was canceled or a command was selected.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnQuickMenuDismissed(CefRefPtr<CefBrowser> browser,
|
||||
@ -193,8 +193,8 @@ class CefContextMenuHandler : public virtual CefBaseRefCounted {
|
||||
};
|
||||
|
||||
///
|
||||
// Provides information about the context menu state. The methods of this class
|
||||
// can only be accessed on browser process the UI thread.
|
||||
/// Provides information about the context menu state. The methods of this class
|
||||
/// can only be accessed on browser process the UI thread.
|
||||
///
|
||||
/*--cef(source=library)--*/
|
||||
class CefContextMenuParams : public virtual CefBaseRefCounted {
|
||||
@ -205,138 +205,140 @@ class CefContextMenuParams : public virtual CefBaseRefCounted {
|
||||
typedef cef_context_menu_edit_state_flags_t EditStateFlags;
|
||||
|
||||
///
|
||||
// Returns the X coordinate of the mouse where the context menu was invoked.
|
||||
// Coords are relative to the associated RenderView's origin.
|
||||
/// Returns the X coordinate of the mouse where the context menu was invoked.
|
||||
/// Coords are relative to the associated RenderView's origin.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual int GetXCoord() = 0;
|
||||
|
||||
///
|
||||
// Returns the Y coordinate of the mouse where the context menu was invoked.
|
||||
// Coords are relative to the associated RenderView's origin.
|
||||
/// Returns the Y coordinate of the mouse where the context menu was invoked.
|
||||
/// Coords are relative to the associated RenderView's origin.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual int GetYCoord() = 0;
|
||||
|
||||
///
|
||||
// Returns flags representing the type of node that the context menu was
|
||||
// invoked on.
|
||||
/// Returns flags representing the type of node that the context menu was
|
||||
/// invoked on.
|
||||
///
|
||||
/*--cef(default_retval=CM_TYPEFLAG_NONE)--*/
|
||||
virtual TypeFlags GetTypeFlags() = 0;
|
||||
|
||||
///
|
||||
// Returns the URL of the link, if any, that encloses the node that the
|
||||
// context menu was invoked on.
|
||||
/// Returns the URL of the link, if any, that encloses the node that the
|
||||
/// context menu was invoked on.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetLinkUrl() = 0;
|
||||
|
||||
///
|
||||
// Returns the link URL, if any, to be used ONLY for "copy link address". We
|
||||
// don't validate this field in the frontend process.
|
||||
/// Returns the link URL, if any, to be used ONLY for "copy link address". We
|
||||
/// don't validate this field in the frontend process.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetUnfilteredLinkUrl() = 0;
|
||||
|
||||
///
|
||||
// Returns the source URL, if any, for the element that the context menu was
|
||||
// invoked on. Example of elements with source URLs are img, audio, and video.
|
||||
/// Returns the source URL, if any, for the element that the context menu was
|
||||
/// invoked on. Example of elements with source URLs are img, audio, and
|
||||
/// video.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetSourceUrl() = 0;
|
||||
|
||||
///
|
||||
// Returns true if the context menu was invoked on an image which has
|
||||
// non-empty contents.
|
||||
/// Returns true if the context menu was invoked on an image which has
|
||||
/// non-empty contents.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool HasImageContents() = 0;
|
||||
|
||||
///
|
||||
// Returns the title text or the alt text if the context menu was invoked on
|
||||
// an image.
|
||||
/// Returns the title text or the alt text if the context menu was invoked on
|
||||
/// an image.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetTitleText() = 0;
|
||||
|
||||
///
|
||||
// Returns the URL of the top level page that the context menu was invoked on.
|
||||
/// Returns the URL of the top level page that the context menu was invoked
|
||||
/// on.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetPageUrl() = 0;
|
||||
|
||||
///
|
||||
// Returns the URL of the subframe that the context menu was invoked on.
|
||||
/// Returns the URL of the subframe that the context menu was invoked on.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetFrameUrl() = 0;
|
||||
|
||||
///
|
||||
// Returns the character encoding of the subframe that the context menu was
|
||||
// invoked on.
|
||||
/// Returns the character encoding of the subframe that the context menu was
|
||||
/// invoked on.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetFrameCharset() = 0;
|
||||
|
||||
///
|
||||
// Returns the type of context node that the context menu was invoked on.
|
||||
/// Returns the type of context node that the context menu was invoked on.
|
||||
///
|
||||
/*--cef(default_retval=CM_MEDIATYPE_NONE)--*/
|
||||
virtual MediaType GetMediaType() = 0;
|
||||
|
||||
///
|
||||
// Returns flags representing the actions supported by the media element, if
|
||||
// any, that the context menu was invoked on.
|
||||
/// Returns flags representing the actions supported by the media element, if
|
||||
/// any, that the context menu was invoked on.
|
||||
///
|
||||
/*--cef(default_retval=CM_MEDIAFLAG_NONE)--*/
|
||||
virtual MediaStateFlags GetMediaStateFlags() = 0;
|
||||
|
||||
///
|
||||
// Returns the text of the selection, if any, that the context menu was
|
||||
// invoked on.
|
||||
/// Returns the text of the selection, if any, that the context menu was
|
||||
/// invoked on.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetSelectionText() = 0;
|
||||
|
||||
///
|
||||
// Returns the text of the misspelled word, if any, that the context menu was
|
||||
// invoked on.
|
||||
/// Returns the text of the misspelled word, if any, that the context menu was
|
||||
/// invoked on.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetMisspelledWord() = 0;
|
||||
|
||||
///
|
||||
// Returns true if suggestions exist, false otherwise. Fills in |suggestions|
|
||||
// from the spell check service for the misspelled word if there is one.
|
||||
/// Returns true if suggestions exist, false otherwise. Fills in |suggestions|
|
||||
/// from the spell check service for the misspelled word if there is one.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool GetDictionarySuggestions(
|
||||
std::vector<CefString>& suggestions) = 0;
|
||||
|
||||
///
|
||||
// Returns true if the context menu was invoked on an editable node.
|
||||
/// Returns true if the context menu was invoked on an editable node.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool IsEditable() = 0;
|
||||
|
||||
///
|
||||
// Returns true if the context menu was invoked on an editable node where
|
||||
// spell-check is enabled.
|
||||
/// Returns true if the context menu was invoked on an editable node where
|
||||
/// spell-check is enabled.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool IsSpellCheckEnabled() = 0;
|
||||
|
||||
///
|
||||
// Returns flags representing the actions supported by the editable node, if
|
||||
// any, that the context menu was invoked on.
|
||||
/// Returns flags representing the actions supported by the editable node, if
|
||||
/// any, that the context menu was invoked on.
|
||||
///
|
||||
/*--cef(default_retval=CM_EDITFLAG_NONE)--*/
|
||||
virtual EditStateFlags GetEditStateFlags() = 0;
|
||||
|
||||
///
|
||||
// Returns true if the context menu contains items specified by the renderer
|
||||
// process.
|
||||
/// Returns true if the context menu contains items specified by the renderer
|
||||
/// process.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool IsCustomMenu() = 0;
|
||||
|
||||
Reference in New Issue
Block a user