Class TCefBrowserHostRef

Description
Hierarchy
Fields
Methods
Properties

Unit

uCEFBrowser

Declaration

type TCefBrowserHostRef = class(TCefBaseRefCountedRef, ICefBrowserHost)

Description

This item has no description.

Hierarchy

Overview

Methods

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

Description

Methods

Protected function GetBrowser: ICefBrowser;

This item has no description. Showing description inherited from ICefBrowserHost.GetBrowser.

Returns the hosted browser object.

Protected procedure CloseBrowser(forceClose: Boolean);

This item has no description. Showing description inherited from ICefBrowserHost.CloseBrowser.

Request that the browser close. The JavaScript 'onbeforeunload' event will be fired. If |force_close| is false (0) the event handler, if any, will be allowed to prompt the user and the user can optionally cancel the close. If |force_close| is true (1) the prompt will not be displayed and the close will proceed. Results in a call to ICefLifeSpanHandler.DoClose() if the event handler allows the close or if |force_close| is true (1). See ICefLifeSpanHandler.DoClose() documentation for additional usage information.

Protected function TryCloseBrowser: Boolean;

This item has no description. Showing description inherited from ICefBrowserHost.TryCloseBrowser.

Helper for closing a browser. Call this function from the top-level window close handler (if any). Internally this calls CloseBrowser(false (0)) if the close has not yet been initiated. This function returns false (0) while the close is pending and true (1) after the close has completed. See CloseBrowser() and ICefLifeSpanHandler.DoClose() documentation for additional usage information. This function must be called on the browser process UI thread.

Protected procedure SetFocus(focus: Boolean);

This item has no description. Showing description inherited from ICefBrowserHost.SetFocus.

Set whether the browser is focused.

Protected function GetWindowHandle: TCefWindowHandle;

This item has no description. Showing description inherited from ICefBrowserHost.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.

Protected function GetOpenerWindowHandle: TCefWindowHandle;

This item has no description. Showing description inherited from ICefBrowserHost.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.

Protected function HasView: Boolean;

This item has no description. Showing description inherited from ICefBrowserHost.HasView.

Returns true (1) if this browser is wrapped in a ICefBrowserView.

Protected function GetClient: ICefClient;

This item has no description. Showing description inherited from ICefBrowserHost.GetClient.

Returns the client for this browser.

Protected function GetRequestContext: ICefRequestContext;

This item has no description. Showing description inherited from ICefBrowserHost.GetRequestContext.

Returns the request context for this browser.

Protected function CanZoom(command: TCefZoomCommand): boolean;

This item has no description. Showing description inherited from ICefBrowserHost.CanZoom.

Returns true (1) if this browser can execute the specified zoom command. This function can only be called on the UI thread.

Protected procedure Zoom(command: TCefZoomCommand);

This item has no description. Showing description inherited from ICefBrowserHost.Zoom.

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.

Protected function GetDefaultZoomLevel: Double;

This item has no description. Showing description inherited from ICefBrowserHost.GetDefaultZoomLevel.

Get the default zoom level. This value will be 0.0 by default but can be configured with the Chrome runtime. This function can only be called on the UI thread.

Protected function GetZoomLevel: Double;

This item has no description. Showing description inherited from ICefBrowserHost.GetZoomLevel.

Get the current zoom level. This function can only be called on the UI thread.

Protected procedure SetZoomLevel(const zoomLevel: Double);

This item has no description. Showing description inherited from ICefBrowserHost.SetZoomLevel.

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.

Protected procedure RunFileDialog(mode: TCefFileDialogMode; const title, defaultFilePath: ustring; const acceptFilters: TStrings; const callback: ICefRunFileDialogCallback);

This item has no description. Showing description inherited from ICefBrowserHost.RunFileDialog.

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.

Protected procedure RunFileDialogProc(mode: TCefFileDialogMode; const title, defaultFilePath: ustring; const acceptFilters: TStrings; const callback: TCefRunFileDialogCallbackProc);

This item has no description. Showing description inherited from ICefBrowserHost.RunFileDialogProc.

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.

Protected procedure StartDownload(const url: ustring);

This item has no description. Showing description inherited from ICefBrowserHost.StartDownload.

