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 CefFrame

CefBaseRefCounted
   |
   +--CefFrame

   in cef_frame.h

class CefFrame
extends CefBaseRefCounted

Class used to represent a frame in the browser window. When used in the browser process the methods of this class may be called on any thread unless otherwise indicated in the comments. When used in the render process the methods of this class may only be called on the main thread.


Method Summary
 virtual void Copy()= 0
          Execute copy in this frame.
 virtual CefRefPtr< CefURLRequest > CreateURLRequest( CefRefPtr< CefRequest > request, CefRefPtr< CefURLRequestClient > client )= 0
          Create a new URL request that will be treated as originating from this frame and the associated browser.
 virtual void Cut()= 0
          Execute cut in this frame.
 virtual void Delete()= 0
          Execute delete in this frame.
 virtual void ExecuteJavaScript( const CefString& code, const CefString& script_url, int start_line )= 0
          Execute a string of JavaScript code in this frame.
 virtual CefRefPtr< CefBrowser > GetBrowser()= 0
          Returns the browser that this frame belongs to.
 virtual int64 GetIdentifier()= 0
          Returns the globally unique identifier for this frame or < 0 if the underlying frame does not yet exist.
 virtual CefString GetName()= 0
          Returns the name for this frame.
 virtual CefRefPtr< CefFrame > GetParent()= 0
          Returns the parent of this frame or NULL if this is the main (top-level) frame.
 virtual void GetSource( CefRefPtr< CefStringVisitor > visitor )= 0
          Retrieve this frame's HTML source as a string sent to the specified visitor.
 virtual void GetText( CefRefPtr< CefStringVisitor > visitor )= 0
          Retrieve this frame's display text as a string sent to the specified visitor.
 virtual CefString GetURL()= 0
          Returns the URL currently loaded in this frame.
 virtual CefRefPtr< CefV8Context > GetV8Context()= 0
          Get the V8 context associated with the frame.
 virtual bool IsFocused()= 0
          Returns true if this is the focused frame.
 virtual bool IsMain()= 0
          Returns true if this is the main (top-level) frame.
 virtual bool IsValid()= 0
          True if this object is currently attached to a valid frame.
 virtual void LoadRequest( CefRefPtr< CefRequest > request )= 0
          Load the request represented by the |request| object.
 virtual void LoadString( const CefString& string_val, const CefString& url )= 0
          Load the contents of |string_val| with the specified dummy |url|.
 virtual void LoadURL( const CefString& url )= 0
          Load the specified |url|.
 virtual void Paste()= 0
          Execute paste in this frame.
 virtual void Redo()= 0
          Execute redo in this frame.
 virtual void SelectAll()= 0
          Execute select all in this frame.
 virtual void SendProcessMessage( CefProcessId target_process, CefRefPtr< CefProcessMessage > message )= 0
          Send a message to the specified |target_process|.
 virtual void Undo()= 0
          Execute undo in this frame.
 virtual void ViewSource()= 0
          Save this frame's HTML source to a temporary file and open it in the default text viewing application.
 virtual void VisitDOM( CefRefPtr< CefDOMVisitor > visitor )= 0
          Visit the DOM document.
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef, HasAtLeastOneRef
 

Method Detail

Copy

public virtual void Copy()= 0;
Execute copy in this frame.

CreateURLRequest

public virtual CefRefPtr< CefURLRequest > CreateURLRequest( CefRefPtr< CefRequest > request, CefRefPtr< CefURLRequestClient > client )= 0;
Create a new URL request that will be treated as originating from this frame and the associated browser. This request may be intercepted by the client via CefResourceRequestHandler or CefSchemeHandlerFactory. Use CefURLRequest::Create instead if you do not want the request to have this association, in which case it may be handled differently (see documentation on that method). Requests may originate from both the browser process and the render process. For requests originating from the browser process: - POST data may only contain a single element of type PDE_TYPE_FILE or PDE_TYPE_BYTES. For requests originating from the render process: - POST data may only contain a single element of type PDE_TYPE_BYTES. - If the response contains Content-Disposition or Mime-Type header values that would not normally be rendered then the response may receive special handling inside the browser (for example, via the file download code path instead of the URL request code path). The |request| object will be marked as read-only after calling this method.

