Chromium Embedded Framework (CEF)  130.1.2+g48f3ef6+chromium-130.0.6723.44
CefContextMenuParams Class Referenceabstract

Provides information about the context menu state. More...

#include "include/cef_context_menu_handler.h"

Inheritance diagram for CefContextMenuParams:
CefBaseRefCounted

Public Types

typedef cef_context_menu_type_flags_t TypeFlags
 
typedef cef_context_menu_media_type_t MediaType
 
typedef cef_context_menu_media_state_flags_t MediaStateFlags
 
typedef cef_context_menu_edit_state_flags_t EditStateFlags
 

Public Member Functions

virtual int GetXCoord ()=0
 Returns the X coordinate of the mouse where the context menu was invoked. More...
 
virtual int GetYCoord ()=0
 Returns the Y coordinate of the mouse where the context menu was invoked. More...
 
virtual TypeFlags GetTypeFlags ()=0
 Returns flags representing the type of node that the context menu was invoked on. More...
 
virtual CefString GetLinkUrl ()=0
 Returns the URL of the link, if any, that encloses the node that the context menu was invoked on. More...
 
virtual CefString GetUnfilteredLinkUrl ()=0
 Returns the link URL, if any, to be used ONLY for "copy link address". More...
 
virtual CefString GetSourceUrl ()=0
 Returns the source URL, if any, for the element that the context menu was invoked on. More...
 
virtual bool HasImageContents ()=0
 Returns true if the context menu was invoked on an image which has non-empty contents. More...
 
virtual CefString GetTitleText ()=0
 Returns the title text or the alt text if the context menu was invoked on an image. More...
 
virtual CefString GetPageUrl ()=0
 Returns the URL of the top level page that the context menu was invoked on. More...
 
virtual CefString GetFrameUrl ()=0
 Returns the URL of the subframe that the context menu was invoked on. More...
 
virtual CefString GetFrameCharset ()=0
 Returns the character encoding of the subframe that the context menu was invoked on. More...
 
virtual MediaType GetMediaType ()=0
 Returns the type of context node that the context menu was invoked on. More...
 
virtual MediaStateFlags GetMediaStateFlags ()=0
 Returns flags representing the actions supported by the media element, if any, that the context menu was invoked on. More...
 
virtual CefString GetSelectionText ()=0
 Returns the text of the selection, if any, that the context menu was invoked on. More...
 
virtual CefString GetMisspelledWord ()=0
 Returns the text of the misspelled word, if any, that the context menu was invoked on. More...
 
virtual bool GetDictionarySuggestions (std::vector< CefString > &suggestions)=0
 Returns true if suggestions exist, false otherwise. More...
 
virtual bool IsEditable ()=0
 Returns true if the context menu was invoked on an editable node. More...
 
virtual bool IsSpellCheckEnabled ()=0
 Returns true if the context menu was invoked on an editable node where spell-check is enabled. More...
 
virtual EditStateFlags GetEditStateFlags ()=0
 Returns flags representing the actions supported by the editable node, if any, that the context menu was invoked on. More...
 
virtual bool IsCustomMenu ()=0
 Returns true if the context menu contains items specified by the renderer process. More...
 
- Public Member Functions inherited from CefBaseRefCounted
virtual void AddRef () const =0
 Called to increment the reference count for the object. More...
 
virtual bool Release () const =0
 Called to decrement the reference count for the object. More...
 
virtual bool HasOneRef () const =0
 Returns true if the reference count is 1. More...
 
virtual bool HasAtLeastOneRef () const =0
 Returns true if the reference count is at least 1. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CefBaseRefCounted
virtual ~CefBaseRefCounted ()
 

Detailed Description

Provides information about the context menu state.

The methods of this class can only be accessed on browser process the UI thread.

Member Typedef Documentation

◆ EditStateFlags

◆ MediaStateFlags

◆ MediaType

◆ TypeFlags

Member Function Documentation

