CefBrowser Class Reference

Class used to represent a browser. More...

#include "include/cef_browser.h"

Inheritance diagram for CefBrowser:

Public Member Functions
virtual bool	IsValid ()=0
	True if this object is currently valid.
virtual CefRefPtr< CefBrowserHost >	GetHost ()=0
	Returns the browser host object.
virtual bool	CanGoBack ()=0
	Returns true if the browser can navigate backwards.
virtual void	GoBack ()=0
	Navigate backwards.
virtual bool	CanGoForward ()=0
	Returns true if the browser can navigate forwards.
virtual void	GoForward ()=0
	Navigate forwards.
virtual bool	IsLoading ()=0
	Returns true if the browser is currently loading.
virtual void	Reload ()=0
	Reload the current page.
virtual void	ReloadIgnoreCache ()=0
	Reload the current page ignoring any cached data.
virtual void	StopLoad ()=0
	Stop loading the page.
virtual int	GetIdentifier ()=0
	Returns the globally unique identifier for this browser.
virtual bool	IsSame (CefRefPtr< CefBrowser > that)=0
	Returns true if this object is pointing to the same handle as |that| object.
virtual bool	IsPopup ()=0
	Returns true if the browser is a popup.
virtual bool	HasDocument ()=0
	Returns true if a document has been loaded in the browser.
virtual CefRefPtr< CefFrame >	GetMainFrame ()=0
	Returns the main (top-level) frame for the browser.
virtual CefRefPtr< CefFrame >	GetFocusedFrame ()=0
	Returns the focused frame for the browser.
virtual CefRefPtr< CefFrame >	GetFrameByIdentifier (const CefString &identifier)=0
	Returns the frame with the specified identifier, or NULL if not found.
virtual CefRefPtr< CefFrame >	GetFrameByName (const CefString &name)=0
	Returns the frame with the specified name, or NULL if not found.
virtual size_t	GetFrameCount ()=0
	Returns the number of frames that currently exist.
virtual void	GetFrameIdentifiers (std::vector< CefString > &identifiers)=0
	Returns the identifiers of all existing frames.
virtual void	GetFrameNames (std::vector< CefString > &names)=0
	Returns the names of all existing frames.
Public Member Functions inherited from CefBaseRefCounted
virtual void	AddRef () const =0
	Called to increment the reference count for the object.
virtual bool	Release () const =0
	Called to decrement the reference count for the object.
virtual bool	HasOneRef () const =0
	Returns true if the reference count is 1.
virtual bool	HasAtLeastOneRef () const =0
	Returns true if the reference count is at least 1.

Additional Inherited Members
Protected Member Functions inherited from CefBaseRefCounted
virtual	~CefBaseRefCounted ()

Detailed Description

Class used to represent a browser.

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.

Member Function Documentation

CanGoBack()

virtual bool CefBrowser::CanGoBack ( )

pure virtual

Returns true if the browser can navigate backwards.

CanGoForward()

virtual bool CefBrowser::CanGoForward ( )

pure virtual

Returns true if the browser can navigate forwards.

GetFocusedFrame()

virtual CefRefPtr< CefFrame > CefBrowser::GetFocusedFrame ( )

pure virtual

Returns the focused frame for the browser.

GetFrameByIdentifier()

virtual CefRefPtr< CefFrame > CefBrowser::GetFrameByIdentifier ( const CefString &  identifier )

pure virtual

Returns the frame with the specified identifier, or NULL if not found.

GetFrameByName()

virtual CefRefPtr< CefFrame > CefBrowser::GetFrameByName ( const CefString &  name )

pure virtual

Returns the frame with the specified name, or NULL if not found.

GetFrameCount()

virtual size_t CefBrowser::GetFrameCount ( )

pure virtual

Returns the number of frames that currently exist.

GetFrameIdentifiers()

virtual void CefBrowser::GetFrameIdentifiers ( std::vector< CefString > &  identifiers )

pure virtual

Returns the identifiers of all existing frames.

GetFrameNames()

virtual void CefBrowser::GetFrameNames ( std::vector< CefString > &  names )

pure virtual

Returns the names of all existing frames.

GetHost()

virtual CefRefPtr< CefBrowserHost > CefBrowser::GetHost ( )

pure virtual

Returns the browser host object.

This method can only be called in the browser process.

GetIdentifier()

virtual int CefBrowser::GetIdentifier ( )

pure virtual

Returns the globally unique identifier for this browser.

This value is also used as the tabId for extension APIs.

GetMainFrame()

virtual CefRefPtr< CefFrame > CefBrowser::GetMainFrame ( )

pure virtual

Returns the main (top-level) frame for the browser.

In the browser process this will return a valid object until after CefLifeSpanHandler::OnBeforeClose is called. In the renderer process this will return NULL if the main frame is hosted in a different renderer process (e.g. for cross-origin sub-frames). The main frame object will change during cross-origin navigation or re-navigation after renderer process termination (due to crashes, etc).

GoBack()

virtual void CefBrowser::GoBack ( )

pure virtual

Navigate backwards.

GoForward()

virtual void CefBrowser::GoForward ( )

pure virtual

Navigate forwards.

HasDocument()

virtual bool CefBrowser::HasDocument ( )

pure virtual

Returns true if a document has been loaded in the browser.

IsLoading()

virtual bool CefBrowser::IsLoading ( )

pure virtual

Returns true if the browser is currently loading.

IsPopup()

virtual bool CefBrowser::IsPopup ( )

pure virtual

Returns true if the browser is a popup.

IsSame()

virtual bool CefBrowser::IsSame ( CefRefPtr< CefBrowser >  that )

pure virtual

Returns true if this object is pointing to the same handle as |that| object.

IsValid()

virtual bool CefBrowser::IsValid ( )

pure virtual

True if this object is currently valid.

This will return false after CefLifeSpanHandler::OnBeforeClose is called.

Reload()

virtual void CefBrowser::Reload ( )

pure virtual

Reload the current page.

ReloadIgnoreCache()

virtual void CefBrowser::ReloadIgnoreCache ( )

pure virtual

Reload the current page ignoring any cached data.

StopLoad()

virtual void CefBrowser::StopLoad ( )

pure virtual

Stop loading the page.

---

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

• include/cef_browser.h