# Interface ICefBrowserHost

Description
Hierarchy
Fields
Methods
Properties

## Unit

uCEFInterfaces

## Declaration

`type ICefBrowserHost = interface(ICefBaseRefCounted)`

## Description

Interface used to represent the browser process aspects of a browser. The functions of this interface can only be called in the browser process. They may be called on any thread in that process unless otherwise indicated in the comments.

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_host_t))

## Hierarchy

- IInterface
- ICefBaseRefCounted
- ICefBrowserHost

## Overview

### Methods

| `function GetBrowser: ICefBrowser;`
| `procedure CloseBrowser(forceClose: Boolean);`
| `function TryCloseBrowser: Boolean;`
| `function IsReadyToBeClosed: Boolean;`
| `procedure SetFocus(focus: Boolean);`
| `function GetWindowHandle: TCefWindowHandle;`
| `function GetOpenerWindowHandle: TCefWindowHandle;`
| `function GetOpenerIdentifier: Integer;`
| `function HasView: Boolean;`
| `function GetClient: ICefClient;`
| `function GetRequestContext: ICefRequestContext;`
| `function CanZoom(command: TCefZoomCommand): boolean;`
| `procedure Zoom(command: TCefZoomCommand);`
| `function GetDefaultZoomLevel: Double;`
| `function GetZoomLevel: Double;`
| `procedure SetZoomLevel(const zoomLevel: Double);`
| `procedure RunFileDialog(mode: TCefFileDialogMode; const title, defaultFilePath: ustring; const acceptFilters: TStrings; const callback: ICefRunFileDialogCallback);`
| `procedure RunFileDialogProc(mode: TCefFileDialogMode; const title, defaultFilePath: ustring; const acceptFilters: TStrings; const callback: TCefRunFileDialogCallbackProc);`
| `procedure StartDownload(const url: ustring);`
| `procedure DownloadImage(const imageUrl: ustring; isFavicon: Boolean; maxImageSize: cardinal; bypassCache: Boolean; const callback: ICefDownloadImageCallback);`
| `procedure Print;`
| `procedure PrintToPdf(const path: ustring; settings: PCefPdfPrintSettings; const callback: ICefPdfPrintCallback);`
| `procedure PrintToPdfProc(const path: ustring; settings: PCefPdfPrintSettings; const callback: TOnPdfPrintFinishedProc);`
| `procedure Find(const searchText: ustring; forward_, matchCase, findNext: Boolean);`
| `procedure StopFinding(clearSelection: Boolean);`
| `procedure ShowDevTools(const windowInfo: PCefWindowInfo; const client: ICefClient; const settings: PCefBrowserSettings; inspectElementAt: PCefPoint);`
| `procedure CloseDevTools;`
| `function HasDevTools: Boolean;`
| `function SendDevToolsMessage(const message_: ustring): boolean;`
| `function ExecuteDevToolsMethod(message_id: integer; const method: ustring; const params: ICefDictionaryValue): Integer;`
| `function AddDevToolsMessageObserver(const observer: ICefDevToolsMessageObserver): ICefRegistration;`
| `procedure GetNavigationEntries(const visitor: ICefNavigationEntryVisitor; currentOnly: Boolean);`
| `procedure GetNavigationEntriesProc(const proc: TCefNavigationEntryVisitorProc; currentOnly: Boolean);`
| `procedure ReplaceMisspelling(const word: ustring);`
| `procedure AddWordToDictionary(const word: ustring);`
| `function IsWindowRenderingDisabled: Boolean;`
| `procedure WasResized;`
| `procedure WasHidden(hidden: Boolean);`
| `procedure NotifyScreenInfoChanged;`
| `procedure Invalidate(kind: TCefPaintElementType);`
| `procedure SendExternalBeginFrame;`
| `procedure SendKeyEvent(const event: PCefKeyEvent);`
| `procedure SendMouseClickEvent(const event: PCefMouseEvent; type_: TCefMouseButtonType; mouseUp: Boolean; clickCount: Integer);`
| `procedure SendMouseMoveEvent(const event: PCefMouseEvent; mouseLeave: Boolean);`
| `procedure SendMouseWheelEvent(const event: PCefMouseEvent; deltaX, deltaY: Integer);`
| `procedure SendTouchEvent(const event: PCefTouchEvent);`
| `procedure SendCaptureLostEvent;`
| `procedure NotifyMoveOrResizeStarted;`
| `function GetWindowlessFrameRate: Integer;`
| `procedure SetWindowlessFrameRate(frameRate: Integer);`
| `procedure IMESetComposition(const text: ustring; const underlines : TCefCompositionUnderlineDynArray; const replacement_range, selection_range : PCefRange);`
| `procedure IMECommitText(const text: ustring; const replacement_range : PCefRange; relative_cursor_pos : integer);`
| `procedure IMEFinishComposingText(keep_selection : boolean);`
| `procedure IMECancelComposition;`
| `procedure DragTargetDragEnter(const dragData: ICefDragData; const event: PCefMouseEvent; allowedOps: TCefDragOperations);`
| `procedure DragTargetDragOver(const event: PCefMouseEvent; allowedOps: TCefDragOperations);`
| `procedure DragTargetDragLeave;`
| `procedure DragTargetDrop(const event: PCefMouseEvent);`
| `procedure DragSourceEndedAt(x, y: Integer; op: TCefDragOperation);`
| `procedure DragSourceSystemDragEnded;`
| `function GetVisibleNavigationEntry: ICefNavigationEntry;`
| `procedure SetAccessibilityState(accessibilityState: TCefState);`
| `procedure SetAutoResizeEnabled(enabled: boolean; const min_size, max_size: PCefSize);`
| `procedure SetAudioMuted(mute: boolean);`
| `function IsAudioMuted: boolean;`
| `function IsFullscreen: boolean;`
| `procedure ExitFullscreen(will_cause_resize: boolean);`
| `function CanExecuteChromeCommand(command_id: integer): boolean;`
| `procedure ExecuteChromeCommand(command_id: integer; disposition: TCefWindowOpenDisposition);`
| `function IsRenderProcessUnresponsive: boolean;`
| `function GetRuntimeStyle: TCefRuntimeStyle;`

