Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

(default)
Class CefContextMenuParams

CefBaseRefCounted
   |
   +--CefContextMenuParams

   in cef_context_menu_handler.h

class CefContextMenuParams
extends CefBaseRefCounted

Provides information about the context menu state. The ethods of this class can only be accessed on browser process the UI thread.


Inner Classes, Typedefs, and Enums
typedef CefContextMenuParams::EditStateFlags
          
typedef CefContextMenuParams::MediaStateFlags
          
typedef CefContextMenuParams::MediaType
          
typedef CefContextMenuParams::TypeFlags
          
 
Method Summary
 virtual bool GetDictionarySuggestions( std::vector< CefString >& suggestions )= 0
          Returns true if suggestions exist, false otherwise.
 virtual CefContextMenuParams::EditStateFlags GetEditStateFlags()= 0
          Returns flags representing the actions supported by the editable node, if any, that the context menu was invoked on.
 virtual CefString GetFrameCharset()= 0
          Returns the character encoding of the subframe that the context menu was invoked on.
 virtual CefString GetFrameUrl()= 0
          Returns the URL of the subframe that the context menu was invoked on.
 virtual CefString GetLinkUrl()= 0
          Returns the URL of the link, if any, that encloses the node that the context menu was invoked on.
 virtual CefContextMenuParams::MediaStateFlags GetMediaStateFlags()= 0
          Returns flags representing the actions supported by the media element, if any, that the context menu was invoked on.
 virtual CefContextMenuParams::MediaType GetMediaType()= 0
          Returns the type of context node that the context menu was invoked on.
 virtual CefString GetMisspelledWord()= 0
          Returns the text of the misspelled word, if any, that the context menu was invoked on.
 virtual CefString GetPageUrl()= 0
          Returns the URL of the top level page that the context menu was invoked on.
 virtual CefString GetSelectionText()= 0
          Returns the text of the selection, if any, that the context menu was invoked on.
 virtual CefString GetSourceUrl()= 0
          Returns the source URL, if any, for the element that the context menu was invoked on.
 virtual CefString GetTitleText()= 0
          Returns the title text or the alt text if the context menu was invoked on an image.
 virtual CefContextMenuParams::TypeFlags GetTypeFlags()= 0
          Returns flags representing the type of node that the context menu was invoked on.
 virtual CefString GetUnfilteredLinkUrl()= 0
          Returns the link URL, if any, to be used ONLY for "copy link address".
 virtual int GetXCoord()= 0
          Returns the X coordinate of the mouse where the context menu was invoked.
 virtual int GetYCoord()= 0
          Returns the Y coordinate of the mouse where the context menu was invoked.
 virtual bool HasImageContents()= 0
          Returns true if the context menu was invoked on an image which has non-empty contents.
 virtual bool IsCustomMenu()= 0
          Returns true if the context menu contains items specified by the renderer process (for example, plugin placeholder or pepper plugin menu items).
 virtual bool IsEditable()= 0
          Returns true if the context menu was invoked on an editable node.
 virtual bool IsPepperMenu()= 0
          Returns true if the context menu was invoked from a pepper plugin.
 virtual bool IsSpellCheckEnabled()= 0
          Returns true if the context menu was invoked on an editable node where spell-check is enabled.
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef, HasAtLeastOneRef
 

Method Detail

GetDictionarySuggestions

public virtual bool GetDictionarySuggestions( std::vector< CefString >& suggestions )= 0;
Returns true if suggestions exist, false otherwise. Fills in |suggestions| from the spell check service for the misspelled word if there is one.

GetEditStateFlags

public virtual CefContextMenuParams::EditStateFlags GetEditStateFlags()= 0;
Returns flags representing the actions supported by the editable node, if any, that the context menu was invoked on.

GetFrameCharset

public virtual CefString GetFrameCharset()= 0;
Returns the character encoding of the subframe that the context menu was invoked on.

GetFrameUrl

public virtual CefString GetFrameUrl()= 0;
Returns the URL of the subframe that the context menu was invoked on.

GetLinkUrl

public virtual CefString GetLinkUrl()= 0;
Returns the URL of the link, if any, that encloses the node that the context menu was invoked on.

GetMediaStateFlags

public virtual CefContextMenuParams::MediaStateFlags GetMediaStateFlags()= 0;
Returns flags representing the actions supported by the media element, if any, that the context menu was invoked on.

GetMediaType

public virtual CefContextMenuParams::MediaType GetMediaType()= 0;
Returns the type of context node that the context menu was invoked on.

GetMisspelledWord

public virtual CefString GetMisspelledWord()= 0;
Returns the text of the misspelled word, if any, that the context menu was invoked on.

GetPageUrl

public virtual CefString GetPageUrl()= 0;
Returns the URL of the top level page that the context menu was invoked on.

GetSelectionText

public virtual CefString GetSelectionText()= 0;
Returns the text of the selection, if any, that the context menu was invoked on.

GetSourceUrl

public virtual CefString GetSourceUrl()= 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.

GetTitleText

public virtual CefString GetTitleText()= 0;
Returns the title text or the alt text if the context menu was invoked on an image.

GetTypeFlags

public virtual CefContextMenuParams::TypeFlags GetTypeFlags()= 0;
Returns flags representing the type of node that the context menu was invoked on.

GetUnfilteredLinkUrl

public virtual CefString GetUnfilteredLinkUrl()= 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.

GetXCoord

public virtual int GetXCoord()= 0;
Returns the X coordinate of the mouse where the context menu was invoked. Coords are relative to the associated RenderView's origin.

GetYCoord

public virtual int GetYCoord()= 0;
Returns the Y coordinate of the mouse where the context menu was invoked. Coords are relative to the associated RenderView's origin.

HasImageContents

public virtual bool HasImageContents()= 0;
Returns true if the context menu was invoked on an image which has non-empty contents.

IsCustomMenu

public virtual bool IsCustomMenu()= 0;
Returns true if the context menu contains items specified by the renderer process (for example, plugin placeholder or pepper plugin menu items).

IsEditable

public virtual bool IsEditable()= 0;
Returns true if the context menu was invoked on an editable node.

IsPepperMenu

public virtual bool IsPepperMenu()= 0;
Returns true if the context menu was invoked from a pepper plugin.

IsSpellCheckEnabled

public virtual bool IsSpellCheckEnabled()= 0;
Returns true if the context menu was invoked on an editable node where spell-check is enabled.

 Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

Chromium Embedded Framework (CEF) Copyright © 2016 Marshall A. Greenblatt