CefBrowserHost MethodsXilium.CefGlue

[This is preliminary documentation and is subject to change.]

The CefBrowserHost type exposes the following members.
Methods

  NameDescription
Public methodAddWordToDictionary
Add the specified |word| to the spelling dictionary.
Public methodCloseBrowser
Request that the browser close. The JavaScript 'onbeforeunload' event will be fired. If |force_close| is false 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 the prompt will not be displayed and the close will proceed. Results in a call to CefLifeSpanHandler::DoClose() if the event handler allows the close or if |force_close| is true. See CefLifeSpanHandler::DoClose() documentation for additional usage information.
Public methodCloseDevTools
Explicitly close the developer tools window if one exists for this browser instance.
Public methodStatic memberCreateBrowser(CefWindowInfo, CefClient, CefBrowserSettings)
Public methodStatic memberCreateBrowser(CefWindowInfo, CefClient, CefBrowserSettings, String)
Public methodStatic memberCreateBrowser(CefWindowInfo, CefClient, CefBrowserSettings, Uri)
Public methodStatic memberCreateBrowser(CefWindowInfo, CefClient, CefBrowserSettings, CefRequestContext)
Public methodStatic memberCreateBrowser(CefWindowInfo, CefClient, CefBrowserSettings, String, CefRequestContext)
Create a new browser window using the window parameters specified by |windowInfo|. All values will be copied internally and the actual window will be created on the UI thread. If |request_context| is empty the global request context will be used. This method can be called on any browser process thread and will not block.
Public methodStatic memberCreateBrowser(CefWindowInfo, CefClient, CefBrowserSettings, Uri, CefRequestContext)
Public methodStatic memberCreateBrowserSync(CefWindowInfo, CefClient, CefBrowserSettings)
Public methodStatic memberCreateBrowserSync(CefWindowInfo, CefClient, CefBrowserSettings, String)
Public methodStatic memberCreateBrowserSync(CefWindowInfo, CefClient, CefBrowserSettings, Uri)
Public methodStatic memberCreateBrowserSync(CefWindowInfo, CefClient, CefBrowserSettings, CefRequestContext)
Public methodStatic memberCreateBrowserSync(CefWindowInfo, CefClient, CefBrowserSettings, String, CefRequestContext)
Create a new browser window using the window parameters specified by |windowInfo|. If |request_context| is empty the global request context will be used. This method can only be called on the browser process UI thread.
Public methodStatic memberCreateBrowserSync(CefWindowInfo, CefClient, CefBrowserSettings, Uri, CefRequestContext)
Public methodDispose
Public methodDragSourceEndedAt
Call this method when the drag operation started by a CefRenderHandler::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* methods should be called before DragSource* mthods. This method is only used when window rendering is disabled.
Public methodDragSourceSystemDragEnded
Call this method when the drag operation started by a CefRenderHandler::StartDragging call has completed. This method 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* methods should be called before DragSource* mthods. This method is only used when window rendering is disabled.
Public methodDragTargetDragEnter
Call this method 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 CefDragData::ResetFileContents (for example, if |drag_data| comes from CefRenderHandler::StartDragging). This method is only used when window rendering is disabled.
Public methodDragTargetDragLeave
Call this method when the user drags the mouse out of the web view (after calling DragTargetDragEnter). This method is only used when window rendering is disabled.
Public methodDragTargetDragOver
Call this method each time the mouse is moved across the web view during a drag operation (after calling DragTargetDragEnter and before calling DragTargetDragLeave/DragTargetDrop). This method is only used when window rendering is disabled.
Public methodDragTargetDrop
Call this method 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 method is only used when window rendering is disabled.
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodFinalize (Overrides OnlineObject Finalize .)
Public methodFind
Search for |searchText|. |identifier| can be used to have multiple searches running simultaniously. |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 CefFindHandler instance, if any, returned via CefClient::GetFindHandler will be called to report find results.
Public methodGetBrowser
Returns the hosted browser object.
Public methodGetClient
Returns the client for this browser.
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodGetNavigationEntries
Retrieve a snapshot of current navigation entries as values sent to the specified visitor. If |current_only| is true only the current navigation entry will be sent, otherwise all navigation entries will be sent.
Public methodGetNSTextInputContext
Get the NSTextInputContext implementation for enabling IME on Mac when window rendering is disabled.
Public methodGetOpenerWindowHandle
Retrieve the window handle of the browser that opened this browser. Will return NULL for non-popup windows. This method can be used in combination with custom handling of modal windows.
Public methodGetRequestContext
Returns the request context for this browser.
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodGetWindowHandle
Retrieve the window handle for this browser.
Public methodGetZoomLevel
Get the current zoom level. The default zoom level is 0.0. This method can only be called on the UI thread.
Public methodHandleKeyEventAfterTextInputClient
Performs any additional actions after NSTextInputClient handles the event.
Public methodHandleKeyEventBeforeTextInputClient
Handles a keyDown event prior to passing it through the NSTextInputClient machinery.
Public methodInvalidate
Invalidate the view. The browser will call CefRenderHandler::OnPaint asynchronously. This method is only used when window rendering is disabled.
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodNotifyMoveOrResizeStarted
Notify the browser that the window hosting it is about to be moved or resized. This method is only used on Windows and Linux.
Public methodNotifyScreenInfoChanged
Send a notification to the browser that the screen info has changed. The browser will then call CefRenderHandler::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 method is only used when window rendering is disabled.
Public methodPrint
Print the current browser contents.
Public methodReplaceMisspelling
If a misspelled word is currently selected in an editable node calling this method will replace it with the specified |word|.
Public methodRunFileDialog
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 empty 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"). |selected_accept_filter| is the 0-based index of the filter that will be selected by default. |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.
Public methodSendCaptureLostEvent
Send a capture lost event to the browser.
Public methodSendFocusEvent
Send a focus event to the browser.
Public methodSendKeyEvent
Send a key event to the browser.
Public methodSendMouseClickEvent
Send a mouse click event to the browser. The |x| and |y| coordinates are relative to the upper-left corner of the view.
Public methodSendMouseMoveEvent
Send a mouse move event to the browser. The |x| and |y| coordinates are relative to the upper-left corner of the view.
Public methodSendMouseWheelEvent
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 CefRenderHandler::GetScreenPoint should be implemented properly.
Public methodSetFocus
Set whether the browser is focused.
Public methodSetMouseCursorChangeDisabled
Set whether mouse cursor change is disabled.
Public methodSetWindowVisibility
Set whether the window containing the browser is visible (minimized/unminimized, app hidden/unhidden, etc). Only used on Mac OS X.
Public methodSetZoomLevel
Change the zoom level to the specified value. Specify 0.0 to reset the zoom level. If called on the UI thread the change will be applied immediately. Otherwise, the change will be applied asynchronously on the UI thread.
Public methodShowDevTools
Open developer tools in its own window. If |inspect_element_at| is non- empty the element at the specified (x,y) location will be inspected.
Public methodStartDownload
Download the file at |url| using CefDownloadHandler.
Public methodStopFinding
Cancel all searches that are currently going on.
Public methodOnlineToString
Returns a OnlineString that represents the current OnlineObject.
(Inherited from OnlineObject.)
Public methodWasHidden
Notify the browser that it has been hidden or shown. Layouting and CefRenderHandler::OnPaint notification will stop when the browser is hidden. This method is only used when window rendering is disabled.
Public methodWasResized
Notify the browser that the widget has been resized. The browser will first call CefRenderHandler::GetViewRect to get the new size and then call CefRenderHandler::OnPaint asynchronously with the updated regions. This method is only used when window rendering is disabled.
Back to Top
See Also