Overview   Project   Class   Tree   Index 
CEF C++ API Docs - Revision 1123
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

(default)
Class CefFrame

CefBase
   |
   +--CefFrame

   in cef_frame.h

class CefFrame
extends CefBase

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


Method Summary
 virtual void Copy()= 0
          Execute copy in this frame.
 virtual void Cut()= 0
          Execute cut in this frame.
 virtual void Delete()= 0
          Execute delete in this frame.
 virtual void ExecuteJavaScript( const CefString& jsCode, const CefString& scriptUrl, int startLine )= 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.
 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 CefString GetSource()= 0
          Returns this frame's HTML source as a string.
 virtual CefString GetText()= 0
          Returns this frame's display text as a string.
 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 void LoadRequest( CefRefPtr< CefRequest > request )= 0
          Load the request represented by the |request| object.
 virtual void LoadStream( CefRefPtr< CefStreamReader > stream, const CefString& url )= 0
          Load the contents of |stream| with the optional dummy target |url|.
 virtual void LoadString( const CefString& string_val, const CefString& url )= 0
          Load the contents of |string_val| with the optional dummy target |url|.
 virtual void LoadURL( const CefString& url )= 0
          Load the specified |url|.
 virtual void Paste()= 0
          Execute paste in this frame.
 virtual void Print()= 0
          Execute printing in the this frame.
 virtual void Redo()= 0
          Execute redo in this frame.
 virtual void SelectAll()= 0
          Execute select all in this frame.
 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 CefBase
AddRef, Release, GetRefCt
 

Method Detail

Copy

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

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& jsCode, const CefString& scriptUrl, int startLine )= 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.

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. This method should only be called on the UI thread.

GetSource

public virtual CefString GetSource()= 0;
Returns this frame's HTML source as a string. This method should only be called on the UI thread.

GetText

public virtual CefString GetText()= 0;
Returns this frame's display text as a string. This method should only be called on the UI thread.

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 should only be called on the UI thread.

IsFocused

public virtual bool IsFocused()= 0;
Returns true if this is the focused frame. This method should only be called on the UI thread.

IsMain

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

LoadRequest

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

LoadStream

public virtual void LoadStream( CefRefPtr< CefStreamReader > stream, const CefString& url )= 0;
Load the contents of |stream| with the optional dummy target |url|.

LoadString

public virtual void LoadString( const CefString& string_val, const CefString& url )= 0;
Load the contents of |string_val| with the optional dummy target |url|.

LoadURL

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

Paste

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

Print

public virtual void Print()= 0;
Execute printing in the this frame. The user will be prompted with the print dialog appropriate to the operating system.

Redo

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

SelectAll

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

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.

VisitDOM

public virtual void VisitDOM( CefRefPtr< CefDOMVisitor > visitor )= 0;
Visit the DOM document.

 Overview   Project   Class   Tree   Index 
CEF C++ API Docs - Revision 1123
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

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