Cut

public virtual void Cut()= 0;
Execute cut in this frame.

Delete

public virtual void Delete()= 0;
Execute delete in this frame.

ExecuteJavaScript

public virtual void ExecuteJavaScript( const CefString& code, const CefString& script_url, int start_line )= 0;
Execute a string of JavaScript code in this frame. The |script_url| parameter is the URL where the script in question can be found, if any. The renderer may request this URL to show the developer the source of the error. The |start_line| parameter is the base line number to use for error reporting.

GetBrowser

public virtual CefRefPtr< CefBrowser > GetBrowser()= 0;
Returns the browser that this frame belongs to.

GetIdentifier

public virtual int64 GetIdentifier()= 0;
Returns the globally unique identifier for this frame or < 0 if the underlying frame does not yet exist.

GetName

public virtual CefString GetName()= 0;
Returns the name for this frame. If the frame has an assigned name (for example, set via the iframe "name" attribute) then that value will be returned. Otherwise a unique name will be constructed based on the frame parent hierarchy. The main (top-level) frame will always have an empty name value.

GetParent

public virtual CefRefPtr< CefFrame > GetParent()= 0;
Returns the parent of this frame or NULL if this is the main (top-level) frame.

GetSource

public virtual void GetSource( CefRefPtr< CefStringVisitor > visitor )= 0;
Retrieve this frame's HTML source as a string sent to the specified visitor.

GetText

public virtual void GetText( CefRefPtr< CefStringVisitor > visitor )= 0;
Retrieve this frame's display text as a string sent to the specified visitor.

GetURL

public virtual CefString GetURL()= 0;
Returns the URL currently loaded in this frame.

GetV8Context

public virtual CefRefPtr< CefV8Context > GetV8Context()= 0;
Get the V8 context associated with the frame. This method can only be called from the render process.

IsFocused

public virtual bool IsFocused()= 0;
Returns true if this is the focused frame.

IsMain

public virtual bool IsMain()= 0;
Returns true if this is the main (top-level) frame.

IsValid

public virtual bool IsValid()= 0;
True if this object is currently attached to a valid frame.

LoadRequest

public virtual void LoadRequest( CefRefPtr< CefRequest > request )= 0;
Load the request represented by the |request| object.

LoadString

public virtual void LoadString( const CefString& string_val, const CefString& url )= 0;
Load the contents of |string_val| with the specified dummy |url|. |url| should have a standard scheme (for example, http scheme) or behaviors like link clicks and web security restrictions may not behave as expected.

LoadURL

public virtual void LoadURL( const CefString& url )= 0;
Load the specified |url|.

Paste

public virtual void Paste()= 0;
Execute paste in this frame.

Redo

public virtual void Redo()= 0;
Execute redo in this frame.

SelectAll

public virtual void SelectAll()= 0;
Execute select all in this frame.

SendProcessMessage

public virtual void SendProcessMessage( CefProcessId target_process, CefRefPtr< CefProcessMessage > message )= 0;
Send a message to the specified |target_process|. Message delivery is not guaranteed in all cases (for example, if the browser is closing, navigating, or if the target process crashes). Send an ACK message back from the target process if confirmation is required.

Undo

public virtual void Undo()= 0;
Execute undo in this frame.

ViewSource

public virtual void ViewSource()= 0;
Save this frame's HTML source to a temporary file and open it in the default text viewing application. This method can only be called from the browser process.

VisitDOM

public virtual void VisitDOM( CefRefPtr< CefDOMVisitor > visitor )= 0;
Visit the DOM document. This method can only be called from the render process.

 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