Interface ICefBrowser

Description
Hierarchy
Fields
Methods
Properties

Unit

uCEFInterfaces

Declaration

type ICefBrowser = interface(ICefBaseRefCounted)

Description

Interface used to represent a browser. When used in the browser process the functions of this interface may be called on any thread unless otherwise indicated in the comments. When used in the render process the functions of this interface may only be called on the main thread.

UNKNOWN

<see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_browser_capi.h">CEF source file: /include/capi/cef_browser_capi.h (cef_browser_t))

Hierarchy

Overview

Methods

Public function IsValid: boolean;
Public function GetHost: ICefBrowserHost;
Public function CanGoBack: Boolean;
Public procedure GoBack;
Public function CanGoForward: Boolean;
Public procedure GoForward;
Public function IsLoading: Boolean;
Public procedure Reload;
Public procedure ReloadIgnoreCache;
Public procedure StopLoad;
Public function GetIdentifier: Integer;
Public function IsSame(const that: ICefBrowser): Boolean;
Public function IsPopup: Boolean;
Public function HasDocument: Boolean;
Public function GetMainFrame: ICefFrame;
Public function GetFocusedFrame: ICefFrame;
Public function GetFrameByIdentifier(const identifier: ustring): ICefFrame;
Public function GetFrameByName(const name: ustring): ICefFrame;
Public function GetFrameCount: NativeUInt;
Public function GetFrameIdentifiers(var aFrameIdentifiers : TStrings) : boolean;
Public function GetFrameNames(var aFrameNames : TStrings) : boolean;

Properties

Public property MainFrame : ICefFrame read GetMainFrame;
Public property FocusedFrame : ICefFrame read GetFocusedFrame;
Public property FrameCount : NativeUInt read GetFrameCount;
Public property Host : ICefBrowserHost read GetHost;
Public property Identifier : Integer read GetIdentifier;

Description

Methods

Public function IsValid: boolean;

True if this object is currently valid. This will return false (0) after ICefLifeSpanHandler.OnBeforeClose is called.

Attributes
GUID['{BA003C2E-CF15-458F-9D4A-FE3CEFCF3EEF}']
Public function GetHost: ICefBrowserHost;

Returns the browser host object. This function can only be called in the browser process.

Public function CanGoBack: Boolean;

Returns true (1) if the browser can navigate backwards.

Public procedure GoBack;

Navigate backwards.

Public function CanGoForward: Boolean;

Returns true (1) if the browser can navigate forwards.

Public procedure GoForward;

Navigate forwards.

Public function IsLoading: Boolean;

Returns true (1) if the browser is currently loading.

Public procedure Reload;

Reload the current page.

Public procedure ReloadIgnoreCache;

Reload the current page ignoring any cached data.

Public procedure StopLoad;

Stop loading the page.

Public function GetIdentifier: Integer;

Returns the globally unique identifier for this browser. This value is also used as the tabId for extension APIs.

Public function IsSame(const that: ICefBrowser): Boolean;

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

Public function IsPopup: Boolean;

Returns true (1) if the browser is a popup.

Public function HasDocument: Boolean;

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

Public function GetMainFrame: ICefFrame;

Returns the main (top-level) frame for the browser. In the browser process this will return a valid object until after ICefLifeSpanHandler.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).

Public function GetFocusedFrame: ICefFrame;

Returns the focused frame for the browser.

Public function GetFrameByIdentifier(const identifier: ustring): ICefFrame;

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

Public function GetFrameByName(const name: ustring): ICefFrame;

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

Public function GetFrameCount: NativeUInt;

Returns the number of frames that currently exist.

Public function GetFrameIdentifiers(var aFrameIdentifiers : TStrings) : boolean;

Returns the identifiers of all existing frames.

Public function GetFrameNames(var aFrameNames : TStrings) : boolean;

Returns the names of all existing frames.

Properties

Public property MainFrame : ICefFrame read GetMainFrame;

Returns the main (top-level) frame for the browser. In the browser process this will return a valid object until after ICefLifeSpanHandler.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).

Public property FocusedFrame : ICefFrame read GetFocusedFrame;

Returns the focused frame for the browser.

Public property FrameCount : NativeUInt read GetFrameCount;

Returns the number of frames that currently exist.

Public property Host : ICefBrowserHost read GetHost;

Returns the browser host object. This function can only be called in the browser process.

Public property Identifier : Integer read GetIdentifier;

Returns the globally unique identifier for this browser. This value is also used as the tabId for extension APIs.

Generated by PasDoc 0.16.0-snapshot.