### Properties

| `property Browser : ICefBrowser read GetBrowser;`
| `property WindowHandle : TCefWindowHandle read GetWindowHandle;`
| `property OpenerWindowHandle : TCefWindowHandle read GetOpenerWindowHandle;`
| `property OpenerIdentifier : Integer read GetOpenerIdentifier;`
| `property ZoomLevel : Double read GetZoomLevel write SetZoomLevel;`
| `property DefaultZoomLevel : Double read GetDefaultZoomLevel;`
| `property RequestContext : ICefRequestContext read GetRequestContext;`
| `property VisibleNavigationEntry : ICefNavigationEntry read GetVisibleNavigationEntry;`
| `property RuntimeStyle : TCefRuntimeStyle read GetRuntimeStyle;`

## Description

### Methods

| `function GetBrowser: ICefBrowser;`
Returns the hosted browser object. ###### Attributes GUID['{53AE02FF-EF5D-48C3-A43E-069DA9535424}']

| `procedure CloseBrowser(forceClose: Boolean);`
Request that the browser close. Closing a browser is a multi-stage process that may complete either synchronously or asynchronously, and involves events such as TChromiumCore.OnClose (Alloy style only), TChromiumCore.OnBeforeClose, and a top-level window close handler such as TCEFWindowComponent.OnCanClose (or platform-specific equivalent). In some cases a close request may be delayed or canceled by the user. Using TryCloseBrowser() instead of CloseBrowser() is recommended for most use cases. See TChromiumCore.OnClose documentation for detailed usage and examples. If |aForceClose| is false (0) then JavaScript unload handlers, if any, may be fired and the close may be delayed or canceled by the user. If |aForceClose| is true (1) then the user will not be prompted and the close will proceed immediately (possibly asynchronously). If browser close is delayed and not canceled the default behavior is to call the top-level window close handler once the browser is ready to be closed. This default behavior can be changed for Alloy style browsers by implementing TChromiumCore.OnClose. IsReadyToBeClosed() can be used to detect mandatory browser close events when customizing close behavior on the browser process UI thread.

