Chromium Embedded Framework (CEF)  114.2.1+gd70a0a8+chromium-114.0.5735.45
CefDOMDocument Class Referenceabstract

Class used to represent a DOM document. More...

#include "include/cef_dom.h"

Inheritance diagram for CefDOMDocument:
CefBaseRefCounted

Public Types

typedef cef_dom_document_type_t Type
 

Public Member Functions

virtual Type GetType ()=0
 Returns the document type. More...
 
virtual CefRefPtr< CefDOMNodeGetDocument ()=0
 Returns the root document node. More...
 
virtual CefRefPtr< CefDOMNodeGetBody ()=0
 Returns the BODY node of an HTML document. More...
 
virtual CefRefPtr< CefDOMNodeGetHead ()=0
 Returns the HEAD node of an HTML document. More...
 
virtual CefString GetTitle ()=0
 Returns the title of an HTML document. More...
 
virtual CefRefPtr< CefDOMNodeGetElementById (const CefString &id)=0
 Returns the document element with the specified ID value. More...
 
virtual CefRefPtr< CefDOMNodeGetFocusedNode ()=0
 Returns the node that currently has keyboard focus. More...
 
virtual bool HasSelection ()=0
 Returns true if a portion of the document is selected. More...
 
virtual int GetSelectionStartOffset ()=0
 Returns the selection offset within the start node. More...
 
virtual int GetSelectionEndOffset ()=0
 Returns the selection offset within the end node. More...
 
virtual CefString GetSelectionAsMarkup ()=0
 Returns the contents of this selection as markup. More...
 
virtual CefString GetSelectionAsText ()=0
 Returns the contents of this selection as text. More...
 
virtual CefString GetBaseURL ()=0
 Returns the base URL for the document. More...
 
virtual CefString GetCompleteURL (const CefString &partialURL)=0
 Returns a complete URL based on the document base URL and the specified partial URL. 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

Class used to represent a DOM document.

The methods of this class should only be called on the render process main thread thread.

Member Typedef Documentation

◆ Type

Member Function Documentation

◆ GetBaseURL()

virtual CefString CefDOMDocument::GetBaseURL ( )
pure virtual

Returns the base URL for the document.

◆ GetBody()

virtual CefRefPtr<CefDOMNode> CefDOMDocument::GetBody ( )
pure virtual

Returns the BODY node of an HTML document.

◆ GetCompleteURL()

virtual CefString CefDOMDocument::GetCompleteURL ( const CefString partialURL)
pure virtual

Returns a complete URL based on the document base URL and the specified partial URL.

◆ GetDocument()

virtual CefRefPtr<CefDOMNode> CefDOMDocument::GetDocument ( )
pure virtual

Returns the root document node.

◆ GetElementById()

virtual CefRefPtr<CefDOMNode> CefDOMDocument::GetElementById ( const CefString id)
pure virtual

Returns the document element with the specified ID value.

◆ GetFocusedNode()

virtual CefRefPtr<CefDOMNode> CefDOMDocument::GetFocusedNode ( )
pure virtual

Returns the node that currently has keyboard focus.

◆ GetHead()

virtual CefRefPtr<CefDOMNode> CefDOMDocument::GetHead ( )
pure virtual

Returns the HEAD node of an HTML document.

◆ GetSelectionAsMarkup()

virtual CefString CefDOMDocument::GetSelectionAsMarkup ( )
pure virtual

Returns the contents of this selection as markup.

◆ GetSelectionAsText()

virtual CefString CefDOMDocument::GetSelectionAsText ( )
pure virtual

Returns the contents of this selection as text.

◆ GetSelectionEndOffset()

virtual int CefDOMDocument::GetSelectionEndOffset ( )
pure virtual

Returns the selection offset within the end node.

◆ GetSelectionStartOffset()

virtual int CefDOMDocument::GetSelectionStartOffset ( )
pure virtual

Returns the selection offset within the start node.

◆ GetTitle()

virtual CefString CefDOMDocument::GetTitle ( )
pure virtual

Returns the title of an HTML document.

◆ GetType()

virtual Type CefDOMDocument::GetType ( )
pure virtual

Returns the document type.

◆ HasSelection()

virtual bool CefDOMDocument::HasSelection ( )
pure virtual

Returns true if a portion of the document is selected.


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