Class TCEFBrowserViewComponent

Description

Hierarchy

Fields

Methods

Properties

Unit

uCEFBrowserViewComponent

Declaration

type TCEFBrowserViewComponent = class(TCEFViewComponent, ICefBrowserViewDelegateEvents)

Description

Component hosting a ICefBrowserView instance.

Hierarchy

TObject
TPersistent
TComponent
TCEFViewComponent
TCEFBrowserViewComponent

Overview

Fields

	`FBrowserView: ICefBrowserView;`
	`FBrowserViewDlg: ICefBrowserViewDelegate;`
	`FOnBrowserCreated: TOnBrowserCreatedEvent;`
	`FOnBrowserDestroyed: TOnBrowserDestroyedEvent;`
	`FOnGetDelegateForPopupBrowserView: TOnGetDelegateForPopupBrowserViewEvent;`
	`FOnPopupBrowserViewCreated: TOnPopupBrowserViewCreatedEvent;`
	`FOnGetChromeToolbarType: TOnGetChromeToolbarTypeEvent;`
	`FOnUseFramelessWindowForPictureInPicture: TOnUseFramelessWindowForPictureInPicture;`
	`FOnGestureCommand: TOnGestureCommandEvent;`
	`FOnGetBrowserRuntimeStyle: TOnGetBrowserRuntimeStyleEvent;`

Methods

	`procedure DestroyView; override;`
	`procedure Initialize; override;`
	`function GetInitialized: boolean; override;`
	`function GetAsView: ICefView; override;`
	`function GetAsBrowserView: ICefBrowserView; override;`
	`function GetBrowser: ICefBrowser;`
	`function GetChromeToolbar: ICefView;`
	`function GetRuntimeStyle: TCefRuntimeStyle;`
	`procedure doOnBrowserCreated(const browser_view: ICefBrowserView; const browser: ICefBrowser);`
	`procedure doOnBrowserDestroyed(const browser_view: ICefBrowserView; const browser: ICefBrowser);`
	`procedure doOnGetDelegateForPopupBrowserView(const browser_view: ICefBrowserView; const settings: TCefBrowserSettings; const client: ICefClient; is_devtools: boolean; var aResult : ICefBrowserViewDelegate);`
	`procedure doOnPopupBrowserViewCreated(const browser_view, popup_browser_view: ICefBrowserView; is_devtools: boolean; var aResult : boolean);`
	`procedure doOnGetChromeToolbarType(const browser_view: ICefBrowserView; var aChromeToolbarType: TCefChromeToolbarType);`
	`procedure doOnUseFramelessWindowForPictureInPicture(const browser_view: ICefBrowserView; var aResult: boolean);`
	`procedure doOnGestureCommand(const browser_view: ICefBrowserView; gesture_command: TCefGestureCommand; var aResult : boolean);`
	`procedure doOnGetBrowserRuntimeStyle(var aResult : TCefRuntimeStyle);`
	`function CreateBrowserView(const client: ICefClient; const url: ustring; const settings: TCefBrowserSettings; const extra_info: ICefDictionaryValue; const request_context: ICefRequestContext): boolean;`
	`function GetForBrowser(const browser: ICefBrowser): boolean;`
	`procedure SetPreferAccelerators(prefer_accelerators: boolean);`

Properties

	`property Browser : ICefBrowser read GetBrowser;`
	`property BrowserView : ICefBrowserView read FBrowserView;`
	`property ChromeToolbar : ICefView read GetChromeToolbar;`
	`property RuntimeStyle : TCefRuntimeStyle read GetRuntimeStyle;`
	`property OnBrowserCreated : TOnBrowserCreatedEvent read FOnBrowserCreated write FOnBrowserCreated;`
	`property OnBrowserDestroyed : TOnBrowserDestroyedEvent read FOnBrowserDestroyed write FOnBrowserDestroyed;`
	`property OnGetDelegateForPopupBrowserView : TOnGetDelegateForPopupBrowserViewEvent read FOnGetDelegateForPopupBrowserView write FOnGetDelegateForPopupBrowserView;`
	`property OnPopupBrowserViewCreated : TOnPopupBrowserViewCreatedEvent read FOnPopupBrowserViewCreated write FOnPopupBrowserViewCreated;`
	`property OnGetChromeToolbarType : TOnGetChromeToolbarTypeEvent read FOnGetChromeToolbarType write FOnGetChromeToolbarType;`
	`property OnUseFramelessWindowForPictureInPicture : TOnUseFramelessWindowForPictureInPicture read FOnUseFramelessWindowForPictureInPicture write FOnUseFramelessWindowForPictureInPicture;`
	`property OnGestureCommand : TOnGestureCommandEvent read FOnGestureCommand write FOnGestureCommand;`
	`property OnGetBrowserRuntimeStyle : TOnGetBrowserRuntimeStyleEvent read FOnGetBrowserRuntimeStyle write FOnGetBrowserRuntimeStyle;`

Description

Fields

	`FBrowserView: ICefBrowserView;`
This item has no description.

	`FBrowserViewDlg: ICefBrowserViewDelegate;`
This item has no description.

	`FOnBrowserCreated: TOnBrowserCreatedEvent;`
ICefBrowserViewDelegateEvents

	`FOnBrowserDestroyed: TOnBrowserDestroyedEvent;`
This item has no description.

	`FOnGetDelegateForPopupBrowserView: TOnGetDelegateForPopupBrowserViewEvent;`
This item has no description.

	`FOnPopupBrowserViewCreated: TOnPopupBrowserViewCreatedEvent;`
This item has no description.

	`FOnGetChromeToolbarType: TOnGetChromeToolbarTypeEvent;`
This item has no description.

	`FOnUseFramelessWindowForPictureInPicture: TOnUseFramelessWindowForPictureInPicture;`
This item has no description.

	`FOnGestureCommand: TOnGestureCommandEvent;`
This item has no description.

	`FOnGetBrowserRuntimeStyle: TOnGetBrowserRuntimeStyleEvent;`
This item has no description.

Methods

	`procedure DestroyView; override;`
This item has no description.

	`procedure Initialize; override;`
This item has no description.

	`function GetInitialized: boolean; override;`
This item has no description.

	`function GetAsView: ICefView; override;`
This item has no description.

	`function GetAsBrowserView: ICefBrowserView; override;`
This item has no description.

	`function GetBrowser: ICefBrowser;`
This item has no description.

	`function GetChromeToolbar: ICefView;`
This item has no description.

	`function GetRuntimeStyle: TCefRuntimeStyle;`
This item has no description.

	`procedure doOnBrowserCreated(const browser_view: ICefBrowserView; const browser: ICefBrowser);`
ICefBrowserViewDelegateEvents

	`procedure doOnBrowserDestroyed(const browser_view: ICefBrowserView; const browser: ICefBrowser);`
This item has no description.

	`procedure doOnGetDelegateForPopupBrowserView(const browser_view: ICefBrowserView; const settings: TCefBrowserSettings; const client: ICefClient; is_devtools: boolean; var aResult : ICefBrowserViewDelegate);`
This item has no description.

	`procedure doOnPopupBrowserViewCreated(const browser_view, popup_browser_view: ICefBrowserView; is_devtools: boolean; var aResult : boolean);`
This item has no description.

	`procedure doOnGetChromeToolbarType(const browser_view: ICefBrowserView; var aChromeToolbarType: TCefChromeToolbarType);`
This item has no description.

	`procedure doOnUseFramelessWindowForPictureInPicture(const browser_view: ICefBrowserView; var aResult: boolean);`
This item has no description.

	`procedure doOnGestureCommand(const browser_view: ICefBrowserView; gesture_command: TCefGestureCommand; var aResult : boolean);`
This item has no description.

	`procedure doOnGetBrowserRuntimeStyle(var aResult : TCefRuntimeStyle);`
This item has no description.

	`function CreateBrowserView(const client: ICefClient; const url: ustring; const settings: TCefBrowserSettings; const extra_info: ICefDictionaryValue; const request_context: ICefRequestContext): boolean;`
Create a new ICefBrowserView. The underlying ICefBrowser will not be created until this view is added to the views hierarchy. The optional \|extra_info\| parameter provides an opportunity to specify extra information specific to the created browser that will be passed to ICefRenderProcessHandler.OnBrowserCreated in the render process.

	`function GetForBrowser(const browser: ICefBrowser): boolean;`
Updates the internal ICefBrowserView with the ICefBrowserView associated with \|browser\|.

procedure SetPreferAccelerators(prefer_accelerators: boolean);

Sets whether normal priority accelerators are first forwarded to the web content (`keydown` event handler) or ICefKeyboardHandler. Normal priority accelerators can be registered via ICefWindow.SetAccelerator (with |high_priority|=false) or internally for standard accelerators supported by Chrome style. If |prefer_accelerators| is true then the matching accelerator will be triggered immediately (calling ICefWindowDelegate.OnAccelerator or ICefCommandHandler.OnChromeCommand respectively) and the event will not be forwarded to the web content or ICefKeyboardHandler first. If |prefer_accelerators| is false then the matching accelerator will only be triggered if the event is not handled by web content (`keydown` event handler that calls `event.preventDefault()`) or by ICefKeyboardHandler. The default value is false.

Properties

	`property Browser : ICefBrowser read GetBrowser;`
Returns the ICefBrowser hosted by this BrowserView. Will return NULL if the browser has not yet been created or has already been destroyed.

	`property BrowserView : ICefBrowserView read FBrowserView;`
ICefBrowserView assiciated to this component.

	`property ChromeToolbar : ICefView read GetChromeToolbar;`
Returns the Chrome toolbar associated with this BrowserView. Only supported when using Chrome style. The ICefBrowserViewDelegate.GetChromeToolbarType function must return a value other than CEF_CTT_NONE and the toolbar will not be available until after this BrowserView is added to a ICefWindow and ICefViewDelegate.OnWindowChanged() has been called.

	`property RuntimeStyle : TCefRuntimeStyle read GetRuntimeStyle;`
Returns the runtime style for this BrowserView (ALLOY or CHROME). See TCefRuntimeStyle documentation for details.

	`property OnBrowserCreated : TOnBrowserCreatedEvent read FOnBrowserCreated write FOnBrowserCreated;`
Called when \|browser\| associated with \|browser_view\| is created. This function will be called after ICefLifeSpanHandler.OnAfterCreated() is called for \|browser\| and before OnPopupBrowserViewCreated() is called for \|browser\|'s parent delegate if \|browser\| is a popup.

	`property OnBrowserDestroyed : TOnBrowserDestroyedEvent read FOnBrowserDestroyed write FOnBrowserDestroyed;`
Called when \|browser\| associated with \|browser_view\| is destroyed. Release all references to \|browser\| and do not attempt to execute any functions on \|browser\| after this callback returns. This function will be called before ICefLifeSpanHandler.OnBeforeClose() is called for \|browser\|.

	`property OnGetDelegateForPopupBrowserView : TOnGetDelegateForPopupBrowserViewEvent read FOnGetDelegateForPopupBrowserView write FOnGetDelegateForPopupBrowserView;`
Called before a new popup BrowserView is created. The popup originated from \|browser_view\|. \|settings\| and \|client\| are the values returned from ICefLifeSpanHandler.OnBeforePopup(). \|is_devtools\| will be true (1) if the popup will be a DevTools browser. Return the delegate that will be used for the new popup BrowserView.

property OnPopupBrowserViewCreated : TOnPopupBrowserViewCreatedEvent read FOnPopupBrowserViewCreated write FOnPopupBrowserViewCreated;

Called after |popup_browser_view| is created. This function will be called after ICefLifeSpanHandler.OnAfterCreated() and OnBrowserCreated() are called for the new popup browser. The popup originated from |browser_view|. |is_devtools| will be true (1) if the popup is a DevTools browser. Optionally add |popup_browser_view| to the views hierarchy yourself and return true (1). Otherwise return false (0) and a default ICefWindow will be created for the popup.

	`property OnGetChromeToolbarType : TOnGetChromeToolbarTypeEvent read FOnGetChromeToolbarType write FOnGetChromeToolbarType;`
Returns the Chrome toolbar type that will be available via ICefBrowserView.GetChromeToolbar(). See that function for related documentation.

	`property OnUseFramelessWindowForPictureInPicture : TOnUseFramelessWindowForPictureInPicture read FOnUseFramelessWindowForPictureInPicture write FOnUseFramelessWindowForPictureInPicture;`
Return true (1) to create frameless windows for Document picture-in- picture popups. Content in frameless windows should specify draggable regions using "-webkit-app-region: drag" CSS.

	`property OnGestureCommand : TOnGestureCommandEvent read FOnGestureCommand write FOnGestureCommand;`
Called when \|browser_view\| receives a gesture command. Return true (1) to handle (or disable) a \|gesture_command\| or false (0) to propagate the gesture to the browser for default handling. With Chrome style these commands can also be handled via ICefCommandHandler.OnChromeCommand.

	`property OnGetBrowserRuntimeStyle : TOnGetBrowserRuntimeStyleEvent read FOnGetBrowserRuntimeStyle write FOnGetBrowserRuntimeStyle;`
Optionally change the runtime style for this BrowserView. See TCefRuntimeStyle documentation for details.

Generated by PasDoc 0.16.0-snapshot.