| `function TryCloseBrowser: Boolean;`
Helper for closing a browser. This is similar in behavior to CLoseBrowser(false) but returns a boolean to reflect the immediate close status. Call this function from a top-level window close handler such as TCEFWindowComponent.OnCanClose (or platform-specific equivalent) to request that the browser close, and return the result to indicate if the window close should proceed. Returns false (0) if the close will be delayed (JavaScript unload handlers triggered but still pending) or true (1) if the close will proceed immediately (possibly asynchronously). See CloseBrowser() documentation for additional usage information. This function must be called on the browser process UI thread.

| `function IsReadyToBeClosed: Boolean;`
Returns true (1) if the browser is ready to be closed, meaning that the close has already been initiated and that JavaScript unload handlers have already executed or should be ignored. This can be used from a top-level window close handler such as TCEFWindowComponent.OnCanClose (or platform- specific equivalent) to distringuish between potentially cancelable browser close events (like the user clicking the top-level window close button before browser close has started) and mandatory browser close events (like JavaScript `window.close()` or after browser close has started in response to [Try]CloseBrowser()). Not completing the browser close for mandatory close events (when this function returns true (1)) will leave the browser in a partially closed state that interferes with proper functioning. See CloseBrowser() documentation for additional usage information. This function must be called on the browser process UI thread.

| `procedure SetFocus(focus: Boolean);`
Set whether the browser is focused.

| `function GetWindowHandle: TCefWindowHandle;`
Retrieve the window handle (if any) for this browser. If this browser is wrapped in a ICefBrowserView this function should be called on the browser process UI thread and it will return the handle for the top-level native window.

| `function GetOpenerWindowHandle: TCefWindowHandle;`
Retrieve the window handle (if any) of the browser that opened this browser. Will return NULL for non-popup browsers or if this browser is wrapped in a ICefBrowserView. This function can be used in combination with custom handling of modal windows.

| `function GetOpenerIdentifier: Integer;`
Retrieve the unique identifier of the browser that opened this browser. Will return 0 for non-popup browsers.

| `function HasView: Boolean;`
Returns true (1) if this browser is wrapped in a ICefBrowserView.

| `function GetClient: ICefClient;`
Returns the client for this browser.

| `function GetRequestContext: ICefRequestContext;`
Returns the request context for this browser.

| `function CanZoom(command: TCefZoomCommand): boolean;`
Returns true (1) if this browser can execute the specified zoom command. This function can only be called on the UI thread.

| `procedure Zoom(command: TCefZoomCommand);`
Execute a zoom command in this browser. If called on the UI thread the change will be applied immediately. Otherwise, the change will be applied asynchronously on the UI thread.

| `function GetDefaultZoomLevel: Double;`
Get the default zoom level. This value will be 0.0 by default but can be configured. This function can only be called on the UI thread.

| `function GetZoomLevel: Double;`
Get the current zoom level. This function can only be called on the UI thread.

| `procedure SetZoomLevel(const zoomLevel: Double);`
Change the zoom level to the specified value. Specify 0.0 to reset the zoom level to the default. If called on the UI thread the change will be applied immediately. Otherwise, the change will be applied asynchronously on the UI thread.

| `procedure RunFileDialog(mode: TCefFileDialogMode; const title, defaultFilePath: ustring; const acceptFilters: TStrings; const callback: ICefRunFileDialogCallback);`
Call to run a file chooser dialog. Only a single file chooser dialog may be pending at any given time. |mode| represents the type of dialog to display. |title| to the title to be used for the dialog and may be NULL to show the default title ("Open" or "Save" depending on the mode). |default_file_path| is the path with optional directory and/or file name component that will be initially selected in the dialog. |accept_filters| are used to restrict the selectable file types and may any combination of (a) valid lower-cased MIME types (e.g. "text/*" or "image/*"), (b) individual file extensions (e.g. ".txt" or ".png"), or (c) combined description and file extension delimited using "|" and ";" (e.g. "Image Types|.png;.gif;.jpg"). |callback| will be executed after the dialog is dismissed or immediately if another dialog is already pending. The dialog will be initiated asynchronously on the UI thread.