Download the file at |url| using ICefDownloadHandler.

Protected procedure DownloadImage(const imageUrl: ustring; isFavicon: Boolean; maxImageSize: Cardinal; bypassCache: Boolean; const callback: ICefDownloadImageCallback);

This item has no description. Showing description inherited from ICefBrowserHost.DownloadImage.

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.

Protected procedure DownloadImageProc(const imageUrl: ustring; isFavicon: Boolean; maxImageSize: Cardinal; bypassCache: Boolean; const callback: TOnDownloadImageFinishedProc);

This item has no description.

Protected procedure Print;

This item has no description. Showing description inherited from ICefBrowserHost.Print.

Print the current browser contents.

Protected procedure PrintToPdf(const path: ustring; settings: PCefPdfPrintSettings; const callback: ICefPdfPrintCallback);

This item has no description. Showing description inherited from ICefBrowserHost.PrintToPdf.

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.

Protected procedure PrintToPdfProc(const path: ustring; settings: PCefPdfPrintSettings; const callback: TOnPdfPrintFinishedProc);

This item has no description. Showing description inherited from ICefBrowserHost.PrintToPdfProc.

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.

Protected procedure Find(const searchText: ustring; forward_, matchCase, findNext: Boolean);

This item has no description. Showing description inherited from ICefBrowserHost.Find.

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.

Protected procedure StopFinding(clearSelection: Boolean);

This item has no description. Showing description inherited from ICefBrowserHost.StopFinding.

Cancel all searches that are currently going on.

Protected procedure ShowDevTools(const windowInfo: PCefWindowInfo; const client: ICefClient; const settings: PCefBrowserSettings; inspectElementAt: PCefPoint);

This item has no description. Showing description inherited from ICefBrowserHost.ShowDevTools.

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.

Protected procedure CloseDevTools;

This item has no description. Showing description inherited from ICefBrowserHost.CloseDevTools.

Explicitly close the associated DevTools browser, if any.

Protected function HasDevTools: Boolean;

This item has no description. Showing description inherited from ICefBrowserHost.HasDevTools.

Returns true (1) if this browser currently has an associated DevTools browser. Must be called on the browser process UI thread.

Protected function SendDevToolsMessage(const message_: ustring): boolean;

This item has no description. Showing description inherited from ICefBrowserHost.SendDevToolsMessage.

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.

Protected function ExecuteDevToolsMethod(message_id: integer; const method: ustring; const params: ICefDictionaryValue): Integer;

This item has no description. Showing description inherited from ICefBrowserHost.ExecuteDevToolsMethod.

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.

Protected function AddDevToolsMessageObserver(const observer: ICefDevToolsMessageObserver): ICefRegistration;

This item has no description. Showing description inherited from ICefBrowserHost.AddDevToolsMessageObserver.

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.

Protected procedure GetNavigationEntries(const visitor: ICefNavigationEntryVisitor; currentOnly: Boolean);

This item has no description. Showing description inherited from ICefBrowserHost.GetNavigationEntries.

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.

Protected procedure GetNavigationEntriesProc(const proc: TCefNavigationEntryVisitorProc; currentOnly: Boolean);

This item has no description. Showing description inherited from ICefBrowserHost.GetNavigationEntriesProc.

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.

Protected procedure ReplaceMisspelling(const word: ustring);

This item has no description. Showing description inherited from ICefBrowserHost.ReplaceMisspelling.

If a misspelled word is currently selected in an editable node calling this function will replace it with the specified |word|.

Protected procedure AddWordToDictionary(const word: ustring);

This item has no description. Showing description inherited from ICefBrowserHost.AddWordToDictionary.

Add the specified |word| to the spelling dictionary.

Protected function IsWindowRenderingDisabled: Boolean;

This item has no description. Showing description inherited from ICefBrowserHost.IsWindowRenderingDisabled.

Returns true (1) if window rendering is disabled.

Protected procedure WasResized;

This item has no description. Showing description inherited from ICefBrowserHost.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.

Protected procedure NotifyScreenInfoChanged;

This item has no description. Showing description inherited from ICefBrowserHost.NotifyScreenInfoChanged.

Send a notification to the browser that the screen info has changed. The browser will then call ICefRenderHandler.GetScreenInfo to update the screen information with the new values. This simulates moving the webview window from one display to another, or changing the properties of the current display. This function is only used when window rendering is disabled.

Protected procedure WasHidden(hidden: Boolean);

This item has no description. Showing description inherited from ICefBrowserHost.WasHidden.

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.

Protected procedure Invalidate(type_: TCefPaintElementType);

This item has no description. Showing description inherited from ICefBrowserHost.Invalidate.

Invalidate the view. The browser will call ICefRenderHandler.OnPaint asynchronously. This function is only used when window rendering is disabled.

Protected procedure SendExternalBeginFrame;

This item has no description. Showing description inherited from ICefBrowserHost.SendExternalBeginFrame.

Issue a BeginFrame request to Chromium. Only valid when TCefWindowInfo.external_begin_frame_enabled is set to true (1).

Protected procedure SendKeyEvent(const event: PCefKeyEvent);

This item has no description. Showing description inherited from ICefBrowserHost.SendKeyEvent.

Send a key event to the browser.

Protected procedure SendMouseClickEvent(const event: PCefMouseEvent; type_: TCefMouseButtonType; mouseUp: Boolean; clickCount: Integer);

This item has no description. Showing description inherited from ICefBrowserHost.SendMouseClickEvent.

Send a mouse click event to the browser. The |x| and |y| coordinates are relative to the upper-left corner of the view.

Protected procedure SendMouseMoveEvent(const event: PCefMouseEvent; mouseLeave: Boolean);

This item has no description. Showing description inherited from ICefBrowserHost.SendMouseMoveEvent.

Send a mouse move event to the browser. The |x| and |y| coordinates are relative to the upper-left corner of the view.

Protected procedure SendMouseWheelEvent(const event: PCefMouseEvent; deltaX, deltaY: Integer);

This item has no description. Showing description inherited from ICefBrowserHost.SendMouseWheelEvent.

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.

Protected procedure SendTouchEvent(const event: PCefTouchEvent);

This item has no description. Showing description inherited from ICefBrowserHost.SendTouchEvent.

Send a touch event to the browser for a windowless browser.

Protected procedure SendCaptureLostEvent;

This item has no description. Showing description inherited from ICefBrowserHost.SendCaptureLostEvent.

Send a capture lost event to the browser.

Protected procedure NotifyMoveOrResizeStarted;

This item has no description. Showing description inherited from ICefBrowserHost.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.

Protected function GetWindowlessFrameRate: Integer;

This item has no description. Showing description inherited from ICefBrowserHost.GetWindowlessFrameRate.

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 maximum value is 60 (default 30). This function can only be called on the UI thread.

Protected procedure SetWindowlessFrameRate(frameRate: Integer);

This item has no description. Showing description inherited from ICefBrowserHost.SetWindowlessFrameRate.

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 maximum value is 60 (default 30). Can also be set at browser creation via TCefBrowserSettings.windowless_frame_rate.

Protected procedure IMESetComposition(const text: ustring; const underlines : TCefCompositionUnderlineDynArray; const replacement_range, selection_range : PCefRange);

This item has no description. Showing description inherited from ICefBrowserHost.IMESetComposition.

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.

Protected procedure IMECommitText(const text: ustring; const replacement_range : PCefRange; relative_cursor_pos : integer);

This item has no description. Showing description inherited from ICefBrowserHost.IMECommitText.

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.

Protected procedure IMEFinishComposingText(keep_selection : boolean);

This item has no description. Showing description inherited from ICefBrowserHost.IMEFinishComposingText.

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.

Protected procedure IMECancelComposition;

This item has no description. Showing description inherited from ICefBrowserHost.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.

Protected procedure DragTargetDragEnter(const dragData: ICefDragData; const event: PCefMouseEvent; allowedOps: TCefDragOperations);

This item has no description. Showing description inherited from ICefBrowserHost.DragTargetDragEnter.

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.

Protected procedure DragTargetDragOver(const event: PCefMouseEvent; allowedOps: TCefDragOperations);