◆ GetDictionarySuggestions()

virtual bool CefContextMenuParams::GetDictionarySuggestions ( std::vector< CefString > &  suggestions)
pure virtual

Returns true if suggestions exist, false otherwise.

Fills in |suggestions| from the spell check service for the misspelled word if there is one.

◆ GetEditStateFlags()

virtual EditStateFlags CefContextMenuParams::GetEditStateFlags ( )
pure virtual

Returns flags representing the actions supported by the editable node, if any, that the context menu was invoked on.

◆ GetFrameCharset()

virtual CefString CefContextMenuParams::GetFrameCharset ( )
pure virtual

Returns the character encoding of the subframe that the context menu was invoked on.

◆ GetFrameUrl()

virtual CefString CefContextMenuParams::GetFrameUrl ( )
pure virtual

Returns the URL of the subframe that the context menu was invoked on.

◆ GetLinkUrl()

virtual CefString CefContextMenuParams::GetLinkUrl ( )
pure virtual

Returns the URL of the link, if any, that encloses the node that the context menu was invoked on.

◆ GetMediaStateFlags()

virtual MediaStateFlags CefContextMenuParams::GetMediaStateFlags ( )
pure virtual

Returns flags representing the actions supported by the media element, if any, that the context menu was invoked on.

◆ GetMediaType()

virtual MediaType CefContextMenuParams::GetMediaType ( )
pure virtual

Returns the type of context node that the context menu was invoked on.

◆ GetMisspelledWord()

virtual CefString CefContextMenuParams::GetMisspelledWord ( )
pure virtual

Returns the text of the misspelled word, if any, that the context menu was invoked on.

◆ GetPageUrl()

virtual CefString CefContextMenuParams::GetPageUrl ( )
pure virtual

Returns the URL of the top level page that the context menu was invoked on.

◆ GetSelectionText()

virtual CefString CefContextMenuParams::GetSelectionText ( )
pure virtual

Returns the text of the selection, if any, that the context menu was invoked on.

◆ GetSourceUrl()

virtual CefString CefContextMenuParams::GetSourceUrl ( )
pure virtual

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.

◆ GetTitleText()

virtual CefString CefContextMenuParams::GetTitleText ( )
pure virtual

Returns the title text or the alt text if the context menu was invoked on an image.

◆ GetTypeFlags()

virtual TypeFlags CefContextMenuParams::GetTypeFlags ( )
pure virtual

Returns flags representing the type of node that the context menu was invoked on.

◆ GetUnfilteredLinkUrl()

virtual CefString CefContextMenuParams::GetUnfilteredLinkUrl ( )
pure virtual

Returns the link URL, if any, to be used ONLY for "copy link address".

We don't validate this field in the frontend process.

◆ GetXCoord()

virtual int CefContextMenuParams::GetXCoord ( )
pure virtual

Returns the X coordinate of the mouse where the context menu was invoked.

Coords are relative to the associated RenderView's origin.

◆ GetYCoord()

virtual int CefContextMenuParams::GetYCoord ( )
pure virtual

Returns the Y coordinate of the mouse where the context menu was invoked.

Coords are relative to the associated RenderView's origin.

◆ HasImageContents()

virtual bool CefContextMenuParams::HasImageContents ( )
pure virtual

Returns true if the context menu was invoked on an image which has non-empty contents.

◆ IsCustomMenu()

virtual bool CefContextMenuParams::IsCustomMenu ( )
pure virtual

Returns true if the context menu contains items specified by the renderer process.

◆ IsEditable()

virtual bool CefContextMenuParams::IsEditable ( )
pure virtual

Returns true if the context menu was invoked on an editable node.

◆ IsSpellCheckEnabled()

virtual bool CefContextMenuParams::IsSpellCheckEnabled ( )
pure virtual

Returns true if the context menu was invoked on an editable node where spell-check is enabled.


The documentation for this class was generated from the following file: