Expand description
§cef-dll-sys
Generated bindings for the prebuilt Chromium Embedded Framework C API on any supported platform.
Structs§
- _XDisplay
- _XEvent
- _cef_
accelerated_ paint_ info_ common_ t - Structure containing shared texture common metadata. For documentation on each field, please refer to src/media/base/video_frame_metadata.h for actual details.
- _cef_
accelerated_ paint_ info_ t - Structure containing shared texture information for the OnAcceleratedPaint callback. Resources will be released to the underlying pool for reuse when the callback returns from client code.
- _cef_
accelerated_ paint_ native_ pixmap_ plane_ info_ t - Structure containing the plane information of the shared texture. Sync with native_pixmap_handle.h
- _cef_
accessibility_ handler_ t - Implement this structure to receive accessibility notification when accessibility events have been registered. The functions of this structure will be called on the UI thread.
- _cef_
app_ t - Implement this structure to provide handler implementations. Methods will be called by the process and/or thread indicated.
- _cef_
audio_ handler_ t - Implement this structure to handle audio events.
- _cef_
audio_ parameters_ t - Structure representing the audio parameters for setting up the audio handler.
- _cef_
auth_ callback_ t - Callback structure used for asynchronous continuation of authentication requests.
- _cef_
base_ ref_ counted_ t - All ref-counted framework structures must include this structure first.
- _cef_
base_ scoped_ t - All scoped framework structures must include this structure first.
- _cef_
basetime_ t - Represents a wall clock time in UTC. Values are not guaranteed to be monotonically non-decreasing and are subject to large amounts of skew. Time is stored internally as microseconds since the Windows epoch (1601).
- _cef_
before_ download_ callback_ t - Callback structure used to asynchronously continue a download.
- _cef_
binary_ value_ t - Structure representing a binary value. Can be used on any process and thread.
- _cef_
box_ layout_ settings_ t - Settings used when initializing a CefBoxLayout.
- _cef_
box_ layout_ t - A Layout manager that arranges child views vertically or horizontally in a side-by-side fashion with spacing around and between the child views. The child views are always sized according to their preferred size. If the host’s bounds provide insufficient space, child views will be clamped. Excess space will not be distributed. Methods must be called on the browser process UI thread unless otherwise indicated.
- _cef_
browser_ host_ t - Structure used to represent the browser process aspects of a browser. The functions of this structure can only be called in the browser process. They may be called on any thread in that process unless otherwise indicated in the comments.
- _cef_
browser_ process_ handler_ t - Structure used to implement browser process callbacks. The functions of this structure will be called on the browser process main thread unless otherwise indicated.
- _cef_
browser_ settings_ t - Browser initialization settings. Specify NULL or 0 to get the recommended default values. The consequences of using custom values may not be well tested. Many of these and other settings can also configured using command- line switches.
- _cef_
browser_ t - Structure used to represent a browser. When used in the browser process the functions of this structure may be called on any thread unless otherwise indicated in the comments. When used in the render process the functions of this structure may only be called on the main thread.
- _cef_
browser_ view_ delegate_ t - Implement this structure to handle BrowserView events. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- _cef_
browser_ view_ t - A View hosting a cef_browser_t instance. Methods must be called on the browser process UI thread unless otherwise indicated.
- _cef_
button_ delegate_ t - Implement this structure to handle Button events. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- _cef_
button_ t - A View representing a button. Depending on the specific type, the button could be implemented by a native control or custom rendered. Methods must be called on the browser process UI thread unless otherwise indicated.
- _cef_
callback_ t - Generic callback structure used for asynchronous continuation.
- _cef_
client_ t - Implement this structure to provide handler implementations.
- _cef_
command_ handler_ t - Implement this structure to handle events related to commands. The functions of this structure will be called on the UI thread.
- _cef_
command_ line_ t - Structure used to create and/or parse command line arguments. Arguments with “–”, “-” and, on Windows, “/” prefixes are considered switches. Switches will always precede any arguments without switch prefixes. Switches can optionally have a value specified using the “=” delimiter (e.g. “-switch=value”). An argument of “–” will terminate switch parsing with all subsequent tokens, regardless of prefix, being interpreted as non-switch arguments. Switch names should be lowercase ASCII and will be converted to such if necessary. Switch values will retain the original case and UTF8 encoding. This structure can be used before cef_initialize() is called.
- _cef_
completion_ callback_ t - Generic callback structure used for asynchronous completion.
- _cef_
composition_ underline_ t - Structure representing IME composition underline information. This is a thin wrapper around Blink’s WebCompositionUnderline class and should be kept in sync with that.
- _cef_
context_ menu_ handler_ t - Implement this structure to handle context menu events. The functions of this structure will be called on the UI thread.
- _cef_
context_ menu_ params_ t - Provides information about the context menu state. The functions of this structure can only be accessed on browser process the UI thread.
- _cef_
cookie_ access_ filter_ t - Implement this structure to filter cookies that may be sent or received from resource requests. The functions of this structure will be called on the IO thread unless otherwise indicated.
- _cef_
cookie_ manager_ t - Structure used for managing cookies. The functions of this structure may be called on any thread unless otherwise indicated.
- _cef_
cookie_ t - Cookie information.
- _cef_
cookie_ visitor_ t - Structure to implement for visiting cookie values. The functions of this structure will always be called on the UI thread.
- _cef_
cursor_ info_ t - Structure representing cursor information. |buffer| will be |size.width|*|size.height|*4 bytes in size and represents a BGRA image with an upper-left origin.
- _cef_
delete_ cookies_ callback_ t - Structure to implement to be notified of asynchronous completion via cef_cookie_manager_t::delete_cookies().
- _cef_
dev_ tools_ message_ observer_ t - Callback structure for cef_browser_host_t::AddDevToolsMessageObserver. The functions of this structure will be called on the browser process UI thread.
- _cef_
dialog_ handler_ t - Implement this structure to handle dialog events. The functions of this structure will be called on the browser process UI thread.
- _cef_
dictionary_ value_ t - Structure representing a dictionary value. Can be used on any process and thread.
- _cef_
display_ handler_ t - Implement this structure to handle events related to browser display state. The functions of this structure will be called on the UI thread.
- _cef_
display_ t - This structure typically, but not always, corresponds to a physical display connected to the system. A fake Display may exist on a headless system, or a Display may correspond to a remote, virtual display. All size and position values are in density independent pixel (DIP) coordinates unless otherwise indicated. Methods must be called on the browser process UI thread unless otherwise indicated.
- _cef_
domdocument_ t - Structure used to represent a DOM document. The functions of this structure should only be called on the render process main thread thread.
- _cef_
domnode_ t - Structure used to represent a DOM node. The functions of this structure should only be called on the render process main thread.
- _cef_
domvisitor_ t - Structure to implement for visiting the DOM. The functions of this structure will be called on the render process main thread.
- _cef_
download_ handler_ t - Structure used to handle file downloads. The functions of this structure will called on the browser process UI thread.
- _cef_
download_ image_ callback_ t - Callback structure for cef_browser_host_t::DownloadImage. The functions of this structure will be called on the browser process UI thread.
- _cef_
download_ item_ callback_ t - Callback structure used to asynchronously cancel a download.
- _cef_
download_ item_ t - Structure used to represent a download item.
- _cef_
drag_ data_ t - Structure used to represent drag data. The functions of this structure may be called on any thread.
- _cef_
drag_ handler_ t - Implement this structure to handle events related to dragging. The functions of this structure will be called on the UI thread.
- _cef_
draggable_ region_ t - Structure representing a draggable region.
- _cef_
file_ dialog_ callback_ t - Callback structure for asynchronous continuation of file dialog requests.
- _cef_
fill_ layout_ t - A simple Layout that causes the associated Panel’s one child to be sized to match the bounds of its parent. Methods must be called on the browser process UI thread unless otherwise indicated.
- _cef_
find_ handler_ t - Implement this structure to handle events related to find results. The functions of this structure will be called on the UI thread.
- _cef_
focus_ handler_ t - Implement this structure to handle events related to focus. The functions of this structure will be called on the UI thread.
- _cef_
frame_ handler_ t - Implement this structure to handle events related to cef_frame_t life span. The order of callbacks is:
- _cef_
frame_ t - Structure used to represent a frame in the browser window. When used in the browser process the functions of this structure may be called on any thread unless otherwise indicated in the comments. When used in the render process the functions of this structure may only be called on the main thread.
- _cef_
image_ t - Container for a single image represented at different scale factors. All image representations should be the same size in density independent pixel (DIP) units. For example, if the image at scale factor 1.0 is 100x100 pixels then the image at scale factor 2.0 should be 200x200 pixels – both images will display with a DIP size of 100x100 units. The functions of this structure can be called on any browser process thread.
- _cef_
insets_ t - Structure representing insets.
- _cef_
jsdialog_ callback_ t - Callback structure used for asynchronous continuation of JavaScript dialog requests.
- _cef_
jsdialog_ handler_ t - Implement this structure to handle events related to JavaScript dialogs. The functions of this structure will be called on the UI thread.
- _cef_
key_ event_ t - Structure representing keyboard event information.
- _cef_
keyboard_ handler_ t - Implement this structure to handle events related to keyboard input. The functions of this structure will be called on the UI thread.
- _cef_
label_ button_ t - LabelButton is a button with optional text and/or icon. Methods must be called on the browser process UI thread unless otherwise indicated.
- _cef_
layout_ t - A Layout handles the sizing of the children of a Panel according to implementation-specific heuristics. Methods must be called on the browser process UI thread unless otherwise indicated.
- _cef_
life_ span_ handler_ t - Implement this structure to handle events related to browser life span. The functions of this structure will be called on the UI thread unless otherwise indicated.
- _cef_
linux_ window_ properties_ t - Linux window properties, such as X11’s WM_CLASS or Wayland’s app_id. Those are passed to CefWindowDelegate, so the client can set them for the CefWindow’s top-level. Thus, allowing window managers to correctly display the application’s information (e.g., icons).
- _cef_
list_ value_ t - Structure representing a list value. Can be used on any process and thread.
- _cef_
load_ handler_ t - Implement this structure to handle events related to browser load status. The functions of this structure will be called on the browser process UI thread or render process main thread (TID_RENDERER).
- _cef_
main_ args_ t - Structure representing CefExecuteProcess arguments.
- _cef_
media_ access_ callback_ t - Callback structure used for asynchronous continuation of media access permission requests.
- _cef_
media_ observer_ t - Implemented by the client to observe MediaRouter events and registered via cef_media_router_t::AddObserver. The functions of this structure will be called on the browser process UI thread.
- _cef_
media_ route_ create_ callback_ t - Callback structure for cef_media_router_t::CreateRoute. The functions of this structure will be called on the browser process UI thread.
- _cef_
media_ route_ t - Represents the route between a media source and sink. Instances of this object are created via cef_media_router_t::CreateRoute and retrieved via cef_media_observer_t::OnRoutes. Contains the status and metadata of a routing operation. The functions of this structure may be called on any browser process thread unless otherwise indicated.
- _cef_
media_ router_ t - Supports discovery of and communication with media devices on the local network via the Cast and DIAL protocols. The functions of this structure may be called on any browser process thread unless otherwise indicated.
- _cef_
media_ sink_ device_ info_ callback_ t - Callback structure for cef_media_sink_t::GetDeviceInfo. The functions of this structure will be called on the browser process UI thread.
- _cef_
media_ sink_ device_ info_ t - Device information for a MediaSink object.
- _cef_
media_ sink_ t - Represents a sink to which media can be routed. Instances of this object are retrieved via cef_media_observer_t::OnSinks. The functions of this structure may be called on any browser process thread unless otherwise indicated.
- _cef_
media_ source_ t - Represents a source from which media can be routed. Instances of this object are retrieved via cef_media_router_t::GetSource. The functions of this structure may be called on any browser process thread unless otherwise indicated.
- _cef_
menu_ button_ delegate_ t - Implement this structure to handle MenuButton events. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- _cef_
menu_ button_ pressed_ lock_ t - MenuButton pressed lock is released when this object is destroyed.
- _cef_
menu_ button_ t - MenuButton is a button with optional text, icon and/or menu marker that shows a menu when clicked with the left mouse button. All size and position values are in density independent pixels (DIP) unless otherwise indicated. Methods must be called on the browser process UI thread unless otherwise indicated.
- _cef_
menu_ model_ delegate_ t - Implement this structure to handle menu model events. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- _cef_
menu_ model_ t - Supports creation and modification of menus. See cef_menu_id_t for the command ids that have default implementations. All user-defined command ids should be between MENU_ID_USER_FIRST and MENU_ID_USER_LAST. The functions of this structure can only be accessed on the browser process the UI thread.
- _cef_
mouse_ event_ t - Structure representing mouse event information.
- _cef_
navigation_ entry_ t - Structure used to represent an entry in navigation history.
- _cef_
navigation_ entry_ visitor_ t - Callback structure for cef_browser_host_t::GetNavigationEntries. The functions of this structure will be called on the browser process UI thread.
- _cef_
overlay_ controller_ t - Controller for an overlay that contains a contents View added via cef_window_t::AddOverlayView. Methods exposed by this controller should be called in preference to functions of the same name exposed by the contents View unless otherwise indicated. Methods must be called on the browser process UI thread unless otherwise indicated.
- _cef_
panel_ delegate_ t - Implement this structure to handle Panel events. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- _cef_
panel_ t - A Panel is a container in the views hierarchy that can contain other Views as children. Methods must be called on the browser process UI thread unless otherwise indicated.
- _cef_
pdf_ print_ callback_ t - Callback structure for cef_browser_host_t::PrintToPDF. The functions of this structure will be called on the browser process UI thread.
- _cef_
pdf_ print_ settings_ t - Structure representing PDF print settings. These values match the parameters supported by the DevTools Page.printToPDF function. See https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-printToPDF
- _cef_
permission_ handler_ t - Implement this structure to handle events related to permission requests. The functions of this structure will be called on the browser process UI thread.
- _cef_
permission_ prompt_ callback_ t - Callback structure used for asynchronous continuation of permission prompts.
- _cef_
point_ t - Structure representing a point.
- _cef_
popup_ features_ t - Popup window features.
- _cef_
post_ data_ element_ t - Structure used to represent a single element in the request post data. The functions of this structure may be called on any thread.
- _cef_
post_ data_ t - Structure used to represent post data for a web request. The functions of this structure may be called on any thread.
- _cef_
preference_ manager_ t - Manage access to preferences. Many built-in preferences are registered by Chromium. Custom preferences can be registered in cef_browser_process_handler_t::OnRegisterCustomPreferences.
- _cef_
preference_ observer_ t - Implemented by the client to observe preference changes and registered via cef_preference_manager_t::AddPreferenceObserver. The functions of this structure will be called on the browser process UI thread.
- _cef_
preference_ registrar_ t - Structure that manages custom preference registrations.
- _cef_
print_ dialog_ callback_ t - Callback structure for asynchronous continuation of print dialog requests.
- _cef_
print_ handler_ t - Implement this structure to handle printing on Linux. Each browser will have only one print job in progress at a time. The functions of this structure will be called on the browser process UI thread.
- _cef_
print_ job_ callback_ t - Callback structure for asynchronous continuation of print job requests.
- _cef_
print_ settings_ t - Structure representing print settings.
- _cef_
process_ message_ t - Structure representing a message. Can be used on any process and thread.
- _cef_
range_ t - Structure representing a range.
- _cef_
read_ handler_ t - Structure the client can implement to provide a custom stream reader. The functions of this structure may be called on any thread.
- _cef_
rect_ t - Structure representing a rectangle.
- _cef_
registration_ t - Generic callback structure used for managing the lifespan of a registration.
- _cef_
render_ handler_ t - Implement this structure to handle events when window rendering is disabled. The functions of this structure will be called on the UI thread.
- _cef_
render_ process_ handler_ t - Structure used to implement render process callbacks. The functions of this structure will be called on the render process main thread (TID_RENDERER) unless otherwise indicated.
- _cef_
request_ context_ handler_ t - Implement this structure to provide handler implementations. The handler instance will not be released until all objects related to the context have been destroyed.
- _cef_
request_ context_ settings_ t - Request context initialization settings. Specify NULL or 0 to get the recommended default values.
- _cef_
request_ context_ t - A request context provides request handling for a set of related browser or URL request objects. A request context can be specified when creating a new browser via the cef_browser_host_t static factory functions or when creating a new URL request via the cef_urlrequest_t static factory functions. Browser objects with different request contexts will never be hosted in the same render process. Browser objects with the same request context may or may not be hosted in the same render process depending on the process model. Browser objects created indirectly via the JavaScript window.open function or targeted links will share the same render process and the same request context as the source browser. When running in single-process mode there is only a single render process (the main process) and so all browsers created in single-process mode will share the same request context. This will be the first request context passed into a cef_browser_host_t static factory function and all other request context objects will be ignored.
- _cef_
request_ handler_ t - Implement this structure to handle events related to browser requests. The functions of this structure will be called on the thread indicated.
- _cef_
request_ t - Structure used to represent a web request. The functions of this structure may be called on any thread.
- _cef_
resolve_ callback_ t - Callback structure for cef_request_context_t::ResolveHost.
- _cef_
resource_ bundle_ handler_ t - Structure used to implement a custom resource bundle structure. See CefSettings for additional options related to resource bundle loading. The functions of this structure may be called on multiple threads.
- _cef_
resource_ handler_ t - Structure used to implement a custom request handler structure. The functions of this structure will be called on the IO thread unless otherwise indicated.
- _cef_
resource_ read_ callback_ t - Callback for asynchronous continuation of cef_resource_handler_t::read().
- _cef_
resource_ request_ handler_ t - Implement this structure to handle events related to browser requests. The functions of this structure will be called on the IO thread unless otherwise indicated.
- _cef_
resource_ skip_ callback_ t - Callback for asynchronous continuation of cef_resource_handler_t::skip().
- _cef_
response_ filter_ t - Implement this structure to filter resource response content. The functions of this structure will be called on the browser process IO thread.
- _cef_
response_ t - Structure used to represent a web response. The functions of this structure may be called on any thread.
- _cef_
run_ context_ menu_ callback_ t - Callback structure used for continuation of custom context menu display.
- _cef_
run_ file_ dialog_ callback_ t - Callback structure for cef_browser_host_t::RunFileDialog. The functions of this structure will be called on the browser process UI thread.
- _cef_
run_ quick_ menu_ callback_ t - Callback structure used for continuation of custom quick menu display.
- _cef_
scheme_ handler_ factory_ t - Structure that creates cef_resource_handler_t instances for handling scheme requests. The functions of this structure will always be called on the IO thread.
- _cef_
scheme_ registrar_ t - Structure that manages custom scheme registrations.
- _cef_
screen_ info_ t - Screen information used when window rendering is disabled. This structure is passed as a parameter to CefRenderHandler::GetScreenInfo and should be filled in by the client.
- _cef_
scroll_ view_ t - A ScrollView will show horizontal and/or vertical scrollbars when necessary based on the size of the attached content view. Methods must be called on the browser process UI thread unless otherwise indicated.
- _cef_
select_ client_ certificate_ callback_ t - Callback structure used to select a client certificate for authentication.
- _cef_
set_ cookie_ callback_ t - Structure to implement to be notified of asynchronous completion via cef_cookie_manager_t::set_cookie().
- _cef_
setting_ observer_ t - Implemented by the client to observe content and website setting changes and registered via cef_request_context_t::AddSettingObserver. The functions of this structure will be called on the browser process UI thread.
- _cef_
settings_ t - Initialization settings. Specify NULL or 0 to get the recommended default values. Many of these and other settings can also configured using command- line switches.
- _cef_
shared_ memory_ region_ t - Structure that wraps platform-dependent share memory region mapping.
- _cef_
size_ t - Structure representing a size.
- _cef_
sslinfo_ t - Structure representing SSL information.
- _cef_
sslstatus_ t - Structure representing the SSL information for a navigation entry.
- _cef_
stream_ reader_ t - Structure used to read data from a stream. The functions of this structure may be called on any thread.
- _cef_
stream_ writer_ t - Structure used to write data to a stream. The functions of this structure may be called on any thread.
- _cef_
string_ list_ t - _cef_
string_ map_ t - _cef_
string_ multimap_ t - _cef_
string_ utf8_ t - _cef_
string_ utf16_ t - _cef_
string_ visitor_ t - Implement this structure to receive string values asynchronously.
- _cef_
string_ wide_ t - CEF string type definitions. Whomever allocates |str| is responsible for providing an appropriate |dtor| implementation that will free the string in the same memory space. When reusing an existing string structure make sure to call |dtor| for the old value before assigning new |str| and |dtor| values. Static strings will have a NULL |dtor| value. Using the below functions if you want this managed for you.
- _cef_
task_ info_ t - Structure representing task information provided by CefTaskManager.
- _cef_
task_ runner_ t - Structure that asynchronously executes tasks on the associated thread. It is safe to call the functions of this structure on any thread.
- _cef_
task_ t - Implement this structure for asynchronous task execution. If the task is posted successfully and if the associated message loop is still running then the execute() function will be called on the target thread. If the task fails to post then the task object may be destroyed on the source thread instead of the target thread. For this reason be cautious when performing work in the task object destructor.
- _cef_
textfield_ delegate_ t - Implement this structure to handle Textfield events. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- _cef_
textfield_ t - A Textfield supports editing of text. This control is custom rendered with no platform-specific code. Methods must be called on the browser process UI thread unless otherwise indicated.
- _cef_
time_ t - Time information. Values should always be in UTC.
- _cef_
touch_ event_ t - Structure representing touch event information.
- _cef_
touch_ handle_ state_ t - _cef_
unresponsive_ process_ callback_ t - Callback structure for asynchronous handling of an unresponsive process.
- _cef_
urlparts_ t - URL component parts.
- _cef_
urlrequest_ client_ t - Structure that should be implemented by the cef_urlrequest_t client. The functions of this structure will be called on the same thread that created the request unless otherwise documented.
- _cef_
urlrequest_ t - Structure used to make a URL request. URL requests are not associated with a browser instance so no cef_client_t callbacks will be executed. URL requests can be created on any valid CEF thread in either the browser or render process. Once created the functions of the URL request object must be accessed on the same thread that created it.
- _cef_
v8_ accessor_ t - Structure that should be implemented to handle V8 accessor calls. Accessor identifiers are registered by calling cef_v8_value_t::set_value(). The functions of this structure will be called on the thread associated with the V8 accessor.
- _cef_
v8_ array_ buffer_ release_ callback_ t - Callback structure that is passed to cef_v8_value_t::CreateArrayBuffer.
- _cef_
v8_ context_ t - Structure representing a V8 context handle. V8 handles can only be accessed from the thread on which they are created. Valid threads for creating a V8 handle include the render process main thread (TID_RENDERER) and WebWorker threads. A task runner for posting tasks on the associated thread can be retrieved via the cef_v8_context_t::get_task_runner() function.
- _cef_
v8_ exception_ t - Structure representing a V8 exception. The functions of this structure may be called on any render process thread.
- _cef_
v8_ handler_ t - Structure that should be implemented to handle V8 function calls. The functions of this structure will be called on the thread associated with the V8 function.
- _cef_
v8_ interceptor_ t - Structure that should be implemented to handle V8 interceptor calls. The functions of this structure will be called on the thread associated with the V8 interceptor. Interceptor’s named property handlers (with first argument of type CefString) are called when object is indexed by string. Indexed property handlers (with first argument of type int) are called when object is indexed by integer.
- _cef_
v8_ stack_ frame_ t - Structure representing a V8 stack frame handle. V8 handles can only be accessed from the thread on which they are created. Valid threads for creating a V8 handle include the render process main thread (TID_RENDERER) and WebWorker threads. A task runner for posting tasks on the associated thread can be retrieved via the cef_v8_context_t::get_task_runner() function.
- _cef_
v8_ stack_ trace_ t - Structure representing a V8 stack trace handle. V8 handles can only be accessed from the thread on which they are created. Valid threads for creating a V8 handle include the render process main thread (TID_RENDERER) and WebWorker threads. A task runner for posting tasks on the associated thread can be retrieved via the cef_v8_context_t::get_task_runner() function.
- _cef_
v8_ value_ t - Structure representing a V8 value handle. V8 handles can only be accessed from the thread on which they are created. Valid threads for creating a V8 handle include the render process main thread (TID_RENDERER) and WebWorker threads. A task runner for posting tasks on the associated thread can be retrieved via the cef_v8_context_t::get_task_runner() function.
- _cef_
value_ t - Structure that wraps other data value types. Complex types (binary, dictionary and list) will be referenced but not owned by this object. Can be used on any process and thread.
- _cef_
view_ delegate_ t - Implement this structure to handle view events. All size and position values are in density independent pixels (DIP) unless otherwise indicated. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- _cef_
view_ t - A View is a rectangle within the views View hierarchy. It is the base structure for all Views. All size and position values are in density independent pixels (DIP) unless otherwise indicated. Methods must be called on the browser process UI thread unless otherwise indicated.
- _cef_
window_ delegate_ t - Implement this structure to handle window events. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- _cef_
window_ info_ t - Class representing window information.
- _cef_
window_ t - A Window is a top-level Window/widget in the Views hierarchy. By default it will have a non-client area with title bar, icon and buttons that supports moving and resizing. All size and position values are in density independent pixels (DIP) unless otherwise indicated. Methods must be called on the browser process UI thread unless otherwise indicated.
- _cef_
write_ handler_ t - Structure the client can implement to provide a custom stream writer. The functions of this structure may be called on any thread.
- _cef_
x509_ cert_ principal_ t - Structure representing the issuer or subject field of an X.509 certificate.
- _cef_
x509_ certificate_ t - Structure representing a X.509 certificate.
- cef_
drag_ operations_ mask_ t - “Verb” of a drag-and-drop operation as negotiated between the source and destination. These constants match their equivalents in WebCore’s DragActions.h and should not be renumbered.
Enums§
- cef_
alpha_ type_ t - Describes how to interpret the alpha component of a pixel.
- cef_
axis_ alignment_ t - Specifies where along the axis the CefBoxLayout child views should be laid out. Should be kept in sync with Chromium’s views::LayoutAlignment type.
- cef_
button_ state_ t - Specifies the button display state.
- cef_
cert_ status_ t - Supported certificate status code values. See net\cert\cert_status_flags.h for more information. CERT_STATUS_NONE is new in CEF because we use an enum while cert_status_flags.h uses a typedef and static const variables.
- cef_
channel_ layout_ t - Enumerates the various representations of the ordering of audio channels. Must be kept synchronized with media::ChannelLayout from Chromium. See media\base\channel_layout.h
- cef_
chrome_ page_ action_ icon_ type_ t - Chrome page action icon types. Should be kept in sync with Chromium’s PageActionIconType type.
- cef_
chrome_ toolbar_ button_ type_ t - Chrome toolbar button types. Should be kept in sync with CEF’s internal ToolbarButtonType type.
- cef_
chrome_ toolbar_ type_ t - Chrome toolbar types.
- cef_
color_ model_ t - Print job color mode values.
- cef_
color_ type_ t - Describes how to interpret the components of a pixel.
- cef_
color_ variant_ t - Specifies the color variants supported by CefRequestContext::SetChromeThemeColor.
- cef_
com_ init_ mode_ t - Windows COM initialization mode. Specifies how COM will be initialized for a new thread.
- cef_
composition_ underline_ style_ t - Composition underline style.
- cef_
content_ setting_ types_ t - Supported content setting types. Some types are platform-specific or only supported with Chrome style. Should be kept in sync with Chromium’s ContentSettingsType type.
- cef_
content_ setting_ values_ t - Supported content setting values. Should be kept in sync with Chromium’s ContentSetting type.
- cef_
context_ menu_ edit_ state_ flags_ t - Supported context menu edit state bit flags. These constants match their equivalents in Chromium’s ContextMenuDataEditFlags and should not be renumbered.
- cef_
context_ menu_ media_ state_ flags_ t - Supported context menu media state bit flags. These constants match their equivalents in Chromium’s ContextMenuData::MediaFlags and should not be renumbered.
- cef_
context_ menu_ media_ type_ t - Supported context menu media types. These constants match their equivalents in Chromium’s ContextMenuDataMediaType and should not be renumbered.
- cef_
context_ menu_ type_ flags_ t - Supported context menu type flags.
- cef_
cookie_ priority_ t - Cookie priority values.
- cef_
cookie_ same_ site_ t - Cookie same site values.
- cef_
cursor_ type_ t - Cursor type values.
- cef_
docking_ mode_ t - Docking modes supported by CefWindow::AddOverlay.
- cef_
dom_ document_ type_ t - DOM document types.
- cef_
dom_ event_ category_ t - DOM event category flags.
- cef_
dom_ event_ phase_ t - DOM event processing phases.
- cef_
dom_ form_ control_ type_ t - DOM form control types. Should be kept in sync with Chromium’s blink::mojom::FormControlType type.
- cef_
dom_ node_ type_ t - DOM node types.
- cef_
download_ interrupt_ reason_ t - Download interrupt reasons. Should be kept in sync with Chromium’s download::DownloadInterruptReason type.
- cef_
duplex_ mode_ t - Print job duplex mode values.
- cef_
errorcode_ t - Supported error code values. For the complete list of error values see “include/base/internal/cef_net_error_list.h”.
- cef_
event_ flags_ t - Supported event bit flags.
- cef_
file_ dialog_ mode_ t - Supported file dialog modes.
- cef_
focus_ source_ t - Focus sources.
- cef_
gesture_ command_ t - Specifies the gesture commands.
- cef_
horizontal_ alignment_ t - Specifies the horizontal text alignment mode.
- cef_
jsdialog_ type_ t - Supported JavaScript dialog types.
- cef_
json_ parser_ options_ t - Options that can be passed to CefParseJSON.
- cef_
json_ writer_ options_ t - Options that can be passed to CefWriteJSON.
- cef_
key_ event_ type_ t - Key event types.
- cef_
log_ items_ t - Log items prepended to each log line.
- cef_
log_ severity_ t - Log severity levels.
- cef_
media_ access_ permission_ types_ t - Media access permissions used by OnRequestMediaAccessPermission.
- cef_
media_ route_ connection_ state_ t - Connection state for a MediaRoute object. Should be kept in sync with Chromium’s blink::mojom::PresentationConnectionState type.
- cef_
media_ route_ create_ result_ t - Result codes for CefMediaRouter::CreateRoute. Should be kept in sync with Chromium’s media_router::mojom::RouteRequestResultCode type.
- cef_
media_ sink_ icon_ type_ t - Icon types for a MediaSink object. Should be kept in sync with Chromium’s media_router::SinkIconType type.
- cef_
menu_ anchor_ position_ t - Specifies how a menu will be anchored for non-RTL languages. The opposite position will be used for RTL languages.
- cef_
menu_ color_ type_ t - Supported color types for menu items.
- cef_
menu_ id_ t - Supported menu IDs. Non-English translations can be provided for the IDS_MENU_* strings in CefResourceBundleHandler::GetLocalizedString().
- cef_
menu_ item_ type_ t - Supported menu item types.
- cef_
message_ loop_ type_ t - Message loop types. Indicates the set of asynchronous events that a message loop can process.
- cef_
mouse_ button_ type_ t - Mouse button types.
- cef_
navigation_ type_ t - Navigation types.
- cef_
paint_ element_ type_ t - Paint element types.
- cef_
path_ key_ t - Path key values.
- cef_
pdf_ print_ margin_ type_ t - Margin type for PDF printing.
- cef_
permission_ request_ result_ t - Permission request results.
- cef_
permission_ request_ types_ t - Permission types used with OnShowPermissionPrompt. Some types are platform-specific or only supported with Chrome style. Should be kept in sync with Chromium’s permissions::RequestType type.
- cef_
pointer_ type_ t - The device type that caused the event.
- cef_
postdataelement_ type_ t - Post data elements may represent either bytes or files.
- cef_
preferences_ type_ t - Preferences type passed to CefBrowserProcessHandler::OnRegisterCustomPreferences.
- cef_
process_ id_ t - Existing process IDs.
- cef_
quick_ menu_ edit_ state_ flags_ t - Supported quick menu state bit flags.
- cef_
referrer_ policy_ t - Policy for how the Referrer HTTP header value will be sent during
navigation. If the
--no-referrers
command-line flag is specified then the policy value will be ignored and the Referrer value will never be sent. Must be kept synchronized with net::URLRequest::ReferrerPolicy from Chromium. - cef_
resource_ type_ t - Resource type for a request. These constants match their equivalents in Chromium’s ResourceType and should not be renumbered.
- cef_
response_ filter_ status_ t - Return values for CefResponseFilter::Filter().
- cef_
resultcode_ t - Process result codes. This is not a comprehensive list, as result codes might also include platform-specific crash values (Posix signal or Windows hardware exception), or internal-only implementation values.
- cef_
return_ value_ t - Return value types.
- cef_
runtime_ style_ t - CEF supports both a Chrome runtime style (based on the Chrome UI layer) and an Alloy runtime style (based on the Chromium content layer). Chrome style provides the full Chrome UI and browser functionality whereas Alloy style provides less default browser functionality but adds additional client callbacks and support for windowless (off-screen) rendering. The style type is individually configured for each window/browser at creation time and different styles can be mixed during runtime. For additional comparative details on runtime styles see https://bitbucket.org/chromiumembedded/cef/wiki/Architecture.md#markdown-header-cef3
- cef_
scale_ factor_ t - Supported UI scale factors for the platform. SCALE_FACTOR_NONE is used for density independent resources such as string, html/js files or an image that can be used for any scale factors (such as wallpapers).
- cef_
scheme_ options_ t - Configuration options for registering a custom scheme. These values are used when calling AddCustomScheme.
- cef_
show_ state_ t - Show states supported by CefWindowDelegate::GetInitialShowState.
- cef_
ssl_ content_ status_ t - Supported SSL content status flags. See content/public/common/ssl_status.h for more information.
- cef_
ssl_ version_ t - Supported SSL version values. See net/ssl/ssl_connection_status_flags.h for more information.
- cef_
state_ t - Represents the state of a setting.
- cef_
storage_ type_ t - Storage types.
- cef_
task_ type_ t - Specifies the task type variants supported by CefTaskManager. Should be kept in sync with Chromium’s task_manager::Task::Type type.
- cef_
termination_ status_ t - Process termination status values.
- cef_
test_ cert_ type_ t - Certificate types supported by CefTestServer::CreateAndStart. The matching certificate file must exist in the “net/data/ssl/certificates” directory. See CefSetDataDirectoryForTests() for related configuration.
- cef_
text_ field_ commands_ t - Represents commands available to TextField. Should be kept in sync with Chromium’s views::TextField::MenuCommands type.
- cef_
text_ input_ mode_ t - Input mode of a virtual keyboard. These constants match their equivalents in Chromium’s text_input_mode.h and should not be renumbered. See https://html.spec.whatwg.org/#input-modalities:-the-inputmode-attribute
- cef_
text_ style_ t - Text style types. Should be kepy in sync with gfx::TextStyle.
- cef_
thread_ id_ t - Existing thread IDs.
- cef_
thread_ priority_ t - Thread priority values listed in increasing order of importance.
- cef_
touch_ event_ type_ t - Touch points states types.
- cef_
touch_ handle_ state_ flags_ t - Values indicating what state of the touch handle is set.
- cef_
transition_ type_ t - Transition type for a request. Made up of one source value and 0 or more qualifiers.
- cef_
uri_ unescape_ rule_ t - URI unescape rules passed to CefURIDecode().
- cef_
urlrequest_ flags_ t - Flags used to customize the behavior of CefURLRequest.
- cef_
urlrequest_ status_ t - Flags that represent CefURLRequest status.
- cef_
v8_ propertyattribute_ t - V8 property attribute values.
- cef_
value_ type_ t - Supported value types.
- cef_
window_ open_ disposition_ t - The manner in which a link click should be opened. These constants match their equivalents in Chromium’s window_open_disposition.h and should not be renumbered.
- cef_
xml_ encoding_ type_ t - Supported XML encoding types. The parser supports ASCII, ISO-8859-1, and UTF16 (LE and BE) by default. All other types must be translated to UTF8 before being passed to the parser. If a BOM is detected and the correct decoder is available then that decoder will be used automatically.
- cef_
xml_ node_ type_ t - XML node types.
- cef_
zoom_ command_ t - Specifies the zoom commands supported by CefBrowserHost::Zoom.
Constants§
- CEF_
API_ VERSION - CEF_
API_ VERSION_ 13300 - CEF_
API_ VERSION_ 13301 - CEF_
API_ VERSION_ 13302 - CEF_
API_ VERSION_ 13303 - CEF_
API_ VERSION_ 13304 - CEF_
API_ VERSION_ 13400 - CEF_
API_ VERSION_ 13401 - CEF_
API_ VERSION_ 999998 - CEF_
API_ VERSION_ 999999 - CEF_
API_ VERSION_ EXPERIMENTAL - CEF_
API_ VERSION_ LAST - CEF_
API_ VERSION_ MIN - CEF_
API_ VERSION_ NEXT
Functions§
- cef_
api_ ⚠hash - Configures the CEF API version and returns API hashes for the libcef library. The returned string is owned by the library and should not be freed. The |version| parameter should be CEF_API_VERSION and any changes to this value will be ignored after the first call to this method. The |entry| parameter describes which hash value will be returned:
- cef_
api_ ⚠version - Returns the CEF API version that was configured by the first call to cef_api_hash().
- cef_
basetime_ ⚠now - Retrieve the current system time.
- cef_
binary_ ⚠value_ create - Creates a new object that is not owned by any other object. The specified |data| will be copied.
- cef_
browser_ ⚠host_ create_ browser - Create a new browser using the window parameters specified by |windowInfo|. All values will be copied internally and the actual window (if any) will be created on the UI thread. If |request_context| is NULL the global request context will be used. This function can be called on any browser process thread and will not block. The optional |extra_info| parameter provides an opportunity to specify extra information specific to the created browser that will be passed to cef_render_process_handler_t::on_browser_created() in the render process.
- cef_
browser_ ⚠host_ create_ browser_ sync - Create a new browser using the window parameters specified by |windowInfo|. If |request_context| is NULL the global request context will be used. This function can only be called on the browser process UI thread. The optional |extra_info| parameter provides an opportunity to specify extra information specific to the created browser that will be passed to cef_render_process_handler_t::on_browser_created() in the render process.
- cef_
browser_ ⚠host_ get_ browser_ by_ identifier - Returns the browser (if any) with the specified identifier.
- cef_
browser_ ⚠view_ create - Create a new BrowserView. The underlying cef_browser_t will not be created until this view is added to the views hierarchy. The optional |extra_info| parameter provides an opportunity to specify extra information specific to the created browser that will be passed to cef_render_process_handler_t::on_browser_created() in the render process.
- cef_
browser_ ⚠view_ get_ for_ browser - Returns the BrowserView associated with |browser|.
- cef_
clear_ ⚠scheme_ handler_ factories - Clear all scheme handler factories registered with the global request context. Returns false (0) on error. This function may be called on any thread in the browser process. Using this function is equivalent to calling cef_request_context_t::cef_request_context_get_global_context()->clear_schem e_handler_factories().
- cef_
command_ ⚠line_ create - Create a new cef_command_line_t instance.
- cef_
command_ ⚠line_ get_ global - Returns the singleton global cef_command_line_t object. The returned object will be read-only.
- cef_
cookie_ ⚠manager_ get_ global_ manager - Returns the global cookie manager. By default data will be stored at cef_settings_t.cache_path if specified or in memory otherwise. If |callback| is non-NULL it will be executed asnychronously on the UI thread after the manager’s storage has been initialized. Using this function is equivalent to calling cef_request_context_t::cef_request_context_get_global_context()->Get DefaultCookieManager().
- cef_
currently_ ⚠on - Returns true (1) if called on the specified thread. Equivalent to using cef_task_runner_t::GetForThread(threadId)->belongs_to_current_thread().
- cef_
dictionary_ ⚠value_ create - Creates a new object that is not owned by any other object.
- cef_
display_ ⚠convert_ screen_ point_ from_ pixels - Convert |point| from pixel screen coordinates to DIP screen coordinates. This function is only used on Windows.
- cef_
display_ ⚠convert_ screen_ point_ to_ pixels - Convert |point| from DIP screen coordinates to pixel screen coordinates. This function is only used on Windows.
- cef_
display_ ⚠convert_ screen_ rect_ from_ pixels - Convert |rect| from pixel screen coordinates to DIP screen coordinates. This function is only used on Windows.
- cef_
display_ ⚠convert_ screen_ rect_ to_ pixels - Convert |rect| from DIP screen coordinates to pixel screen coordinates. This function is only used on Windows.
- cef_
display_ ⚠get_ alls - Returns all Displays. Mirrored displays are excluded; this function is intended to return distinct, usable displays.
- cef_
display_ ⚠get_ count - Returns the total number of Displays. Mirrored displays are excluded; this function is intended to return the number of distinct, usable displays.
- cef_
display_ ⚠get_ matching_ bounds - Returns the Display that most closely intersects |bounds|. Set |input_pixel_coords| to true (1) if |bounds| is in pixel screen coordinates instead of DIP screen coordinates.
- cef_
display_ ⚠get_ nearest_ point - Returns the Display nearest |point|. Set |input_pixel_coords| to true (1) if |point| is in pixel screen coordinates instead of DIP screen coordinates.
- cef_
display_ ⚠get_ primary - Returns the primary Display.
- cef_
do_ ⚠message_ loop_ work - Perform a single iteration of CEF message loop processing. This function is provided for cases where the CEF message loop must be integrated into an existing application message loop. Use of this function is not recommended for most users; use either the cef_run_message_loop() function or cef_settings_t.multi_threaded_message_loop if possible. When using this function care must be taken to balance performance against excessive CPU usage. It is recommended to enable the cef_settings_t.external_message_pump option when using this function so that cef_browser_process_handler_t::on_schedule_message_pump_work() callbacks can facilitate the scheduling process. This function should only be called on the main application thread and only if cef_initialize() is called with a cef_settings_t.multi_threaded_message_loop value of false (0). This function will not block.
- cef_
drag_ ⚠data_ create - Create a new cef_drag_data_t object.
- cef_
execute_ ⚠process - This function should be called from the application entry point function to execute a secondary process. It can be used to run secondary processes from the browser client executable (default behavior) or from a separate executable specified by the cef_settings_t.browser_subprocess_path value. If called for the browser process (identified by no “type” command-line value) it will return immediately with a value of -1. If called for a recognized secondary process it will block until the process should exit and then return the process exit code. The |application| parameter may be NULL. The |windows_sandbox_info| parameter is only used on Windows and may be NULL (see cef_sandbox_win.h for details).
- cef_
get_ ⚠exit_ code - This function can optionally be called on the main application thread after CefInitialize to retrieve the initialization exit code. When CefInitialize returns true (1) the exit code will be 0 (CEF_RESULT_CODE_NORMAL_EXIT). Otherwise, see cef_resultcode_t for possible exit code values including browser process initialization errors and normal early exit conditions (such as CEF_RESULT_CODE_NORMAL_EXIT_PROCESS_NOTIFIED for process singleton relaunch behavior).
- cef_
get_ ⚠xdisplay - cef_
image_ ⚠create - Create a new cef_image_t. It will initially be NULL. Use the Add*() functions to add representations at different scale factors.
- cef_
initialize ⚠ - This function should be called on the main application thread to initialize the CEF browser process. The |application| parameter may be NULL. Returns true (1) if initialization succeeds. Returns false (0) if initialization fails or if early exit is desired (for example, due to process singleton relaunch behavior). If this function returns false (0) then the application should exit immediately without calling any other CEF functions except, optionally, CefGetErrorCode. The |windows_sandbox_info| parameter is only used on Windows and may be NULL (see cef_sandbox_win.h for details).
- cef_
is_ ⚠cert_ status_ error - Returns true (1) if the certificate status represents an error.
- cef_
label_ ⚠button_ create - Create a new LabelButton. A |delegate| must be provided to handle the button click. |text| will be shown on the LabelButton and used as the default accessible name.
- cef_
list_ ⚠value_ create - Creates a new object that is not owned by any other object.
- cef_
media_ ⚠router_ get_ global - Returns the MediaRouter object associated with the global request context. If |callback| is non-NULL it will be executed asnychronously on the UI thread after the manager’s storage has been initialized. Equivalent to calling cef_request_context_t::cef_request_context_get_global_context()->get _media_router().
- cef_
menu_ ⚠button_ create - Create a new MenuButton. A |delegate| must be provided to call show_menu() when the button is clicked. |text| will be shown on the MenuButton and used as the default accessible name. If |with_frame| is true (1) the button will have a visible frame at all times, center alignment, additional padding and a default minimum size of 70x33 DIP. If |with_frame| is false (0) the button will only have a visible frame on hover/press, left alignment, less padding and no default minimum size.
- cef_
menu_ ⚠model_ create - Create a new MenuModel with the specified |delegate|.
- cef_
panel_ ⚠create - Create a new Panel.
- cef_
post_ ⚠data_ create - Create a new cef_post_data_t object.
- cef_
post_ ⚠data_ element_ create - Create a new cef_post_data_element_t object.
- cef_
post_ ⚠delayed_ task - Post a task for delayed execution on the specified thread. Equivalent to using cef_task_runner_t::GetForThread(threadId)->PostDelayedTask(task, delay_ms).
- cef_
post_ ⚠task - Post a task for execution on the specified thread. Equivalent to using cef_task_runner_t::GetForThread(threadId)->PostTask(task).
- cef_
preference_ ⚠manager_ get_ chrome_ variations_ as_ strings - Returns the current Chrome Variations configuration (combination of field
trials and chrome://flags) as human-readable strings. This is the human-
readable equivalent of the “Active Variations” section of chrome://version.
See https://developer.chrome.com/docs/web-platform/chrome-variations for
background and details. Note that field trial tests are disabled by default
in Official CEF builds (via the
disable_fieldtrial_testing_config=true (1)
GN flag). This function must be called on the browser process UI thread. - cef_
preference_ ⚠manager_ get_ chrome_ variations_ as_ switches - Returns the current Chrome Variations configuration (combination of field
trials and chrome://flags) as equivalent command-line switches
(
--[enable|disable]-features=XXXX
, etc). These switches can be used to apply the same configuration when launching a CEF-based application. See https://developer.chrome.com/docs/web-platform/chrome-variations for background and details. Note that field trial tests are disabled by default in Official CEF builds (via thedisable_fieldtrial_testing_config=true (1)
GN flag). This function must be called on the browser process UI thread. - cef_
preference_ ⚠manager_ get_ global - Returns the global preference manager object.
- cef_
print_ ⚠settings_ create - Create a new cef_print_settings_t object.
- cef_
process_ ⚠message_ create - Create a new cef_process_message_t object with the specified name.
- cef_
quit_ ⚠message_ loop - Quit the CEF message loop that was started by calling cef_run_message_loop(). This function should only be called on the main application thread and only if cef_run_message_loop() was used.
- cef_
register_ ⚠extension - Register a new V8 extension with the specified JavaScript extension code and handler. Functions implemented by the handler are prototyped using the keyword ‘native’. The calling of a native function is restricted to the scope in which the prototype of the native function is defined. This function may only be called on the render process main thread.
- cef_
register_ ⚠scheme_ handler_ factory - Register a scheme handler factory with the global request context. An NULL |domain_name| value for a standard scheme will cause the factory to match all domain names. The |domain_name| value will be ignored for non-standard schemes. If |scheme_name| is a built-in scheme and no handler is returned by |factory| then the built-in scheme handler factory will be called. If |scheme_name| is a custom scheme then you must also implement the cef_app_t::on_register_custom_schemes() function in all processes. This function may be called multiple times to change or remove the factory that matches the specified |scheme_name| and optional |domain_name|. Returns false (0) if an error occurs. This function may be called on any thread in the browser process. Using this function is equivalent to calling cef_reques t_context_t::cef_request_context_get_global_context()->register_scheme_handl er_factory().
- cef_
request_ ⚠context_ cef_ create_ context_ shared - Creates a new context object that shares storage with |other| and uses an optional |handler|.
- cef_
request_ ⚠context_ create_ context - Creates a new context object with the specified |settings| and optional |handler|.
- cef_
request_ ⚠context_ get_ global_ context - Returns the global context object.
- cef_
request_ ⚠create - Create a new cef_request_t object.
- cef_
response_ ⚠create - Create a new cef_response_t object.
- cef_
run_ ⚠message_ loop - Run the CEF message loop. Use this function instead of an application- provided message loop to get the best balance between performance and CPU usage. This function should only be called on the main application thread and only if cef_initialize() is called with a cef_settings_t.multi_threaded_message_loop value of false (0). This function will block until a quit message is received by the system.
- cef_
scroll_ ⚠view_ create - Create a new ScrollView.
- cef_
shutdown ⚠ - This function should be called on the main application thread to shut down the CEF browser process before the application exits. Do not call any other CEF functions after calling this function.
- cef_
stream_ ⚠reader_ create_ for_ data - Create a new cef_stream_reader_t object from data.
- cef_
stream_ ⚠reader_ create_ for_ file - Create a new cef_stream_reader_t object from a file.
- cef_
stream_ ⚠reader_ create_ for_ handler - Create a new cef_stream_reader_t object from a custom handler.
- cef_
stream_ ⚠writer_ create_ for_ file - Create a new cef_stream_writer_t object for a file.
- cef_
stream_ ⚠writer_ create_ for_ handler - Create a new cef_stream_writer_t object for a custom handler.
- cef_
string_ ⚠ascii_ to_ utf16 - cef_
string_ ⚠ascii_ to_ wide - These functions convert an ASCII string, typically a hardcoded constant, to a Wide/UTF16 string. Use instead of the UTF8 conversion routines if you know the string is ASCII.
- cef_
string_ ⚠list_ alloc - Allocate a new string map.
- cef_
string_ ⚠list_ append - Append a new value at the end of the string list.
- cef_
string_ ⚠list_ clear - Clear the string list.
- cef_
string_ ⚠list_ copy - Creates a copy of an existing string list.
- cef_
string_ ⚠list_ free - Free the string list.
- cef_
string_ ⚠list_ size - Return the number of elements in the string list.
- cef_
string_ ⚠list_ value - Retrieve the value at the specified zero-based string list index. Returns true (1) if the value was successfully retrieved.
- cef_
string_ ⚠map_ alloc - Allocate a new string map.
- cef_
string_ ⚠map_ append - Append a new key/value pair at the end of the string map. If the key exists, overwrite the existing value with a new value w/o changing the pair order.
- cef_
string_ ⚠map_ clear - Clear the string map.
- cef_
string_ ⚠map_ find - Return the value assigned to the specified key.
- cef_
string_ ⚠map_ free - Free the string map.
- cef_
string_ ⚠map_ key - Return the key at the specified zero-based string map index.
- cef_
string_ ⚠map_ size - Return the number of elements in the string map.
- cef_
string_ ⚠map_ value - Return the value at the specified zero-based string map index.
- cef_
string_ ⚠multimap_ alloc - Allocate a new string multimap.
- cef_
string_ ⚠multimap_ append - Append a new key/value pair at the end of the string multimap.
- cef_
string_ ⚠multimap_ clear - Clear the string multimap.
- cef_
string_ ⚠multimap_ enumerate - Return the value_index-th value with the specified key.
- cef_
string_ ⚠multimap_ find_ count - Return the number of values with the specified key.
- cef_
string_ ⚠multimap_ free - Free the string multimap.
- cef_
string_ ⚠multimap_ key - Return the key at the specified zero-based string multimap index.
- cef_
string_ ⚠multimap_ size - Return the number of elements in the string multimap.
- cef_
string_ ⚠multimap_ value - Return the value at the specified zero-based string multimap index.
- cef_
string_ ⚠userfree_ utf8_ alloc - cef_
string_ ⚠userfree_ utf8_ free - cef_
string_ ⚠userfree_ utf16_ alloc - cef_
string_ ⚠userfree_ utf16_ free - cef_
string_ ⚠userfree_ wide_ alloc - These functions allocate a new string structure. They must be freed by calling the associated free function.
- cef_
string_ ⚠userfree_ wide_ free - These functions free the string structure allocated by the associated alloc function. Any string contents will first be cleared.
- cef_
string_ ⚠utf8_ clear - cef_
string_ ⚠utf8_ cmp - cef_
string_ ⚠utf8_ set - cef_
string_ ⚠utf8_ to_ utf16 - cef_
string_ ⚠utf8_ to_ wide - cef_
string_ ⚠utf16_ clear - cef_
string_ ⚠utf16_ cmp - cef_
string_ ⚠utf16_ set - cef_
string_ ⚠utf16_ to_ lower - These functions convert utf16 string case using the current ICU locale. This may change the length of the string in some cases.
- cef_
string_ ⚠utf16_ to_ upper - cef_
string_ ⚠utf16_ to_ utf8 - cef_
string_ ⚠utf16_ to_ wide - cef_
string_ ⚠wide_ clear - These functions clear string values. The structure itself is not freed.
- cef_
string_ ⚠wide_ cmp - These functions compare two string values with the same results as strcmp().
- cef_
string_ ⚠wide_ set - These functions set string values. If |copy| is true (1) the value will be copied instead of referenced. It is up to the user to properly manage the lifespan of references.
- cef_
string_ ⚠wide_ to_ utf8 - These functions convert between UTF-8, -16, and -32 strings. They are potentially slow so unnecessary conversions should be avoided. The best possible result will always be written to |output| with the boolean return value indicating whether the conversion is 100% valid.
- cef_
string_ ⚠wide_ to_ utf16 - cef_
task_ ⚠runner_ get_ for_ current_ thread - Returns the task runner for the current thread. Only CEF threads will have task runners. An NULL reference will be returned if this function is called on an invalid thread.
- cef_
task_ ⚠runner_ get_ for_ thread - Returns the task runner for the specified CEF thread.
- cef_
textfield_ ⚠create - Create a new Textfield.
- cef_
time_ ⚠delta - Retrieve the delta in milliseconds between two time values. Returns true (1) on success and false (0) on failure.
- cef_
time_ ⚠from_ basetime - Converts cef_basetime_t to cef_time_t. Returns true (1) on success and false (0) on failure.
- cef_
time_ ⚠from_ doublet - cef_
time_ ⚠from_ timet - cef_
time_ ⚠now - Retrieve the current system time. Returns true (1) on success and false (0) on failure.
- cef_
time_ ⚠to_ basetime - Converts cef_time_t to cef_basetime_t. Returns true (1) on success and false (0) on failure.
- cef_
time_ ⚠to_ doublet - Converts cef_time_t to/from a double which is the number of seconds since epoch (Jan 1, 1970). Webkit uses this format to represent time. A value of 0 means “not initialized”. Returns true (1) on success and false (0) on failure.
- cef_
time_ ⚠to_ timet - Converts cef_time_t to/from time_t. Returns true (1) on success and false (0) on failure.
- cef_
urlrequest_ ⚠create - Create a new URL request that is not associated with a specific browser or frame. Use cef_frame_t::CreateURLRequest instead if you want the request to have this association, in which case it may be handled differently (see documentation on that function). A request created with this function may only originate from the browser process, and will behave as follows:
- cef_
v8_ ⚠context_ get_ current_ context - Returns the current (top) context object in the V8 context stack.
- cef_
v8_ ⚠context_ get_ entered_ context - Returns the entered (bottom) context object in the V8 context stack.
- cef_
v8_ ⚠context_ in_ context - Returns true (1) if V8 is currently inside a context.
- cef_
v8_ ⚠stack_ trace_ get_ current - Returns the stack trace for the currently active context. |frame_limit| is the maximum number of frames that will be captured.
- cef_
v8_ ⚠value_ create_ array - Create a new cef_v8_value_t object of type array with the specified |length|. If |length| is negative the returned array will have length 0. This function should only be called from within the scope of a cef_render_process_handler_t, cef_v8_handler_t or cef_v8_accessor_t callback, or in combination with calling enter() and exit() on a stored cef_v8_context_t reference.
- cef_
v8_ ⚠value_ create_ array_ buffer - Create a new cef_v8_value_t object of type ArrayBuffer which wraps the provided |buffer| of size |length| bytes. The ArrayBuffer is externalized, meaning that it does not own |buffer|. The caller is responsible for freeing |buffer| when requested via a call to cef_v8_array_buffer_release_callback_t::ReleaseBuffer. This function should only be called from within the scope of a cef_render_process_handler_t, cef_v8_handler_t or cef_v8_accessor_t callback, or in combination with calling enter() and exit() on a stored cef_v8_context_t reference.
- cef_
v8_ ⚠value_ create_ array_ buffer_ with_ copy - Create a new cef_v8_value_t object of type ArrayBuffer which copies the provided |buffer| of size |length| bytes. This function should only be called from within the scope of a cef_render_process_handler_t, cef_v8_handler_t or cef_v8_accessor_t callback, or in combination with calling enter() and exit() on a stored cef_v8_context_t reference.
- cef_
v8_ ⚠value_ create_ bool - Create a new cef_v8_value_t object of type bool.
- cef_
v8_ ⚠value_ create_ date - Create a new cef_v8_value_t object of type Date. This function should only be called from within the scope of a cef_render_process_handler_t, cef_v8_handler_t or cef_v8_accessor_t callback, or in combination with calling enter() and exit() on a stored cef_v8_context_t reference.
- cef_
v8_ ⚠value_ create_ double - Create a new cef_v8_value_t object of type double.
- cef_
v8_ ⚠value_ create_ function - Create a new cef_v8_value_t object of type function. This function should only be called from within the scope of a cef_render_process_handler_t, cef_v8_handler_t or cef_v8_accessor_t callback, or in combination with calling enter() and exit() on a stored cef_v8_context_t reference.
- cef_
v8_ ⚠value_ create_ int - Create a new cef_v8_value_t object of type int.
- cef_
v8_ ⚠value_ create_ null - Create a new cef_v8_value_t object of type null.
- cef_
v8_ ⚠value_ create_ object - Create a new cef_v8_value_t object of type object with optional accessor and/or interceptor. This function should only be called from within the scope of a cef_render_process_handler_t, cef_v8_handler_t or cef_v8_accessor_t callback, or in combination with calling enter() and exit() on a stored cef_v8_context_t reference.
- cef_
v8_ ⚠value_ create_ promise - Create a new cef_v8_value_t object of type Promise. This function should only be called from within the scope of a cef_render_process_handler_t, cef_v8_handler_t or cef_v8_accessor_t callback, or in combination with calling enter() and exit() on a stored cef_v8_context_t reference.
- cef_
v8_ ⚠value_ create_ string - Create a new cef_v8_value_t object of type string.
- cef_
v8_ ⚠value_ create_ uint - Create a new cef_v8_value_t object of type unsigned int.
- cef_
v8_ ⚠value_ create_ undefined - Create a new cef_v8_value_t object of type undefined.
- cef_
value_ ⚠create - Creates a new object.
- cef_
window_ ⚠create_ top_ level - Create a new Window.
- get_
cef_ dir
Type Aliases§
- XDisplay
- XEvent
- __
time_ t - __
uint16_ t - __
uint_ least16_ t - cef_
accelerated_ paint_ info_ common_ t - Structure containing shared texture common metadata. For documentation on each field, please refer to src/media/base/video_frame_metadata.h for actual details.
- cef_
accelerated_ paint_ info_ t - Structure containing shared texture information for the OnAcceleratedPaint callback. Resources will be released to the underlying pool for reuse when the callback returns from client code.
- cef_
accelerated_ paint_ native_ pixmap_ plane_ t - Structure containing the plane information of the shared texture. Sync with native_pixmap_handle.h
- cef_
accessibility_ handler_ t - Implement this structure to receive accessibility notification when accessibility events have been registered. The functions of this structure will be called on the UI thread.
- cef_
app_ t - Implement this structure to provide handler implementations. Methods will be called by the process and/or thread indicated.
- cef_
audio_ handler_ t - Implement this structure to handle audio events.
- cef_
audio_ parameters_ t - Structure representing the audio parameters for setting up the audio handler.
- cef_
auth_ callback_ t - Callback structure used for asynchronous continuation of authentication requests.
- cef_
base_ ref_ counted_ t - All ref-counted framework structures must include this structure first.
- cef_
base_ scoped_ t - All scoped framework structures must include this structure first.
- cef_
basetime_ t - Represents a wall clock time in UTC. Values are not guaranteed to be monotonically non-decreasing and are subject to large amounts of skew. Time is stored internally as microseconds since the Windows epoch (1601).
- cef_
before_ download_ callback_ t - Callback structure used to asynchronously continue a download.
- cef_
binary_ value_ t - Structure representing a binary value. Can be used on any process and thread.
- cef_
box_ layout_ settings_ t - Settings used when initializing a CefBoxLayout.
- cef_
box_ layout_ t - A Layout manager that arranges child views vertically or horizontally in a side-by-side fashion with spacing around and between the child views. The child views are always sized according to their preferred size. If the host’s bounds provide insufficient space, child views will be clamped. Excess space will not be distributed. Methods must be called on the browser process UI thread unless otherwise indicated.
- cef_
browser_ host_ t - Structure used to represent the browser process aspects of a browser. The functions of this structure can only be called in the browser process. They may be called on any thread in that process unless otherwise indicated in the comments.
- cef_
browser_ process_ handler_ t - Structure used to implement browser process callbacks. The functions of this structure will be called on the browser process main thread unless otherwise indicated.
- cef_
browser_ settings_ t - Browser initialization settings. Specify NULL or 0 to get the recommended default values. The consequences of using custom values may not be well tested. Many of these and other settings can also configured using command- line switches.
- cef_
browser_ t - Structure used to represent a browser. When used in the browser process the functions of this structure may be called on any thread unless otherwise indicated in the comments. When used in the render process the functions of this structure may only be called on the main thread.
- cef_
browser_ view_ delegate_ t - Implement this structure to handle BrowserView events. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- cef_
browser_ view_ t - A View hosting a cef_browser_t instance. Methods must be called on the browser process UI thread unless otherwise indicated.
- cef_
button_ delegate_ t - Implement this structure to handle Button events. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- cef_
button_ t - A View representing a button. Depending on the specific type, the button could be implemented by a native control or custom rendered. Methods must be called on the browser process UI thread unless otherwise indicated.
- cef_
callback_ t - Generic callback structure used for asynchronous continuation.
- cef_
char_ t - cef_
client_ t - Implement this structure to provide handler implementations.
- cef_
color_ t - cef_
command_ handler_ t - Implement this structure to handle events related to commands. The functions of this structure will be called on the UI thread.
- cef_
command_ line_ t - Structure used to create and/or parse command line arguments. Arguments with “–”, “-” and, on Windows, “/” prefixes are considered switches. Switches will always precede any arguments without switch prefixes. Switches can optionally have a value specified using the “=” delimiter (e.g. “-switch=value”). An argument of “–” will terminate switch parsing with all subsequent tokens, regardless of prefix, being interpreted as non-switch arguments. Switch names should be lowercase ASCII and will be converted to such if necessary. Switch values will retain the original case and UTF8 encoding. This structure can be used before cef_initialize() is called.
- cef_
completion_ callback_ t - Generic callback structure used for asynchronous completion.
- cef_
composition_ underline_ t - Structure representing IME composition underline information. This is a thin wrapper around Blink’s WebCompositionUnderline class and should be kept in sync with that.
- cef_
context_ menu_ handler_ t - Implement this structure to handle context menu events. The functions of this structure will be called on the UI thread.
- cef_
context_ menu_ params_ t - Provides information about the context menu state. The functions of this structure can only be accessed on browser process the UI thread.
- cef_
cookie_ access_ filter_ t - Implement this structure to filter cookies that may be sent or received from resource requests. The functions of this structure will be called on the IO thread unless otherwise indicated.
- cef_
cookie_ manager_ t - Structure used for managing cookies. The functions of this structure may be called on any thread unless otherwise indicated.
- cef_
cookie_ t - Cookie information.
- cef_
cookie_ visitor_ t - Structure to implement for visiting cookie values. The functions of this structure will always be called on the UI thread.
- cef_
cursor_ handle_ t - cef_
cursor_ info_ t - Structure representing cursor information. |buffer| will be |size.width|*|size.height|*4 bytes in size and represents a BGRA image with an upper-left origin.
- cef_
delete_ cookies_ callback_ t - Structure to implement to be notified of asynchronous completion via cef_cookie_manager_t::delete_cookies().
- cef_
dev_ tools_ message_ observer_ t - Callback structure for cef_browser_host_t::AddDevToolsMessageObserver. The functions of this structure will be called on the browser process UI thread.
- cef_
dialog_ handler_ t - Implement this structure to handle dialog events. The functions of this structure will be called on the browser process UI thread.
- cef_
dictionary_ value_ t - Structure representing a dictionary value. Can be used on any process and thread.
- cef_
display_ handler_ t - Implement this structure to handle events related to browser display state. The functions of this structure will be called on the UI thread.
- cef_
display_ t - This structure typically, but not always, corresponds to a physical display connected to the system. A fake Display may exist on a headless system, or a Display may correspond to a remote, virtual display. All size and position values are in density independent pixel (DIP) coordinates unless otherwise indicated. Methods must be called on the browser process UI thread unless otherwise indicated.
- cef_
domdocument_ t - Structure used to represent a DOM document. The functions of this structure should only be called on the render process main thread thread.
- cef_
domnode_ t - Structure used to represent a DOM node. The functions of this structure should only be called on the render process main thread.
- cef_
domvisitor_ t - Structure to implement for visiting the DOM. The functions of this structure will be called on the render process main thread.
- cef_
download_ handler_ t - Structure used to handle file downloads. The functions of this structure will called on the browser process UI thread.
- cef_
download_ image_ callback_ t - Callback structure for cef_browser_host_t::DownloadImage. The functions of this structure will be called on the browser process UI thread.
- cef_
download_ item_ callback_ t - Callback structure used to asynchronously cancel a download.
- cef_
download_ item_ t - Structure used to represent a download item.
- cef_
drag_ data_ t - Structure used to represent drag data. The functions of this structure may be called on any thread.
- cef_
drag_ handler_ t - Implement this structure to handle events related to dragging. The functions of this structure will be called on the UI thread.
- cef_
draggable_ region_ t - Structure representing a draggable region.
- cef_
event_ handle_ t - cef_
file_ dialog_ callback_ t - Callback structure for asynchronous continuation of file dialog requests.
- cef_
fill_ layout_ t - A simple Layout that causes the associated Panel’s one child to be sized to match the bounds of its parent. Methods must be called on the browser process UI thread unless otherwise indicated.
- cef_
find_ handler_ t - Implement this structure to handle events related to find results. The functions of this structure will be called on the UI thread.
- cef_
focus_ handler_ t - Implement this structure to handle events related to focus. The functions of this structure will be called on the UI thread.
- cef_
frame_ handler_ t - Implement this structure to handle events related to cef_frame_t life span. The order of callbacks is:
- cef_
frame_ t - Structure used to represent a frame in the browser window. When used in the browser process the functions of this structure may be called on any thread unless otherwise indicated in the comments. When used in the render process the functions of this structure may only be called on the main thread.
- cef_
image_ t - Container for a single image represented at different scale factors. All image representations should be the same size in density independent pixel (DIP) units. For example, if the image at scale factor 1.0 is 100x100 pixels then the image at scale factor 2.0 should be 200x200 pixels – both images will display with a DIP size of 100x100 units. The functions of this structure can be called on any browser process thread.
- cef_
insets_ t - Structure representing insets.
- cef_
jsdialog_ callback_ t - Callback structure used for asynchronous continuation of JavaScript dialog requests.
- cef_
jsdialog_ handler_ t - Implement this structure to handle events related to JavaScript dialogs. The functions of this structure will be called on the UI thread.
- cef_
key_ event_ t - Structure representing keyboard event information.
- cef_
keyboard_ handler_ t - Implement this structure to handle events related to keyboard input. The functions of this structure will be called on the UI thread.
- cef_
label_ button_ t - LabelButton is a button with optional text and/or icon. Methods must be called on the browser process UI thread unless otherwise indicated.
- cef_
layout_ t - A Layout handles the sizing of the children of a Panel according to implementation-specific heuristics. Methods must be called on the browser process UI thread unless otherwise indicated.
- cef_
life_ span_ handler_ t - Implement this structure to handle events related to browser life span. The functions of this structure will be called on the UI thread unless otherwise indicated.
- cef_
linux_ window_ properties_ t - Linux window properties, such as X11’s WM_CLASS or Wayland’s app_id. Those are passed to CefWindowDelegate, so the client can set them for the CefWindow’s top-level. Thus, allowing window managers to correctly display the application’s information (e.g., icons).
- cef_
list_ value_ t - Structure representing a list value. Can be used on any process and thread.
- cef_
load_ handler_ t - Implement this structure to handle events related to browser load status. The functions of this structure will be called on the browser process UI thread or render process main thread (TID_RENDERER).
- cef_
main_ args_ t - Structure representing CefExecuteProcess arguments.
- cef_
media_ access_ callback_ t - Callback structure used for asynchronous continuation of media access permission requests.
- cef_
media_ observer_ t - Implemented by the client to observe MediaRouter events and registered via cef_media_router_t::AddObserver. The functions of this structure will be called on the browser process UI thread.
- cef_
media_ route_ create_ callback_ t - Callback structure for cef_media_router_t::CreateRoute. The functions of this structure will be called on the browser process UI thread.
- cef_
media_ route_ t - Represents the route between a media source and sink. Instances of this object are created via cef_media_router_t::CreateRoute and retrieved via cef_media_observer_t::OnRoutes. Contains the status and metadata of a routing operation. The functions of this structure may be called on any browser process thread unless otherwise indicated.
- cef_
media_ router_ t - Supports discovery of and communication with media devices on the local network via the Cast and DIAL protocols. The functions of this structure may be called on any browser process thread unless otherwise indicated.
- cef_
media_ sink_ device_ info_ callback_ t - Callback structure for cef_media_sink_t::GetDeviceInfo. The functions of this structure will be called on the browser process UI thread.
- cef_
media_ sink_ device_ info_ t - Device information for a MediaSink object.
- cef_
media_ sink_ t - Represents a sink to which media can be routed. Instances of this object are retrieved via cef_media_observer_t::OnSinks. The functions of this structure may be called on any browser process thread unless otherwise indicated.
- cef_
media_ source_ t - Represents a source from which media can be routed. Instances of this object are retrieved via cef_media_router_t::GetSource. The functions of this structure may be called on any browser process thread unless otherwise indicated.
- cef_
menu_ button_ delegate_ t - Implement this structure to handle MenuButton events. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- cef_
menu_ button_ pressed_ lock_ t - MenuButton pressed lock is released when this object is destroyed.
- cef_
menu_ button_ t - MenuButton is a button with optional text, icon and/or menu marker that shows a menu when clicked with the left mouse button. All size and position values are in density independent pixels (DIP) unless otherwise indicated. Methods must be called on the browser process UI thread unless otherwise indicated.
- cef_
menu_ model_ delegate_ t - Implement this structure to handle menu model events. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- cef_
menu_ model_ t - Supports creation and modification of menus. See cef_menu_id_t for the command ids that have default implementations. All user-defined command ids should be between MENU_ID_USER_FIRST and MENU_ID_USER_LAST. The functions of this structure can only be accessed on the browser process the UI thread.
- cef_
mouse_ event_ t - Structure representing mouse event information.
- cef_
navigation_ entry_ t - Structure used to represent an entry in navigation history.
- cef_
navigation_ entry_ visitor_ t - Callback structure for cef_browser_host_t::GetNavigationEntries. The functions of this structure will be called on the browser process UI thread.
- cef_
overlay_ controller_ t - Controller for an overlay that contains a contents View added via cef_window_t::AddOverlayView. Methods exposed by this controller should be called in preference to functions of the same name exposed by the contents View unless otherwise indicated. Methods must be called on the browser process UI thread unless otherwise indicated.
- cef_
panel_ delegate_ t - Implement this structure to handle Panel events. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- cef_
panel_ t - A Panel is a container in the views hierarchy that can contain other Views as children. Methods must be called on the browser process UI thread unless otherwise indicated.
- cef_
pdf_ print_ callback_ t - Callback structure for cef_browser_host_t::PrintToPDF. The functions of this structure will be called on the browser process UI thread.
- cef_
pdf_ print_ settings_ t - Structure representing PDF print settings. These values match the parameters supported by the DevTools Page.printToPDF function. See https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-printToPDF
- cef_
permission_ handler_ t - Implement this structure to handle events related to permission requests. The functions of this structure will be called on the browser process UI thread.
- cef_
permission_ prompt_ callback_ t - Callback structure used for asynchronous continuation of permission prompts.
- cef_
point_ t - Structure representing a point.
- cef_
popup_ features_ t - Popup window features.
- cef_
post_ data_ element_ t - Structure used to represent a single element in the request post data. The functions of this structure may be called on any thread.
- cef_
post_ data_ t - Structure used to represent post data for a web request. The functions of this structure may be called on any thread.
- cef_
preference_ manager_ t - Manage access to preferences. Many built-in preferences are registered by Chromium. Custom preferences can be registered in cef_browser_process_handler_t::OnRegisterCustomPreferences.
- cef_
preference_ observer_ t - Implemented by the client to observe preference changes and registered via cef_preference_manager_t::AddPreferenceObserver. The functions of this structure will be called on the browser process UI thread.
- cef_
preference_ registrar_ t - Structure that manages custom preference registrations.
- cef_
print_ dialog_ callback_ t - Callback structure for asynchronous continuation of print dialog requests.
- cef_
print_ handler_ t - Implement this structure to handle printing on Linux. Each browser will have only one print job in progress at a time. The functions of this structure will be called on the browser process UI thread.
- cef_
print_ job_ callback_ t - Callback structure for asynchronous continuation of print job requests.
- cef_
print_ settings_ t - Structure representing print settings.
- cef_
process_ message_ t - Structure representing a message. Can be used on any process and thread.
- cef_
range_ t - Structure representing a range.
- cef_
read_ handler_ t - Structure the client can implement to provide a custom stream reader. The functions of this structure may be called on any thread.
- cef_
rect_ t - Structure representing a rectangle.
- cef_
registration_ t - Generic callback structure used for managing the lifespan of a registration.
- cef_
render_ handler_ t - Implement this structure to handle events when window rendering is disabled. The functions of this structure will be called on the UI thread.
- cef_
render_ process_ handler_ t - Structure used to implement render process callbacks. The functions of this structure will be called on the render process main thread (TID_RENDERER) unless otherwise indicated.
- cef_
request_ context_ handler_ t - Implement this structure to provide handler implementations. The handler instance will not be released until all objects related to the context have been destroyed.
- cef_
request_ context_ settings_ t - Request context initialization settings. Specify NULL or 0 to get the recommended default values.
- cef_
request_ context_ t - A request context provides request handling for a set of related browser or URL request objects. A request context can be specified when creating a new browser via the cef_browser_host_t static factory functions or when creating a new URL request via the cef_urlrequest_t static factory functions. Browser objects with different request contexts will never be hosted in the same render process. Browser objects with the same request context may or may not be hosted in the same render process depending on the process model. Browser objects created indirectly via the JavaScript window.open function or targeted links will share the same render process and the same request context as the source browser. When running in single-process mode there is only a single render process (the main process) and so all browsers created in single-process mode will share the same request context. This will be the first request context passed into a cef_browser_host_t static factory function and all other request context objects will be ignored.
- cef_
request_ handler_ t - Implement this structure to handle events related to browser requests. The functions of this structure will be called on the thread indicated.
- cef_
request_ t - Structure used to represent a web request. The functions of this structure may be called on any thread.
- cef_
resolve_ callback_ t - Callback structure for cef_request_context_t::ResolveHost.
- cef_
resource_ bundle_ handler_ t - Structure used to implement a custom resource bundle structure. See CefSettings for additional options related to resource bundle loading. The functions of this structure may be called on multiple threads.
- cef_
resource_ handler_ t - Structure used to implement a custom request handler structure. The functions of this structure will be called on the IO thread unless otherwise indicated.
- cef_
resource_ read_ callback_ t - Callback for asynchronous continuation of cef_resource_handler_t::read().
- cef_
resource_ request_ handler_ t - Implement this structure to handle events related to browser requests. The functions of this structure will be called on the IO thread unless otherwise indicated.
- cef_
resource_ skip_ callback_ t - Callback for asynchronous continuation of cef_resource_handler_t::skip().
- cef_
response_ filter_ t - Implement this structure to filter resource response content. The functions of this structure will be called on the browser process IO thread.
- cef_
response_ t - Structure used to represent a web response. The functions of this structure may be called on any thread.
- cef_
run_ context_ menu_ callback_ t - Callback structure used for continuation of custom context menu display.
- cef_
run_ file_ dialog_ callback_ t - Callback structure for cef_browser_host_t::RunFileDialog. The functions of this structure will be called on the browser process UI thread.
- cef_
run_ quick_ menu_ callback_ t - Callback structure used for continuation of custom quick menu display.
- cef_
scheme_ handler_ factory_ t - Structure that creates cef_resource_handler_t instances for handling scheme requests. The functions of this structure will always be called on the IO thread.
- cef_
scheme_ registrar_ t - Structure that manages custom scheme registrations.
- cef_
screen_ info_ t - Screen information used when window rendering is disabled. This structure is passed as a parameter to CefRenderHandler::GetScreenInfo and should be filled in by the client.
- cef_
scroll_ view_ t - A ScrollView will show horizontal and/or vertical scrollbars when necessary based on the size of the attached content view. Methods must be called on the browser process UI thread unless otherwise indicated.
- cef_
select_ client_ certificate_ callback_ t - Callback structure used to select a client certificate for authentication.
- cef_
set_ cookie_ callback_ t - Structure to implement to be notified of asynchronous completion via cef_cookie_manager_t::set_cookie().
- cef_
setting_ observer_ t - Implemented by the client to observe content and website setting changes and registered via cef_request_context_t::AddSettingObserver. The functions of this structure will be called on the browser process UI thread.
- cef_
settings_ t - Initialization settings. Specify NULL or 0 to get the recommended default values. Many of these and other settings can also configured using command- line switches.
- cef_
shared_ memory_ region_ t - Structure that wraps platform-dependent share memory region mapping.
- cef_
size_ t - Structure representing a size.
- cef_
sslinfo_ t - Structure representing SSL information.
- cef_
sslstatus_ t - Structure representing the SSL information for a navigation entry.
- cef_
stream_ reader_ t - Structure used to read data from a stream. The functions of this structure may be called on any thread.
- cef_
stream_ writer_ t - Structure used to write data to a stream. The functions of this structure may be called on any thread.
- cef_
string_ list_ t - CEF string maps are a set of key/value string pairs.
- cef_
string_ map_ t - CEF string maps are a set of key/value string pairs.
- cef_
string_ multimap_ t - CEF string multimaps are a set of key/value string pairs. More than one value can be assigned to a single key.
- cef_
string_ t - cef_
string_ userfree_ t - cef_
string_ userfree_ utf8_ t - cef_
string_ userfree_ utf16_ t - cef_
string_ userfree_ wide_ t - It is sometimes necessary for the system to allocate string structures with the expectation that the user will free them. The userfree types act as a hint that the user is responsible for freeing the structure.
- cef_
string_ utf8_ t - cef_
string_ utf16_ t - cef_
string_ visitor_ t - Implement this structure to receive string values asynchronously.
- cef_
string_ wide_ t - CEF string type definitions. Whomever allocates |str| is responsible for providing an appropriate |dtor| implementation that will free the string in the same memory space. When reusing an existing string structure make sure to call |dtor| for the old value before assigning new |str| and |dtor| values. Static strings will have a NULL |dtor| value. Using the below functions if you want this managed for you.
- cef_
task_ info_ t - Structure representing task information provided by CefTaskManager.
- cef_
task_ runner_ t - Structure that asynchronously executes tasks on the associated thread. It is safe to call the functions of this structure on any thread.
- cef_
task_ t - Implement this structure for asynchronous task execution. If the task is posted successfully and if the associated message loop is still running then the execute() function will be called on the target thread. If the task fails to post then the task object may be destroyed on the source thread instead of the target thread. For this reason be cautious when performing work in the task object destructor.
- cef_
textfield_ delegate_ t - Implement this structure to handle Textfield events. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- cef_
textfield_ t - A Textfield supports editing of text. This control is custom rendered with no platform-specific code. Methods must be called on the browser process UI thread unless otherwise indicated.
- cef_
time_ t - Time information. Values should always be in UTC.
- cef_
touch_ event_ t - Structure representing touch event information.
- cef_
touch_ handle_ state_ t - cef_
unresponsive_ process_ callback_ t - Callback structure for asynchronous handling of an unresponsive process.
- cef_
urlparts_ t - URL component parts.
- cef_
urlrequest_ client_ t - Structure that should be implemented by the cef_urlrequest_t client. The functions of this structure will be called on the same thread that created the request unless otherwise documented.
- cef_
urlrequest_ t - Structure used to make a URL request. URL requests are not associated with a browser instance so no cef_client_t callbacks will be executed. URL requests can be created on any valid CEF thread in either the browser or render process. Once created the functions of the URL request object must be accessed on the same thread that created it.
- cef_
v8_ accessor_ t - Structure that should be implemented to handle V8 accessor calls. Accessor identifiers are registered by calling cef_v8_value_t::set_value(). The functions of this structure will be called on the thread associated with the V8 accessor.
- cef_
v8_ array_ buffer_ release_ callback_ t - Callback structure that is passed to cef_v8_value_t::CreateArrayBuffer.
- cef_
v8_ context_ t - Structure representing a V8 context handle. V8 handles can only be accessed from the thread on which they are created. Valid threads for creating a V8 handle include the render process main thread (TID_RENDERER) and WebWorker threads. A task runner for posting tasks on the associated thread can be retrieved via the cef_v8_context_t::get_task_runner() function.
- cef_
v8_ exception_ t - Structure representing a V8 exception. The functions of this structure may be called on any render process thread.
- cef_
v8_ handler_ t - Structure that should be implemented to handle V8 function calls. The functions of this structure will be called on the thread associated with the V8 function.
- cef_
v8_ interceptor_ t - Structure that should be implemented to handle V8 interceptor calls. The functions of this structure will be called on the thread associated with the V8 interceptor. Interceptor’s named property handlers (with first argument of type CefString) are called when object is indexed by string. Indexed property handlers (with first argument of type int) are called when object is indexed by integer.
- cef_
v8_ stack_ frame_ t - Structure representing a V8 stack frame handle. V8 handles can only be accessed from the thread on which they are created. Valid threads for creating a V8 handle include the render process main thread (TID_RENDERER) and WebWorker threads. A task runner for posting tasks on the associated thread can be retrieved via the cef_v8_context_t::get_task_runner() function.
- cef_
v8_ stack_ trace_ t - Structure representing a V8 stack trace handle. V8 handles can only be accessed from the thread on which they are created. Valid threads for creating a V8 handle include the render process main thread (TID_RENDERER) and WebWorker threads. A task runner for posting tasks on the associated thread can be retrieved via the cef_v8_context_t::get_task_runner() function.
- cef_
v8_ value_ t - Structure representing a V8 value handle. V8 handles can only be accessed from the thread on which they are created. Valid threads for creating a V8 handle include the render process main thread (TID_RENDERER) and WebWorker threads. A task runner for posting tasks on the associated thread can be retrieved via the cef_v8_context_t::get_task_runner() function.
- cef_
value_ t - Structure that wraps other data value types. Complex types (binary, dictionary and list) will be referenced but not owned by this object. Can be used on any process and thread.
- cef_
view_ delegate_ t - Implement this structure to handle view events. All size and position values are in density independent pixels (DIP) unless otherwise indicated. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- cef_
view_ t - A View is a rectangle within the views View hierarchy. It is the base structure for all Views. All size and position values are in density independent pixels (DIP) unless otherwise indicated. Methods must be called on the browser process UI thread unless otherwise indicated.
- cef_
window_ delegate_ t - Implement this structure to handle window events. The functions of this structure will be called on the browser process UI thread unless otherwise indicated.
- cef_
window_ handle_ t - cef_
window_ info_ t - Class representing window information.
- cef_
window_ t - A Window is a top-level Window/widget in the Views hierarchy. By default it will have a non-client area with title bar, icon and buttons that supports moving and resizing. All size and position values are in density independent pixels (DIP) unless otherwise indicated. Methods must be called on the browser process UI thread unless otherwise indicated.
- cef_
write_ handler_ t - Structure the client can implement to provide a custom stream writer. The functions of this structure may be called on any thread.
- cef_
x509_ cert_ principal_ t - Structure representing the issuer or subject field of an X.509 certificate.
- cef_
x509_ certificate_ t - Structure representing a X.509 certificate.
- char16_
t - time_t
- wchar_t