| `procedure RunFileDialogProc(mode: TCefFileDialogMode; const title, defaultFilePath: ustring; const acceptFilters: TStrings; const callback: TCefRunFileDialogCallbackProc);`
Call to run a file chooser dialog. Only a single file chooser dialog may be pending at any given time. |mode| represents the type of dialog to display. |title| to the title to be used for the dialog and may be NULL to show the default title ("Open" or "Save" depending on the mode). |default_file_path| is the path with optional directory and/or file name component that will be initially selected in the dialog. |accept_filters| are used to restrict the selectable file types and may any combination of (a) valid lower-cased MIME types (e.g. "text/*" or "image/*"), (b) individual file extensions (e.g. ".txt" or ".png"), or (c) combined description and file extension delimited using "|" and ";" (e.g. "Image Types|.png;.gif;.jpg"). |callback| will be executed after the dialog is dismissed or immediately if another dialog is already pending. The dialog will be initiated asynchronously on the UI thread.

| `procedure StartDownload(const url: ustring);`
Download the file at |url| using ICefDownloadHandler.

| `procedure DownloadImage(const imageUrl: ustring; isFavicon: Boolean; maxImageSize: cardinal; bypassCache: Boolean; const callback: ICefDownloadImageCallback);`
Download |image_url| and execute |callback| on completion with the images received from the renderer. If |is_favicon| is true (1) then cookies are not sent and not accepted during download. Images with density independent pixel (DIP) sizes larger than |max_image_size| are filtered out from the image results. Versions of the image at different scale factors may be downloaded up to the maximum scale factor supported by the system. If there are no image results <= |max_image_size| then the smallest image is resized to |max_image_size| and is the only result. A |max_image_size| of 0 means unlimited. If |bypass_cache| is true (1) then |image_url| is requested from the server even if it is present in the browser cache.

| `procedure Print;`
Print the current browser contents.

| `procedure PrintToPdf(const path: ustring; settings: PCefPdfPrintSettings; const callback: ICefPdfPrintCallback);`
Print the current browser contents to the PDF file specified by |path| and execute |callback| on completion. The caller is responsible for deleting |path| when done. For PDF printing to work on Linux you must implement the ICefPrintHandler.GetPdfPaperSize function.

| `procedure PrintToPdfProc(const path: ustring; settings: PCefPdfPrintSettings; const callback: TOnPdfPrintFinishedProc);`
Print the current browser contents to the PDF file specified by |path| and execute |callback| on completion. The caller is responsible for deleting |path| when done. For PDF printing to work on Linux you must implement the ICefPrintHandler.GetPdfPaperSize function.

| `procedure Find(const searchText: ustring; forward_, matchCase, findNext: Boolean);`
Search for |searchText|. |forward| indicates whether to search forward or backward within the page. |matchCase| indicates whether the search should be case-sensitive. |findNext| indicates whether this is the first request or a follow-up. The search will be restarted if |searchText| or |matchCase| change. The search will be stopped if |searchText| is NULL. The ICefFindHandler instance, if any, returned via ICefClient.GetFindHandler will be called to report find results.

| `procedure StopFinding(clearSelection: Boolean);`
Cancel all searches that are currently going on.

| `procedure ShowDevTools(const windowInfo: PCefWindowInfo; const client: ICefClient; const settings: PCefBrowserSettings; inspectElementAt: PCefPoint);`
Open developer tools (DevTools) in its own browser. The DevTools browser will remain associated with this browser. If the DevTools browser is already open then it will be focused, in which case the |windowInfo|, |client| and |settings| parameters will be ignored. If |inspectElementAt| is non-NULL then the element at the specified (x,y) location will be inspected. The |windowInfo| parameter will be ignored if this browser is wrapped in a ICefBrowserView.

| `procedure CloseDevTools;`
Explicitly close the associated DevTools browser, if any.

| `function HasDevTools: Boolean;`
Returns true (1) if this browser currently has an associated DevTools browser. Must be called on the browser process UI thread.

| `function SendDevToolsMessage(const message_: ustring): boolean;`
Send a function call message over the DevTools protocol. |message| must be a UTF8-encoded JSON dictionary that contains "id" (int), "function" (string) and "params" (dictionary, optional) values. See the DevTools protocol documentation at https://chromedevtools.github.io/devtools- protocol/ for details of supported functions and the expected "params" dictionary contents. |message| will be copied if necessary. This function will return true (1) if called on the UI thread and the message was successfully submitted for validation, otherwise false (0). Validation will be applied asynchronously and any messages that fail due to formatting errors or missing parameters may be discarded without notification. Prefer ExecuteDevToolsMethod if a more structured approach to message formatting is desired. Every valid function call will result in an asynchronous function result or error message that references the sent message "id". Event messages are received while notifications are enabled (for example, between function calls for "Page.enable" and "Page.disable"). All received messages will be delivered to the observer(s) registered with AddDevToolsMessageObserver. See ICefDevToolsMessageObserver.OnDevToolsMessage documentation for details of received message contents. Usage of the SendDevToolsMessage, ExecuteDevToolsMethod and AddDevToolsMessageObserver functions does not require an active DevTools front-end or remote-debugging session. Other active DevTools sessions will continue to function independently. However, any modification of global browser state by one session may not be reflected in the UI of other sessions. Communication with the DevTools front-end (when displayed) can be logged for development purposes by passing the `–devtools-protocol-log- file=<path>` command-line flag.

| `function ExecuteDevToolsMethod(message_id: integer; const method: ustring; const params: ICefDictionaryValue): Integer;`
Execute a function call over the DevTools protocol. This is a more structured version of SendDevToolsMessage. |message_id| is an incremental number that uniquely identifies the message (pass 0 to have the next number assigned automatically based on previous values). |function| is the function name. |params| are the function parameters, which may be NULL. See the DevTools protocol documentation (linked above) for details of supported functions and the expected |params| dictionary contents. This function will return the assigned message ID if called on the UI thread and the message was successfully submitted for validation, otherwise 0. See the SendDevToolsMessage documentation for additional usage information.

| `function AddDevToolsMessageObserver(const observer: ICefDevToolsMessageObserver): ICefRegistration;`
Add an observer for DevTools protocol messages (function results and events). The observer will remain registered until the returned Registration object is destroyed. See the SendDevToolsMessage documentation for additional usage information.

| `procedure GetNavigationEntries(const visitor: ICefNavigationEntryVisitor; currentOnly: Boolean);`
Retrieve a snapshot of current navigation entries as values sent to the specified visitor. If |current_only| is true (1) only the current navigation entry will be sent, otherwise all navigation entries will be sent.

| `procedure GetNavigationEntriesProc(const proc: TCefNavigationEntryVisitorProc; currentOnly: Boolean);`
Retrieve a snapshot of current navigation entries as values sent to the specified visitor. If |current_only| is true (1) only the current navigation entry will be sent, otherwise all navigation entries will be sent.

| `procedure ReplaceMisspelling(const word: ustring);`
If a misspelled word is currently selected in an editable node calling this function will replace it with the specified |word|.

| `procedure AddWordToDictionary(const word: ustring);`
Add the specified |word| to the spelling dictionary.

| `function IsWindowRenderingDisabled: Boolean;`
Returns true (1) if window rendering is disabled.

| `procedure WasResized;`
Notify the browser that the widget has been resized. The browser will first call ICefRenderHandler.GetViewRect to get the new size and then call ICefRenderHandler.OnPaint asynchronously with the updated regions. This function is only used when window rendering is disabled.

| `procedure WasHidden(hidden: Boolean);`
Notify the browser that it has been hidden or shown. Layouting and ICefRenderHandler.OnPaint notification will stop when the browser is hidden. This function is only used when window rendering is disabled.

| `procedure NotifyScreenInfoChanged;`
Notify the browser that screen information has changed. Updated information will be sent to the renderer process to configure screen size and position values used by CSS and JavaScript (window.deviceScaleFactor, window.screenX/Y, window.outerWidth/Height, etc.). For background see https://bitbucket.org/chromiumembedded/cef/wiki/GeneralUsage.md#markdown- header-coordinate-systems This function is used with (a) windowless rendering and (b) windowed rendering with external (client-provided) root window. With windowless rendering the browser will call ICefRenderHandler.GetScreenInfo, ICefRenderHandler.GetRootScreenRect and ICefRenderHandler.GetViewRect. This simulates moving or resizing the root window in the current display, moving the root window from one display to another, or changing the properties of the current display. With windowed rendering the browser will call ICefDisplayHandler.GetRootWindowScreenRect and use the associated display properties.

| `procedure Invalidate(kind: TCefPaintElementType);`
Invalidate the view. The browser will call ICefRenderHandler.OnPaint asynchronously. This function is only used when window rendering is disabled.

| `procedure SendExternalBeginFrame;`
Issue a BeginFrame request to Chromium. Only valid when TCefWindowInfo.external_begin_frame_enabled is set to true (1).

| `procedure SendKeyEvent(const event: PCefKeyEvent);`
Send a key event to the browser.

| `procedure SendMouseClickEvent(const event: PCefMouseEvent; type_: TCefMouseButtonType; mouseUp: Boolean; clickCount: Integer);`
Send a mouse click event to the browser. The |x| and |y| coordinates are relative to the upper-left corner of the view.

| `procedure SendMouseMoveEvent(const event: PCefMouseEvent; mouseLeave: Boolean);`
Send a mouse move event to the browser. The |x| and |y| coordinates are relative to the upper-left corner of the view.

| `procedure SendMouseWheelEvent(const event: PCefMouseEvent; deltaX, deltaY: Integer);`
Send a mouse wheel event to the browser. The |x| and |y| coordinates are relative to the upper-left corner of the view. The |deltaX| and |deltaY| values represent the movement delta in the X and Y directions respectively. In order to scroll inside select popups with window rendering disabled ICefRenderHandler.GetScreenPoint should be implemented properly.

| `procedure SendTouchEvent(const event: PCefTouchEvent);`
Send a touch event to the browser for a windowless browser.

| `procedure SendCaptureLostEvent;`
Send a capture lost event to the browser.

| `procedure NotifyMoveOrResizeStarted;`
Notify the browser that the window hosting it is about to be moved or resized. This function is only used on Windows and Linux.

| `function GetWindowlessFrameRate: Integer;`
Returns the maximum rate in frames per second (fps) that ICefRenderHandler.OnPaint will be called for a windowless browser. The actual fps may be lower if the browser cannot generate frames at the requested rate. The minimum value is 1 and the default value is 30. This method can only be called on the UI thread.

| `procedure SetWindowlessFrameRate(frameRate: Integer);`
Set the maximum rate in frames per second (fps) that ICefRenderHandler.OnPaint will be called for a windowless browser. The actual fps may be lower if the browser cannot generate frames at the requested rate. The minimum value is 1 and the default value is 30. Can also be set at browser creation via TCefBrowserSettings.windowless_frame_rate and TChromium.Options.WindowlessFrameRate

| `procedure IMESetComposition(const text: ustring; const underlines : TCefCompositionUnderlineDynArray; const replacement_range, selection_range : PCefRange);`
Begins a new composition or updates the existing composition. Blink has a special node (a composition node) that allows the input function to change text without affecting other DOM nodes. |text| is the optional text that will be inserted into the composition node. |underlines| is an optional set of ranges that will be underlined in the resulting text. |replacement_range| is an optional range of the existing text that will be replaced. |selection_range| is an optional range of the resulting text that will be selected after insertion or replacement. The |replacement_range| value is only used on OS X. This function may be called multiple times as the composition changes. When the client is done making changes the composition should either be canceled or completed. To cancel the composition call ImeCancelComposition. To complete the composition call either ImeCommitText or ImeFinishComposingText. Completion is usually signaled when: 1. The client receives a WM_IME_COMPOSITION message with a GCS_RESULTSTR flag (on Windows), or; 2. The client receives a "commit" signal of GtkIMContext (on Linux), or; 3. insertText of NSTextInput is called (on Mac). This function is only used when window rendering is disabled.

| `procedure IMECommitText(const text: ustring; const replacement_range : PCefRange; relative_cursor_pos : integer);`
Completes the existing composition by optionally inserting the specified |text| into the composition node. |replacement_range| is an optional range of the existing text that will be replaced. |relative_cursor_pos| is where the cursor will be positioned relative to the current cursor position. See comments on ImeSetComposition for usage. The |replacement_range| and |relative_cursor_pos| values are only used on OS X. This function is only used when window rendering is disabled.

| `procedure IMEFinishComposingText(keep_selection : boolean);`
Completes the existing composition by applying the current composition node contents. If |keep_selection| is false (0) the current selection, if any, will be discarded. See comments on ImeSetComposition for usage. This function is only used when window rendering is disabled.

| `procedure IMECancelComposition;`
Cancels the existing composition and discards the composition node contents without applying them. See comments on ImeSetComposition for usage. This function is only used when window rendering is disabled.

| `procedure DragTargetDragEnter(const dragData: ICefDragData; const event: PCefMouseEvent; allowedOps: TCefDragOperations);`
Call this function when the user drags the mouse into the web view (before calling DragTargetDragOver/DragTargetLeave/DragTargetDrop). |drag_data| should not contain file contents as this type of data is not allowed to be dragged into the web view. File contents can be removed using ICefDragData.ResetFileContents (for example, if |drag_data| comes from ICefRenderHandler.StartDragging). This function is only used when window rendering is disabled.

| `procedure DragTargetDragOver(const event: PCefMouseEvent; allowedOps: TCefDragOperations);`
Call this function each time the mouse is moved across the web view during a drag operation (after calling DragTargetDragEnter and before calling DragTargetDragLeave/DragTargetDrop). This function is only used when window rendering is disabled.

| `procedure DragTargetDragLeave;`
Call this function when the user drags the mouse out of the web view (after calling DragTargetDragEnter). This function is only used when window rendering is disabled.

| `procedure DragTargetDrop(const event: PCefMouseEvent);`
Call this function when the user completes the drag operation by dropping the object onto the web view (after calling DragTargetDragEnter). The object being dropped is |drag_data|, given as an argument to the previous DragTargetDragEnter call. This function is only used when window rendering is disabled.

| `procedure DragSourceEndedAt(x, y: Integer; op: TCefDragOperation);`
Call this function when the drag operation started by a ICefRenderHandler.StartDragging call has ended either in a drop or by being cancelled. |x| and |y| are mouse coordinates relative to the upper- left corner of the view. If the web view is both the drag source and the drag target then all DragTarget* functions should be called before DragSource* mthods. This function is only used when window rendering is disabled.

| `procedure DragSourceSystemDragEnded;`
Call this function when the drag operation started by a ICefRenderHandler.StartDragging call has completed. This function may be called immediately without first calling DragSourceEndedAt to cancel a drag operation. If the web view is both the drag source and the drag target then all DragTarget* functions should be called before DragSource* mthods. This function is only used when window rendering is disabled.

| `function GetVisibleNavigationEntry: ICefNavigationEntry;`
Returns the current visible navigation entry for this browser. This function can only be called on the UI thread.

| `procedure SetAccessibilityState(accessibilityState: TCefState);`
Set accessibility state for all frames. |accessibility_state| may be default, enabled or disabled. If |accessibility_state| is STATE_DEFAULT then accessibility will be disabled by default and the state may be further controlled with the "force-renderer-accessibility" and "disable- renderer-accessibility" command-line switches. If |accessibility_state| is STATE_ENABLED then accessibility will be enabled. If |accessibility_state| is STATE_DISABLED then accessibility will be completely disabled. For windowed browsers accessibility will be enabled in Complete mode (which corresponds to kAccessibilityModeComplete in Chromium). In this mode all platform accessibility objects will be created and managed by Chromium's internal implementation. The client needs only to detect the screen reader and call this function appropriately. For example, on macOS the client can handle the @"AXEnhancedUserStructure" accessibility attribute to detect VoiceOver state changes and on Windows the client can handle WM_GETOBJECT with OBJID_CLIENT to detect accessibility readers. For windowless browsers accessibility will be enabled in TreeOnly mode (which corresponds to kAccessibilityModeWebContentsOnly in Chromium). In this mode renderer accessibility is enabled, the full tree is computed, and events are passed to CefAccessibiltyHandler, but platform accessibility objects are not created. The client may implement platform accessibility objects using CefAccessibiltyHandler callbacks if desired.

| `procedure SetAutoResizeEnabled(enabled: boolean; const min_size, max_size: PCefSize);`
Enable notifications of auto resize via ICefDisplayHandler.OnAutoResize. Notifications are disabled by default. |min_size| and |max_size| define the range of allowed sizes.

| `procedure SetAudioMuted(mute: boolean);`
Set whether the browser's audio is muted.

| `function IsAudioMuted: boolean;`
Returns true (1) if the browser's audio is muted. This function can only be called on the UI thread.

| `function IsFullscreen: boolean;`
Returns true (1) if the renderer is currently in browser fullscreen. This differs from window fullscreen in that browser fullscreen is entered using the JavaScript Fullscreen API and modifies CSS attributes such as the ::backdrop pseudo-element and :fullscreen pseudo-structure. This function can only be called on the UI thread.

| `procedure ExitFullscreen(will_cause_resize: boolean);`
Requests the renderer to exit browser fullscreen. In most cases exiting window fullscreen should also exit browser fullscreen. With Alloy style this function should be called in response to a user action such as clicking the green traffic light button on MacOS (ICefWindowDelegate.OnWindowFullscreenTransition callback) or pressing the "ESC" key (ICefKeyboardHandler.OnPreKeyEvent callback). With Chrome style these standard exit actions are handled internally but new/additional user actions can use this function. Set |will_cause_resize| to true (1) if exiting browser fullscreen will cause a view resize.

| `function CanExecuteChromeCommand(command_id: integer): boolean;`
Returns true (1) if a Chrome command is supported and enabled. Use the cef_id_for_command_id_name() function for version-safe mapping of command IDC names from cef_command_ids.h to version-specific numerical |command_id| values. This function can only be called on the UI thread. Only used with Chrome style. See the IDC_* constants in uCEFConstants.pas for all the |command_id| values. <see href="https://source.chromium.org/chromium/chromium/src/+/main:chrome/app/chrome_command_ids.h">The command_id values are also available in chrome/app/chrome_command_ids.h)

| `procedure ExecuteChromeCommand(command_id: integer; disposition: TCefWindowOpenDisposition);`
Returns true (1) if a Chrome command is supported and enabled. Use the cef_id_for_command_id_name() function for version-safe mapping of command IDC names from cef_command_ids.h to version-specific numerical |command_id| values. This function can only be called on the UI thread. Only used with Chrome style. See the IDC_* constants in uCEFConstants.pas for all the |command_id| values. <see href="https://source.chromium.org/chromium/chromium/src/+/main:chrome/app/chrome_command_ids.h">The command_id values are also available in chrome/app/chrome_command_ids.h)

| `function IsRenderProcessUnresponsive: boolean;`
Returns true (1) if the render process associated with this browser is currently unresponsive as indicated by a lack of input event processing for at least 15 seconds. To receive associated state change notifications and optionally handle an unresponsive render process implement ICefRequestHandler.OnRenderProcessUnresponsive. This function can only be called on the CEF UI thread.

| `function GetRuntimeStyle: TCefRuntimeStyle;`
Returns the runtime style for this browser (ALLOY or CHROME). See TCefRuntimeStyle documentation for details. This function can only be called on the CEF UI thread.

### Properties

| `property Browser : ICefBrowser read GetBrowser;`
Returns the hosted browser object.

| `property WindowHandle : TCefWindowHandle read GetWindowHandle;`
Retrieve the window handle (if any) for this browser. If this browser is wrapped in a ICefBrowserView this function should be called on the browser process UI thread and it will return the handle for the top-level native window.

| `property OpenerWindowHandle : TCefWindowHandle read GetOpenerWindowHandle;`
Retrieve the window handle (if any) of the browser that opened this browser. Will return NULL for non-popup browsers or if this browser is wrapped in a ICefBrowserView. This function can be used in combination with custom handling of modal windows.

| `property OpenerIdentifier : Integer read GetOpenerIdentifier;`
Retrieve the unique identifier of the browser that opened this browser. Will return 0 for non-popup browsers.

| `property ZoomLevel : Double read GetZoomLevel write SetZoomLevel;`
Get the current zoom level. The default zoom level is 0.0. This function can only be called on the UI thread.

| `property DefaultZoomLevel : Double read GetDefaultZoomLevel;`
Get the default zoom level. This value will be 0.0 by default but can be configured with the Chrome runtime. This property can only be used on the CEF UI thread.

| `property RequestContext : ICefRequestContext read GetRequestContext;`
Returns the request context for this browser.

| `property VisibleNavigationEntry : ICefNavigationEntry read GetVisibleNavigationEntry;`
Retrieve a snapshot of current navigation entries as values sent to the specified visitor. If |current_only| is true (1) only the current navigation entry will be sent, otherwise all navigation entries will be sent.

| `property RuntimeStyle : TCefRuntimeStyle read GetRuntimeStyle;`
Returns the runtime style for this browser (ALLOY or CHROME). See TCefRuntimeStyle documentation for details. This property can only be used on the CEF UI thread.

Generated by PasDoc 0.16.0-snapshot.