This item has no description. Showing description inherited from ICefBrowserHost.DragTargetDragOver.

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.

Protected procedure DragTargetDragLeave;

This item has no description. Showing description inherited from ICefBrowserHost.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.

Protected procedure DragTargetDrop(const event: PCefMouseEvent);

This item has no description. Showing description inherited from ICefBrowserHost.DragTargetDrop.

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.

Protected procedure DragSourceEndedAt(x, y: Integer; op: TCefDragOperation);

This item has no description. Showing description inherited from ICefBrowserHost.DragSourceEndedAt.

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.

Protected procedure DragSourceSystemDragEnded;

This item has no description. Showing description inherited from ICefBrowserHost.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.

Protected function GetVisibleNavigationEntry: ICefNavigationEntry;

This item has no description. Showing description inherited from ICefBrowserHost.GetVisibleNavigationEntry.

Returns the current visible navigation entry for this browser. This function can only be called on the UI thread.

Protected procedure SetAccessibilityState(accessibilityState: TCefState);

This item has no description. Showing description inherited from ICefBrowserHost.SetAccessibilityState.

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.

Protected procedure SetAutoResizeEnabled(enabled: boolean; const min_size, max_size: PCefSize);

This item has no description. Showing description inherited from ICefBrowserHost.SetAutoResizeEnabled.

Enable notifications of auto resize via ICefDisplayHandler.OnAutoResize. Notifications are disabled by default. |min_size| and |max_size| define the range of allowed sizes.

Protected function GetExtension: ICefExtension;

This item has no description. Showing description inherited from ICefBrowserHost.GetExtension.

Returns the extension hosted in this browser or NULL if no extension is hosted. See ICefRequestContext.LoadExtension for details.

WARNING: This API is deprecated and will be removed in ~M127.

Protected function IsBackgroundHost: boolean;

This item has no description. Showing description inherited from ICefBrowserHost.IsBackgroundHost.

Returns true (1) if this browser is hosting an extension background script. Background hosts do not have a window and are not displayable. See ICefRequestContext.LoadExtension for details.

WARNING: This API is deprecated and will be removed in ~M127.

Protected procedure SetAudioMuted(mute: boolean);

This item has no description. Showing description inherited from ICefBrowserHost.SetAudioMuted.

Set whether the browser's audio is muted.

Protected function IsAudioMuted: boolean;

This item has no description. Showing description inherited from ICefBrowserHost.IsAudioMuted.

Returns true (1) if the browser's audio is muted. This function can only be called on the UI thread.

Protected function IsFullscreen: boolean;

This item has no description. Showing description inherited from ICefBrowserHost.IsFullscreen.

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.

Protected procedure ExitFullscreen(will_cause_resize: boolean);

This item has no description. Showing description inherited from ICefBrowserHost.ExitFullscreen.

Requests the renderer to exit browser fullscreen. In most cases exiting window fullscreen should also exit browser fullscreen. With the Alloy runtime 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 the Chrome runtime 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.

Protected function CanExecuteChromeCommand(command_id: integer): boolean;

This item has no description. Showing description inherited from ICefBrowserHost.CanExecuteChromeCommand.

Returns true (1) if a Chrome command is supported and enabled. Values for |command_id| can be found in the cef_command_ids.h file. This function can only be called on the UI thread. Only used with the Chrome runtime.

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)

Protected procedure ExecuteChromeCommand(command_id: integer; disposition: TCefWindowOpenDisposition);

This item has no description. Showing description inherited from ICefBrowserHost.ExecuteChromeCommand.

Execute a Chrome command. Values for |command_id| can be found in the cef_command_ids.h file. |disposition| provides information about the intended command target. Only used with the Chrome runtime.

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)

Protected function IsRenderProcessUnresponsive: boolean;

This item has no description. Showing description inherited from ICefBrowserHost.IsRenderProcessUnresponsive.

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.

Protected function GetRuntimeStyle: TCefRuntimeStyle;

This item has no description. Showing description inherited from ICefBrowserHost.GetRuntimeStyle.

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.

Public class function UnWrap(data: Pointer): ICefBrowserHost;

This item has no description.

Generated by PasDoc 0.16.0-snapshot.