[This is preliminary documentation and is subject to change.]
The CefBrowserHost type exposes the following members.Methods
Name | Description | |
---|---|---|
AddWordToDictionary |
Add the specified |word| to the spelling dictionary.
| |
CloseBrowser |
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.
| |
CloseDevTools |
Explicitly close the developer tools window if one exists for this browser
instance.
| |
CreateBrowser(CefWindowInfo, CefClient, CefBrowserSettings) | ||
CreateBrowser(CefWindowInfo, CefClient, CefBrowserSettings, String) | ||
CreateBrowser(CefWindowInfo, CefClient, CefBrowserSettings, Uri) | ||
CreateBrowser(CefWindowInfo, CefClient, CefBrowserSettings, CefRequestContext) | ||
CreateBrowser(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.
| |
CreateBrowser(CefWindowInfo, CefClient, CefBrowserSettings, Uri, CefRequestContext) | ||
CreateBrowserSync(CefWindowInfo, CefClient, CefBrowserSettings) | ||
CreateBrowserSync(CefWindowInfo, CefClient, CefBrowserSettings, String) | ||
CreateBrowserSync(CefWindowInfo, CefClient, CefBrowserSettings, Uri) | ||
CreateBrowserSync(CefWindowInfo, CefClient, CefBrowserSettings, CefRequestContext) | ||
CreateBrowserSync(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.
| |
CreateBrowserSync(CefWindowInfo, CefClient, CefBrowserSettings, Uri, CefRequestContext) | ||
Dispose | ||
DragSourceEndedAt |
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.
| |
DragSourceSystemDragEnded |
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.
| |
DragTargetDragEnter |
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.
| |
DragTargetDragLeave |
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.
| |
DragTargetDragOver |
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.
| |
DragTargetDrop |
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.
| |
Equals | (Inherited from Object.) | |
Finalize | (Overrides Object Finalize .) | |
Find |
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.
| |
GetBrowser |
Returns the hosted browser object.
| |
GetClient |
Returns the client for this browser.
| |
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
GetNavigationEntries |
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.
| |
GetNSTextInputContext |
Get the NSTextInputContext implementation for enabling IME on Mac when
window rendering is disabled.
| |
GetOpenerWindowHandle |
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.
| |
GetRequestContext |
Returns the request context for this browser.
| |
GetType |
Gets the Type of the current instance.
(Inherited from Object.) | |
GetWindowHandle |
Retrieve the window handle for this browser.
| |
GetZoomLevel |
Get the current zoom level. The default zoom level is 0.0. This method can
only be called on the UI thread.
| |
HandleKeyEventAfterTextInputClient |
Performs any additional actions after NSTextInputClient handles the event.
| |
HandleKeyEventBeforeTextInputClient |
Handles a keyDown event prior to passing it through the NSTextInputClient
machinery.
| |
Invalidate |
Invalidate the view. The browser will call CefRenderHandler::OnPaint
asynchronously. This method is only used when window rendering is
disabled.
| |
MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
NotifyMoveOrResizeStarted |
Notify the browser that the window hosting it is about to be moved or
resized. This method is only used on Windows and Linux.
| |
NotifyScreenInfoChanged |
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.
| |
Print the current browser contents.
| ||
ReplaceMisspelling |
If a misspelled word is currently selected in an editable node calling
this method will replace it with the specified |word|.
| |
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 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.
| |
SendCaptureLostEvent |
Send a capture lost event to the browser.
| |
SendFocusEvent |
Send a focus event to the browser.
| |
SendKeyEvent |
Send a key event to the browser.
| |
SendMouseClickEvent |
Send a mouse click event to the browser. The |x| and |y| coordinates are
relative to the upper-left corner of the view.
| |
SendMouseMoveEvent |
Send a mouse move event to the browser. The |x| and |y| coordinates are
relative to the upper-left corner of the view.
| |
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
CefRenderHandler::GetScreenPoint should be implemented properly.
| |
SetFocus |
Set whether the browser is focused.
| |
SetMouseCursorChangeDisabled |
Set whether mouse cursor change is disabled.
| |
SetWindowVisibility |
Set whether the window containing the browser is visible
(minimized/unminimized, app hidden/unhidden, etc). Only used on Mac OS X.
| |
SetZoomLevel |
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.
| |
ShowDevTools |
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.
| |
StartDownload |
Download the file at |url| using CefDownloadHandler.
| |
StopFinding |
Cancel all searches that are currently going on.
| |
ToString | (Inherited from Object.) | |
WasHidden |
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.
| |
WasResized |
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.
|
See Also