ChromiumFX

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.

See also the original CEF documentation in cef/include/capi/cef_accessibility_handler_capi.h.

Called after renderer process sends accessibility tree changes to the browser process.

See also the original CEF documentation in cef/include/capi/cef_accessibility_handler_capi.h.

Called after renderer process sends accessibility location changes to the browser process.

See also the original CEF documentation in cef/include/capi/cef_accessibility_handler_capi.h.

Called after renderer process sends accessibility tree changes to the browser process.

See also the original CEF documentation in cef/include/capi/cef_accessibility_handler_capi.h.

Called after renderer process sends accessibility tree changes to the browser process.

See also the original CEF documentation in cef/include/capi/cef_accessibility_handler_capi.h.

Get the Value parameter for the callback.

Called after renderer process sends accessibility location changes to the browser process.

See also the original CEF documentation in cef/include/capi/cef_accessibility_handler_capi.h.

Called after renderer process sends accessibility location changes to the browser process.

See also the original CEF documentation in cef/include/capi/cef_accessibility_handler_capi.h.

Get the Value parameter for the callback.

Provides an opportunity to view and/or modify command-line arguments before processing by CEF and Chromium. The |ProcessType| value will be NULL for the browser process. Do not keep a reference to the CfxCommandLine object passed to this function. The CfxSettings.CommandLineArgsDisabled value can be used to start with an NULL command-line object. Any values specified in CfxSettings that equate to command-line arguments will be set before this function is called. Be cautious when using this function to modify command-line arguments for non-browser processes as this may result in undefined behavior including crashes.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Provides an opportunity to view and/or modify command-line arguments before processing by CEF and Chromium. The |ProcessType| value will be NULL for the browser process. Do not keep a reference to the CfxCommandLine object passed to this function. The CfxSettings.CommandLineArgsDisabled value can be used to start with an NULL command-line object. Any values specified in CfxSettings that equate to command-line arguments will be set before this function is called. Be cautious when using this function to modify command-line arguments for non-browser processes as this may result in undefined behavior including crashes.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Get the ProcessType parameter for the callback.

Get the CommandLine parameter for the callback.

Provides an opportunity to register custom schemes. Do not keep a reference to the |Registrar| object. This function is called on the main thread for each process and the registered schemes should be the same across all processes.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Provides an opportunity to register custom schemes. Do not keep a reference to the |Registrar| object. This function is called on the main thread for each process and the registered schemes should be the same across all processes.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Get the Registrar parameter for the callback.

Return the handler for resource bundle events. If CfxSettings.PackLoadingDisabled is true (1) a handler must be returned. If no handler is returned resources will be loaded from pack files. This function is called by the browser and render processes on multiple threads.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Return the handler for resource bundle events. If CfxSettings.PackLoadingDisabled is true (1) a handler must be returned. If no handler is returned resources will be loaded from pack files. This function is called by the browser and render processes on multiple threads.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for functionality specific to the browser process. This function is called on multiple threads in the browser process.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Return the handler for functionality specific to the browser process. This function is called on multiple threads in the browser process.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for functionality specific to the render process. This function is called on the render process main thread.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Return the handler for functionality specific to the render process. This function is called on the render process main thread.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called before a child process is launched. Will be called on the browser process UI thread when launching a render process and on the browser process IO thread when launching a GPU or plugin process. Provides an opportunity to modify the child process command line. Do not keep a reference to |CommandLine| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_browser_process_handler_capi.h.

Called before a child process is launched. Will be called on the browser process UI thread when launching a render process and on the browser process IO thread when launching a GPU or plugin process. Provides an opportunity to modify the child process command line. Do not keep a reference to |CommandLine| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_browser_process_handler_capi.h.

Get the CommandLine parameter for the callback.

Called on the browser process IO thread after the main thread has been created for a new render process. Provides an opportunity to specify extra information that will be passed to CfxRenderProcessHandler.OnRenderThreadCreated() in the render process. Do not keep a reference to |ExtraInfo| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_browser_process_handler_capi.h.

Called on the browser process IO thread after the main thread has been created for a new render process. Provides an opportunity to specify extra information that will be passed to CfxRenderProcessHandler.OnRenderThreadCreated() in the render process. Do not keep a reference to |ExtraInfo| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_browser_process_handler_capi.h.

Get the ExtraInfo parameter for the callback.

Return the handler for printing on Linux. If a print handler is not provided then printing will not be supported on the Linux platform.

See also the original CEF documentation in cef/include/capi/cef_browser_process_handler_capi.h.

Return the handler for printing on Linux. If a print handler is not provided then printing will not be supported on the Linux platform.

See also the original CEF documentation in cef/include/capi/cef_browser_process_handler_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called from any thread when work has been scheduled for the browser process main (UI) thread. This callback is used in combination with CfxSettings. external_message_pump and cef_do_message_loop_work() in cases where the CEF message loop must be integrated into an existing application message loop (see additional comments and warnings on CfxDoMessageLoopWork). This callback should schedule a cef_do_message_loop_work() call to happen on the main (UI) thread. |DelayMs| is the requested delay in milliseconds. If |DelayMs| is <= 0 then the call should happen reasonably soon. If |DelayMs| is > 0 then the call should be scheduled to happen after the specified delay and any currently pending scheduled call should be cancelled.

See also the original CEF documentation in cef/include/capi/cef_browser_process_handler_capi.h.

Called from any thread when work has been scheduled for the browser process main (UI) thread. This callback is used in combination with CfxSettings. external_message_pump and cef_do_message_loop_work() in cases where the CEF message loop must be integrated into an existing application message loop (see additional comments and warnings on CfxDoMessageLoopWork). This callback should schedule a cef_do_message_loop_work() call to happen on the main (UI) thread. |DelayMs| is the requested delay in milliseconds. If |DelayMs| is <= 0 then the call should happen reasonably soon. If |DelayMs| is > 0 then the call should be scheduled to happen after the specified delay and any currently pending scheduled call should be cancelled.

See also the original CEF documentation in cef/include/capi/cef_browser_process_handler_capi.h.

Get the DelayMs parameter for the callback.

Return the handler for context menus. If no handler is provided the default implementation will be used.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Return the handler for context menus. If no handler is provided the default implementation will be used.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for dialogs. If no handler is provided the default implementation will be used.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Return the handler for dialogs. If no handler is provided the default implementation will be used.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for browser display state events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Return the handler for browser display state events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for download events. If no handler is returned downloads will not be allowed.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Return the handler for download events. If no handler is returned downloads will not be allowed.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for drag events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Return the handler for drag events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for find result events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Return the handler for find result events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for focus events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Return the handler for focus events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for geolocation permissions requests. If no handler is provided geolocation access will be denied by default.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Return the handler for geolocation permissions requests. If no handler is provided geolocation access will be denied by default.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for JavaScript dialogs. If no handler is provided the default implementation will be used.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Return the handler for JavaScript dialogs. If no handler is provided the default implementation will be used.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for keyboard events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Return the handler for keyboard events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for browser life span events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Return the handler for browser life span events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for browser load status events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Return the handler for browser load status events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for off-screen rendering events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Return the handler for off-screen rendering events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for browser request events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Return the handler for browser request events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called when a new message is received from a different process. Return true (1) if the message was handled or false (0) otherwise. Do not keep a reference to or attempt to access the message outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Called when a new message is received from a different process. Return true (1) if the message was handled or false (0) otherwise. Do not keep a reference to or attempt to access the message outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Get the Browser parameter for the callback.

Get the SourceProcess parameter for the callback.

Get the Message parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called before a context menu is displayed. |Params| provides information about the context menu state. |Model| initially contains the default context menu. The |Model| can be cleared to show no context menu or modified to show a custom menu. Do not keep references to |Params| or |Model| outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Called before a context menu is displayed. |Params| provides information about the context menu state. |Model| initially contains the default context menu. The |Model| can be cleared to show no context menu or modified to show a custom menu. Do not keep references to |Params| or |Model| outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Params parameter for the callback.

Get the Model parameter for the callback.

Called to allow custom display of the context menu. |Params| provides information about the context menu state. |Model| contains the context menu model resulting from OnBeforeContextMenu. For custom display return true (1) and execute |Callback| either synchronously or asynchronously with the selected command ID. For default display return false (0). Do not keep references to |Params| or |Model| outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Called to allow custom display of the context menu. |Params| provides information about the context menu state. |Model| contains the context menu model resulting from OnBeforeContextMenu. For custom display return true (1) and execute |Callback| either synchronously or asynchronously with the selected command ID. For default display return false (0). Do not keep references to |Params| or |Model| outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Params parameter for the callback.

Get the Model parameter for the callback.

Get the Callback parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called to execute a command selected from the context menu. Return true (1) if the command was handled or false (0) for the default implementation. See CfxMenuId 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. |Params| will have the same values as what was passed to on_before_context_menu(). Do not keep a reference to |Params| outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Called to execute a command selected from the context menu. Return true (1) if the command was handled or false (0) for the default implementation. See CfxMenuId 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. |Params| will have the same values as what was passed to on_before_context_menu(). Do not keep a reference to |Params| outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Params parameter for the callback.

Get the CommandId parameter for the callback.

Get the EventFlags parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called when the context menu is dismissed irregardless of whether the menu was NULL or a command was selected.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Called when the context menu is dismissed irregardless of whether the menu was NULL or a command was selected.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Method that will be called once for each cookie. |Count| is the 0-based index for the current cookie. |Total| is the total number of cookies. Set |DeleteCookie| to true (1) to delete the cookie currently being visited. Return false (0) to stop visiting cookies. This function may never be called if no cookies are found.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Method that will be called once for each cookie. |Count| is the 0-based index for the current cookie. |Total| is the total number of cookies. Set |DeleteCookie| to true (1) to delete the cookie currently being visited. Return false (0) to stop visiting cookies. This function may never be called if no cookies are found.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Get the Cookie parameter for the callback.

Get the Count parameter for the callback.

Get the Total parameter for the callback.

Set the DeleteCookie out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Method that will be called upon completion. |NumDeleted| will be the number of cookies that were deleted or -1 if unknown.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Method that will be called upon completion. |NumDeleted| will be the number of cookies that were deleted or -1 if unknown.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Get the NumDeleted parameter for the callback.

Called to run a file chooser dialog. |Mode| represents the type of dialog to display. |Title| to the title to be used for the dialog and may be NULL to show the default title ("Open" or "Save" depending on the mode). |DefaultFilePath| is the path with optional directory and/or file name component that should be initially selected in the dialog. |AcceptFilters| are used to restrict the selectable file types and may any combination of (a) valid lower-cased MIME types (e.g. "text/*" or "image/*"), (b) individual file extensions (e.g. ".txt" or ".png"), or (c) combined description and file extension delimited using "|" and ";" (e.g. "Image Types|.png;.gif;.jpg"). |SelectedAcceptFilter| is the 0-based index of the filter that should be selected by default. To display a custom dialog return true (1) and execute |Callback| either inline or at a later time. To display the default dialog return false (0).

See also the original CEF documentation in cef/include/capi/cef_dialog_handler_capi.h.

Called to run a file chooser dialog. |Mode| represents the type of dialog to display. |Title| to the title to be used for the dialog and may be NULL to show the default title ("Open" or "Save" depending on the mode). |DefaultFilePath| is the path with optional directory and/or file name component that should be initially selected in the dialog. |AcceptFilters| are used to restrict the selectable file types and may any combination of (a) valid lower-cased MIME types (e.g. "text/*" or "image/*"), (b) individual file extensions (e.g. ".txt" or ".png"), or (c) combined description and file extension delimited using "|" and ";" (e.g. "Image Types|.png;.gif;.jpg"). |SelectedAcceptFilter| is the 0-based index of the filter that should be selected by default. To display a custom dialog return true (1) and execute |Callback| either inline or at a later time. To display the default dialog return false (0).

See also the original CEF documentation in cef/include/capi/cef_dialog_handler_capi.h.

Get the Browser parameter for the callback.

Get the Mode parameter for the callback.

Get the Title parameter for the callback.

Get the DefaultFilePath parameter for the callback.

Get the AcceptFilters parameter for the callback.

Get the SelectedAcceptFilter parameter for the callback.

Get the Callback parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called when a frame's address has changed.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called when a frame's address has changed.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Url parameter for the callback.

Called when the page title changes.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called when the page title changes.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Get the Browser parameter for the callback.

Get the Title parameter for the callback.

Called when the page icon changes.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called when the page icon changes.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Get the Browser parameter for the callback.

Get the IconUrls parameter for the callback.

Called when web content in the page has toggled fullscreen mode. If |Fullscreen| is true (1) the content will automatically be sized to fill the browser content area. If |Fullscreen| is false (0) the content will automatically return to its original size and position. The client is responsible for resizing the browser if desired.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called when web content in the page has toggled fullscreen mode. If |Fullscreen| is true (1) the content will automatically be sized to fill the browser content area. If |Fullscreen| is false (0) the content will automatically return to its original size and position. The client is responsible for resizing the browser if desired.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Get the Browser parameter for the callback.

Get the Fullscreen parameter for the callback.

Called when the browser is about to display a tooltip. |Text| contains the text that will be displayed in the tooltip. To handle the display of the tooltip yourself return true (1). Otherwise, you can optionally modify |Text| and then return false (0) to allow the browser to display the tooltip. When window rendering is disabled the application is responsible for drawing tooltips and the return value is ignored.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called when the browser is about to display a tooltip. |Text| contains the text that will be displayed in the tooltip. To handle the display of the tooltip yourself return true (1). Otherwise, you can optionally modify |Text| and then return false (0) to allow the browser to display the tooltip. When window rendering is disabled the application is responsible for drawing tooltips and the return value is ignored.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Get the Browser parameter for the callback.

Get or set the Text parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called when the browser receives a status message. |Value| contains the text that will be displayed in the status message.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called when the browser receives a status message. |Value| contains the text that will be displayed in the status message.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Get the Browser parameter for the callback.

Get the Value parameter for the callback.

Called to display a console message. Return true (1) to stop the message from being output to the console.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called to display a console message. Return true (1) to stop the message from being output to the console.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Get the Browser parameter for the callback.

Get the Message parameter for the callback.

Get the Source parameter for the callback.

Get the Line parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called when auto-resize is enabled via CfxBrowserHost.SetAutoResizeEnabled and the contents have auto- resized. |NewSize| will be the desired size in view coordinates. Return true (1) if the resize was handled or false (0) for default handling.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called when auto-resize is enabled via CfxBrowserHost.SetAutoResizeEnabled and the contents have auto- resized. |NewSize| will be the desired size in view coordinates. Return true (1) if the resize was handled or false (0) for default handling.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Get the Browser parameter for the callback.

Get the NewSize parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Method executed for visiting the DOM. The document object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Method executed for visiting the DOM. The document object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Get the Document parameter for the callback.

Called before a download begins. |SuggestedName| is the suggested name for the download file. By default the download will be canceled. Execute |Callback| either asynchronously or in this function to continue the download if desired. Do not keep a reference to |DownloadItem| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_download_handler_capi.h.

Called before a download begins. |SuggestedName| is the suggested name for the download file. By default the download will be canceled. Execute |Callback| either asynchronously or in this function to continue the download if desired. Do not keep a reference to |DownloadItem| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_download_handler_capi.h.

Get the Browser parameter for the callback.

Get the DownloadItem parameter for the callback.

Get the SuggestedName parameter for the callback.

Get the Callback parameter for the callback.

Called when a download's status or progress information has been updated. This may be called multiple times before and after on_before_download(). Execute |Callback| either asynchronously or in this function to cancel the download if desired. Do not keep a reference to |DownloadItem| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_download_handler_capi.h.

Called when a download's status or progress information has been updated. This may be called multiple times before and after on_before_download(). Execute |Callback| either asynchronously or in this function to cancel the download if desired. Do not keep a reference to |DownloadItem| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_download_handler_capi.h.

Get the Browser parameter for the callback.

Get the DownloadItem parameter for the callback.

Get the Callback parameter for the callback.

Method that will be executed when the image download has completed. |ImageUrl| is the URL that was downloaded and |HttpStatusCode| is the resulting HTTP status code. |Image| is the resulting image, possibly at multiple scale factors, or NULL if the download failed.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Method that will be executed when the image download has completed. |ImageUrl| is the URL that was downloaded and |HttpStatusCode| is the resulting HTTP status code. |Image| is the resulting image, possibly at multiple scale factors, or NULL if the download failed.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Get the ImageUrl parameter for the callback.

Get the HttpStatusCode parameter for the callback.

Get the Image parameter for the callback.

Called when an external drag event enters the browser window. |DragData| contains the drag event data and |Mask| represents the type of drag operation. Return false (0) for default drag handling behavior or true (1) to cancel the drag event.

See also the original CEF documentation in cef/include/capi/cef_drag_handler_capi.h.

Called when an external drag event enters the browser window. |DragData| contains the drag event data and |Mask| represents the type of drag operation. Return false (0) for default drag handling behavior or true (1) to cancel the drag event.

See also the original CEF documentation in cef/include/capi/cef_drag_handler_capi.h.

Get the Browser parameter for the callback.

Get the DragData parameter for the callback.

Get the Mask parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called whenever draggable regions for the browser window change. These can be specified using the '-webkit-app-region: drag/no-drag' CSS-property. If draggable regions are never defined in a document this function will also never be called. If the last draggable region is removed from a document this function will be called with an NULL vector.

See also the original CEF documentation in cef/include/capi/cef_drag_handler_capi.h.

Called whenever draggable regions for the browser window change. These can be specified using the '-webkit-app-region: drag/no-drag' CSS-property. If draggable regions are never defined in a document this function will also never be called. If the last draggable region is removed from a document this function will be called with an NULL vector.

See also the original CEF documentation in cef/include/capi/cef_drag_handler_capi.h.

Get the Browser parameter for the callback.

Get the Regions parameter for the callback. Do not keep a reference to the elements of this array outside of this function.

Called after all processes have sent their trace data. |TracingFile| is the path at which tracing data was written. The client is responsible for deleting |TracingFile|.

See also the original CEF documentation in cef/include/capi/cef_trace_capi.h.

Called after all processes have sent their trace data. |TracingFile| is the path at which tracing data was written. The client is responsible for deleting |TracingFile|.

See also the original CEF documentation in cef/include/capi/cef_trace_capi.h.

Get the TracingFile parameter for the callback.

Called if the CfxRequestContext.LoadExtension request fails. |Result| will be the error code.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called if the CfxRequestContext.LoadExtension request fails. |Result| will be the error code.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Get the Result parameter for the callback.

Called if the CfxRequestContext.LoadExtension request succeeds. |Extension| is the loaded extension.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called if the CfxRequestContext.LoadExtension request succeeds. |Extension| is the loaded extension.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Get the Extension parameter for the callback.

Called after the CfxExtension.Unload request has completed.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called after the CfxExtension.Unload request has completed.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Get the Extension parameter for the callback.

Called when an extension needs a browser to host a background script specified via the "background" manifest key. The browser will have no visible window and cannot be displayed. |Extension| is the extension that is loading the background script. |Url| is an internally generated reference to an HTML page that will be used to load the background script via a <script> src attribute. To allow creation of the browser optionally modify |Client| and |Settings| and return false (0). To cancel creation of the browser (and consequently cancel load of the background script) return true (1). Successful creation will be indicated by a call to CfxLifeSpanHandler.OnAfterCreated, and CfxBrowserHost.IsBackgroundHost will return true (1) for the resulting browser. See https://developer.chrome.com/extensions/event_pages for more information about extension background script usage.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called when an extension needs a browser to host a background script specified via the "background" manifest key. The browser will have no visible window and cannot be displayed. |Extension| is the extension that is loading the background script. |Url| is an internally generated reference to an HTML page that will be used to load the background script via a <script> src attribute. To allow creation of the browser optionally modify |Client| and |Settings| and return false (0). To cancel creation of the browser (and consequently cancel load of the background script) return true (1). Successful creation will be indicated by a call to CfxLifeSpanHandler.OnAfterCreated, and CfxBrowserHost.IsBackgroundHost will return true (1) for the resulting browser. See https://developer.chrome.com/extensions/event_pages for more information about extension background script usage.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Get the Extension parameter for the callback.

Get the Url parameter for the callback.

Set the Client out parameter for the callback.

Get the Settings parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called when an extension API (e.g. chrome.tabs.create) requests creation of a new browser. |Extension| and |Browser| are the source of the API call. |ActiveBrowser| may optionally be specified via the windowId property or returned via the get_active_browser() callback and provides the default |Client| and |Settings| values for the new browser. |Index| is the position value optionally specified via the index property. |Url| is the URL that will be loaded in the browser. |Active| is true (1) if the new browser should be active when opened. To allow creation of the browser optionally modify |WindowInfo|, |Client| and |Settings| and return false (0). To cancel creation of the browser return true (1). Successful creation will be indicated by a call to CfxLifeSpanHandler.OnAfterCreated. Any modifications to |WindowInfo| will be ignored if |ActiveBrowser| is wrapped in a CfxBrowserView.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called when an extension API (e.g. chrome.tabs.create) requests creation of a new browser. |Extension| and |Browser| are the source of the API call. |ActiveBrowser| may optionally be specified via the windowId property or returned via the get_active_browser() callback and provides the default |Client| and |Settings| values for the new browser. |Index| is the position value optionally specified via the index property. |Url| is the URL that will be loaded in the browser. |Active| is true (1) if the new browser should be active when opened. To allow creation of the browser optionally modify |WindowInfo|, |Client| and |Settings| and return false (0). To cancel creation of the browser return true (1). Successful creation will be indicated by a call to CfxLifeSpanHandler.OnAfterCreated. Any modifications to |WindowInfo| will be ignored if |ActiveBrowser| is wrapped in a CfxBrowserView.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Get the Extension parameter for the callback.

Get the Browser parameter for the callback.

Get the ActiveBrowser parameter for the callback.

Get the Index parameter for the callback.

Get the Url parameter for the callback.

Get the Active parameter for the callback.

Get the WindowInfo parameter for the callback.

Set the Client out parameter for the callback.

Get the Settings parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called when no tabId is specified to an extension API call that accepts a tabId parameter (e.g. chrome.tabs.*). |Extension| and |Browser| are the source of the API call. Return the browser that will be acted on by the API call or return NULL to act on |Browser|. The returned browser must share the same CfxRequestContext as |Browser|. Incognito browsers should not be considered unless the source extension has incognito access enabled, in which case |IncludeIncognito| will be true (1).

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called when no tabId is specified to an extension API call that accepts a tabId parameter (e.g. chrome.tabs.*). |Extension| and |Browser| are the source of the API call. Return the browser that will be acted on by the API call or return NULL to act on |Browser|. The returned browser must share the same CfxRequestContext as |Browser|. Incognito browsers should not be considered unless the source extension has incognito access enabled, in which case |IncludeIncognito| will be true (1).

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Get the Extension parameter for the callback.

Get the Browser parameter for the callback.

Get the IncludeIncognito parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called when the tabId associated with |TargetBrowser| is specified to an extension API call that accepts a tabId parameter (e.g. chrome.tabs.*). |Extension| and |Browser| are the source of the API call. Return true (1) to allow access of false (0) to deny access. Access to incognito browsers should not be allowed unless the source extension has incognito access enabled, in which case |IncludeIncognito| will be true (1).

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called when the tabId associated with |TargetBrowser| is specified to an extension API call that accepts a tabId parameter (e.g. chrome.tabs.*). |Extension| and |Browser| are the source of the API call. Return true (1) to allow access of false (0) to deny access. Access to incognito browsers should not be allowed unless the source extension has incognito access enabled, in which case |IncludeIncognito| will be true (1).

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Get the Extension parameter for the callback.

Get the Browser parameter for the callback.

Get the IncludeIncognito parameter for the callback.

Get the TargetBrowser parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called to retrieve an extension resource that would normally be loaded from disk (e.g. if a file parameter is specified to chrome.tabs.executeScript). |Extension| and |Browser| are the source of the resource request. |File| is the requested relative file path. To handle the resource request return true (1) and execute |Callback| either synchronously or asynchronously. For the default behavior which reads the resource from the extension directory on disk return false (0). Localization substitutions will not be applied to resources handled via this function.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called to retrieve an extension resource that would normally be loaded from disk (e.g. if a file parameter is specified to chrome.tabs.executeScript). |Extension| and |Browser| are the source of the resource request. |File| is the requested relative file path. To handle the resource request return true (1) and execute |Callback| either synchronously or asynchronously. For the default behavior which reads the resource from the extension directory on disk return false (0). Localization substitutions will not be applied to resources handled via this function.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Get the Extension parameter for the callback.

Get the Browser parameter for the callback.

Get the File parameter for the callback.

Get the Callback parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called to report find results returned by CfxBrowserHost.Find(). |Identifer| is the identifier passed to find(), |Count| is the number of matches currently identified, |SelectionRect| is the location of where the match was found (in window coordinates), |ActiveMatchOrdinal| is the current position in the search results, and |FinalUpdate| is true (1) if this is the last find notification.

See also the original CEF documentation in cef/include/capi/cef_find_handler_capi.h.

Called to report find results returned by CfxBrowserHost.Find(). |Identifer| is the identifier passed to find(), |Count| is the number of matches currently identified, |SelectionRect| is the location of where the match was found (in window coordinates), |ActiveMatchOrdinal| is the current position in the search results, and |FinalUpdate| is true (1) if this is the last find notification.

See also the original CEF documentation in cef/include/capi/cef_find_handler_capi.h.

Get the Browser parameter for the callback.

Get the Identifier parameter for the callback.

Get the Count parameter for the callback.

Get the SelectionRect parameter for the callback.

Get the ActiveMatchOrdinal parameter for the callback.

Get the FinalUpdate parameter for the callback.

Called when the browser component is about to loose focus. For instance, if focus was on the last HTML element and the user pressed the TAB key. |Next| will be true (1) if the browser is giving focus to the next component and false (0) if the browser is giving focus to the previous component.

See also the original CEF documentation in cef/include/capi/cef_focus_handler_capi.h.

Called when the browser component is about to loose focus. For instance, if focus was on the last HTML element and the user pressed the TAB key. |Next| will be true (1) if the browser is giving focus to the next component and false (0) if the browser is giving focus to the previous component.

See also the original CEF documentation in cef/include/capi/cef_focus_handler_capi.h.

Get the Browser parameter for the callback.

Get the Next parameter for the callback.

Called when the browser component is requesting focus. |Source| indicates where the focus request is originating from. Return false (0) to allow the focus to be set or true (1) to cancel setting the focus.

See also the original CEF documentation in cef/include/capi/cef_focus_handler_capi.h.

Called when the browser component is requesting focus. |Source| indicates where the focus request is originating from. Return false (0) to allow the focus to be set or true (1) to cancel setting the focus.

See also the original CEF documentation in cef/include/capi/cef_focus_handler_capi.h.

Get the Browser parameter for the callback.

Get the Source parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called when the browser component has received focus.

See also the original CEF documentation in cef/include/capi/cef_focus_handler_capi.h.

Called when the browser component has received focus.

See also the original CEF documentation in cef/include/capi/cef_focus_handler_capi.h.

Get the Browser parameter for the callback.

Called when a page requests permission to access geolocation information. |RequestingUrl| is the URL requesting permission and |RequestId| is the unique ID for the permission request. Return true (1) and call CfxGeolocationCallback.Continue() either in this function or at a later time to continue or cancel the request. Return false (0) to cancel the request immediately.

See also the original CEF documentation in cef/include/capi/cef_geolocation_handler_capi.h.

Called when a page requests permission to access geolocation information. |RequestingUrl| is the URL requesting permission and |RequestId| is the unique ID for the permission request. Return true (1) and call CfxGeolocationCallback.Continue() either in this function or at a later time to continue or cancel the request. Return false (0) to cancel the request immediately.

See also the original CEF documentation in cef/include/capi/cef_geolocation_handler_capi.h.

Get the Browser parameter for the callback.

Get the RequestingUrl parameter for the callback.

Get the RequestId parameter for the callback.

Get the Callback parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called when a geolocation access request is canceled. |RequestId| is the unique ID for the permission request.

See also the original CEF documentation in cef/include/capi/cef_geolocation_handler_capi.h.

Called when a geolocation access request is canceled. |RequestId| is the unique ID for the permission request.

See also the original CEF documentation in cef/include/capi/cef_geolocation_handler_capi.h.

Get the Browser parameter for the callback.

Get the RequestId parameter for the callback.

Called with the 'best available' location information or, if the location update failed, with error information.

See also the original CEF documentation in cef/include/capi/cef_geolocation_capi.h.

Called with the 'best available' location information or, if the location update failed, with error information.

See also the original CEF documentation in cef/include/capi/cef_geolocation_capi.h.

Get the Position parameter for the callback.

Called to run a JavaScript dialog. If |OriginUrl| is non-NULL it can be passed to the CfxFormatUrlForSecurityDisplay function to retrieve a secure and user-friendly display string. The |DefaultPromptText| value will be specified for prompt dialogs only. Set |SuppressMessage| to true (1) and return false (0) to suppress the message (suppressing messages is preferable to immediately executing the callback as this is used to detect presumably malicious behavior like spamming alert messages in onbeforeunload). Set |SuppressMessage| to false (0) and return false (0) to use the default implementation (the default implementation will show one modal dialog at a time and suppress any additional dialog requests until the displayed dialog is dismissed). Return true (1) if the application will use a custom dialog or if the callback has been executed immediately. Custom dialogs may be either modal or modeless. If a custom dialog is used the application must execute |Callback| once the custom dialog is dismissed.

See also the original CEF documentation in cef/include/capi/cef_jsdialog_handler_capi.h.

Called to run a JavaScript dialog. If |OriginUrl| is non-NULL it can be passed to the CfxFormatUrlForSecurityDisplay function to retrieve a secure and user-friendly display string. The |DefaultPromptText| value will be specified for prompt dialogs only. Set |SuppressMessage| to true (1) and return false (0) to suppress the message (suppressing messages is preferable to immediately executing the callback as this is used to detect presumably malicious behavior like spamming alert messages in onbeforeunload). Set |SuppressMessage| to false (0) and return false (0) to use the default implementation (the default implementation will show one modal dialog at a time and suppress any additional dialog requests until the displayed dialog is dismissed). Return true (1) if the application will use a custom dialog or if the callback has been executed immediately. Custom dialogs may be either modal or modeless. If a custom dialog is used the application must execute |Callback| once the custom dialog is dismissed.

See also the original CEF documentation in cef/include/capi/cef_jsdialog_handler_capi.h.

Get the Browser parameter for the callback.

Get the OriginUrl parameter for the callback.

Get the DialogType parameter for the callback.

Get the MessageText parameter for the callback.

Get the DefaultPromptText parameter for the callback.

Get the Callback parameter for the callback.

Set the SuppressMessage out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called to run a dialog asking the user if they want to leave a page. Return false (0) to use the default dialog implementation. Return true (1) if the application will use a custom dialog or if the callback has been executed immediately. Custom dialogs may be either modal or modeless. If a custom dialog is used the application must execute |Callback| once the custom dialog is dismissed.

See also the original CEF documentation in cef/include/capi/cef_jsdialog_handler_capi.h.

Called to run a dialog asking the user if they want to leave a page. Return false (0) to use the default dialog implementation. Return true (1) if the application will use a custom dialog or if the callback has been executed immediately. Custom dialogs may be either modal or modeless. If a custom dialog is used the application must execute |Callback| once the custom dialog is dismissed.

See also the original CEF documentation in cef/include/capi/cef_jsdialog_handler_capi.h.

Get the Browser parameter for the callback.

Get the MessageText parameter for the callback.

Get the IsReload parameter for the callback.

Get the Callback parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called to cancel any pending dialogs and reset any saved dialog state. Will be called due to events like page navigation irregardless of whether any dialogs are currently pending.

See also the original CEF documentation in cef/include/capi/cef_jsdialog_handler_capi.h.

Called to cancel any pending dialogs and reset any saved dialog state. Will be called due to events like page navigation irregardless of whether any dialogs are currently pending.

See also the original CEF documentation in cef/include/capi/cef_jsdialog_handler_capi.h.

Get the Browser parameter for the callback.

Called when the default implementation dialog is closed.

See also the original CEF documentation in cef/include/capi/cef_jsdialog_handler_capi.h.

Called when the default implementation dialog is closed.

See also the original CEF documentation in cef/include/capi/cef_jsdialog_handler_capi.h.

Get the Browser parameter for the callback.

Called before a keyboard event is sent to the renderer. |Event| contains information about the keyboard event. |OsEvent| is the operating system event message, if any. Return true (1) if the event was handled or false (0) otherwise. If the event will be handled in on_key_event() as a keyboard shortcut set |IsKeyboardShortcut| to true (1) and return false (0).

See also the original CEF documentation in cef/include/capi/cef_keyboard_handler_capi.h.

Called before a keyboard event is sent to the renderer. |Event| contains information about the keyboard event. |OsEvent| is the operating system event message, if any. Return true (1) if the event was handled or false (0) otherwise. If the event will be handled in on_key_event() as a keyboard shortcut set |IsKeyboardShortcut| to true (1) and return false (0).

See also the original CEF documentation in cef/include/capi/cef_keyboard_handler_capi.h.

Get the Browser parameter for the callback.

Get the Event parameter for the callback.

Get the OsEvent parameter for the callback.

Set the IsKeyboardShortcut out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called after the renderer and JavaScript in the page has had a chance to handle the event. |Event| contains information about the keyboard event. |OsEvent| is the operating system event message, if any. Return true (1) if the keyboard event was handled or false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_keyboard_handler_capi.h.

Called after the renderer and JavaScript in the page has had a chance to handle the event. |Event| contains information about the keyboard event. |OsEvent| is the operating system event message, if any. Return true (1) if the keyboard event was handled or false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_keyboard_handler_capi.h.

Get the Browser parameter for the callback.

Get the Event parameter for the callback.

Get the OsEvent parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called on the UI thread before a new popup browser is created. The |Browser| and |Frame| values represent the source of the popup request. The |TargetUrl| and |TargetFrameName| values indicate where the popup browser should navigate and may be NULL if not specified with the request. The |TargetDisposition| value indicates where the user intended to open the popup (e.g. current tab, new tab, etc). The |UserGesture| value will be true (1) if the popup was opened via explicit user gesture (e.g. clicking a link) or false (0) if the popup opened automatically (e.g. via the DomContentLoaded event). The |PopupFeatures| structure contains additional information about the requested popup window. To allow creation of the popup browser optionally modify |WindowInfo|, |Client|, |Settings| and |NoJavascriptAccess| and return false (0). To cancel creation of the popup browser return true (1). The |Client| and |Settings| values will default to the source browser's values. If the |NoJavascriptAccess| value is set to false (0) the new browser will not be scriptable and may not be hosted in the same renderer process as the source browser. Any modifications to |WindowInfo| will be ignored if the parent browser is wrapped in a CfxBrowserView. Popup browser creation will be canceled if the parent browser is destroyed before the popup browser creation completes (indicated by a call to OnAfterCreated for the popup browser).

See also the original CEF documentation in cef/include/capi/cef_life_span_handler_capi.h.

Called on the UI thread before a new popup browser is created. The |Browser| and |Frame| values represent the source of the popup request. The |TargetUrl| and |TargetFrameName| values indicate where the popup browser should navigate and may be NULL if not specified with the request. The |TargetDisposition| value indicates where the user intended to open the popup (e.g. current tab, new tab, etc). The |UserGesture| value will be true (1) if the popup was opened via explicit user gesture (e.g. clicking a link) or false (0) if the popup opened automatically (e.g. via the DomContentLoaded event). The |PopupFeatures| structure contains additional information about the requested popup window. To allow creation of the popup browser optionally modify |WindowInfo|, |Client|, |Settings| and |NoJavascriptAccess| and return false (0). To cancel creation of the popup browser return true (1). The |Client| and |Settings| values will default to the source browser's values. If the |NoJavascriptAccess| value is set to false (0) the new browser will not be scriptable and may not be hosted in the same renderer process as the source browser. Any modifications to |WindowInfo| will be ignored if the parent browser is wrapped in a CfxBrowserView. Popup browser creation will be canceled if the parent browser is destroyed before the popup browser creation completes (indicated by a call to OnAfterCreated for the popup browser).

See also the original CEF documentation in cef/include/capi/cef_life_span_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the TargetUrl parameter for the callback.

Get the TargetFrameName parameter for the callback.

Get the TargetDisposition parameter for the callback.

Get the UserGesture parameter for the callback.

Get the PopupFeatures parameter for the callback.

Get the WindowInfo parameter for the callback.

Set the Client out parameter for the callback.

Get the Settings parameter for the callback.

Set the NoJavascriptAccess out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called after a new browser is created. This callback will be the first notification that references |Browser|.

See also the original CEF documentation in cef/include/capi/cef_life_span_handler_capi.h.

Called after a new browser is created. This callback will be the first notification that references |Browser|.

See also the original CEF documentation in cef/include/capi/cef_life_span_handler_capi.h.

Get the Browser parameter for the callback.

Called when a browser has recieved a request to close. This may result directly from a call to CfxBrowserHost::*close_browser() or indirectly if the browser is parented to a top-level window created by CEF and the user attempts to close that window (by clicking the 'X', for example). The do_close() function will be called after the JavaScript 'onunload' event has been fired. An application should handle top-level owner window close notifications by calling CfxBrowserHost.TryCloseBrowser() or CfxBrowserHost.CloseBrowser(false (0)) instead of allowing the window to close immediately (see the examples below). This gives CEF an opportunity to process the 'onbeforeunload' event and optionally cancel the close before do_close() is called. When windowed rendering is enabled CEF will internally create a window or view to host the browser. In that case returning false (0) from do_close() will send the standard close notification to the browser's top-level owner window (e.g. WM_CLOSE on Windows, performClose: on OS X, "delete_event" on Linux or CfxWindowDelegate.CanClose() callback from Views). If the browser's host window/view has already been destroyed (via view hierarchy tear-down, for example) then do_close() will not be called for that browser since is no longer possible to cancel the close. When windowed rendering is disabled returning false (0) from do_close() will cause the browser object to be destroyed immediately. If the browser's top-level owner window requires a non-standard close notification then send that notification from do_close() and return true (1). The CfxLifeSpanHandler.OnBeforeClose() function will be called after do_close() (if do_close() is called) and immediately before the browser object is destroyed. The application should only exit after on_before_close() has been called for all existing browsers. The below examples describe what should happen during window close when the browser is parented to an application-provided top-level window. Example 1: Using CfxBrowserHost.TryCloseBrowser(). This is recommended for clients using standard close handling and windows created on the browser process UI thread. 1. User clicks the window close button which sends a close notification to the application's top-level window. 2. Application's top-level window receives the close notification and calls TryCloseBrowser() (which internally calls CloseBrowser(false)). TryCloseBrowser() returns false so the client cancels the window close. 3. JavaScript 'onbeforeunload' handler executes and shows the close confirmation dialog (which can be overridden via CfxJSDialogHandler.OnBeforeUnloadDialog()). 4. User approves the close. 5. JavaScript 'onunload' handler executes. 6. CEF sends a close notification to the application's top-level window (because DoClose() returned false by default). 7. Application's top-level window receives the close notification and calls TryCloseBrowser(). TryCloseBrowser() returns true so the client allows the window close. 8. Application's top-level window is destroyed. 9. Application's on_before_close() handler is called and the browser object is destroyed. 10. Application exits by calling cef_quit_message_loop() if no other browsers exist. Example 2: Using CfxBrowserHost.CloseBrowser(false (0)) and implementing the do_close() callback. This is recommended for clients using non-standard close handling or windows that were not created on the browser process UI thread. 1. User clicks the window close button which sends a close notification to the application's top-level window. 2. Application's top-level window receives the close notification and: A. Calls CfxBrowserHost.CloseBrowser(false). B. Cancels the window close. 3. JavaScript 'onbeforeunload' handler executes and shows the close confirmation dialog (which can be overridden via CfxJSDialogHandler.OnBeforeUnloadDialog()). 4. User approves the close. 5. JavaScript 'onunload' handler executes. 6. Application's do_close() handler is called. Application will: A. Set a flag to indicate that the next close attempt will be allowed. B. Return false. 7. CEF sends an close notification to the application's top-level window. 8. Application's top-level window receives the close notification and allows the window to close based on the flag from #6B. 9. Application's top-level window is destroyed. 10. Application's on_before_close() handler is called and the browser object is destroyed. 11. Application exits by calling cef_quit_message_loop() if no other browsers exist.

See also the original CEF documentation in cef/include/capi/cef_life_span_handler_capi.h.

Called when a browser has recieved a request to close. This may result directly from a call to CfxBrowserHost::*close_browser() or indirectly if the browser is parented to a top-level window created by CEF and the user attempts to close that window (by clicking the 'X', for example). The do_close() function will be called after the JavaScript 'onunload' event has been fired. An application should handle top-level owner window close notifications by calling CfxBrowserHost.TryCloseBrowser() or CfxBrowserHost.CloseBrowser(false (0)) instead of allowing the window to close immediately (see the examples below). This gives CEF an opportunity to process the 'onbeforeunload' event and optionally cancel the close before do_close() is called. When windowed rendering is enabled CEF will internally create a window or view to host the browser. In that case returning false (0) from do_close() will send the standard close notification to the browser's top-level owner window (e.g. WM_CLOSE on Windows, performClose: on OS X, "delete_event" on Linux or CfxWindowDelegate.CanClose() callback from Views). If the browser's host window/view has already been destroyed (via view hierarchy tear-down, for example) then do_close() will not be called for that browser since is no longer possible to cancel the close. When windowed rendering is disabled returning false (0) from do_close() will cause the browser object to be destroyed immediately. If the browser's top-level owner window requires a non-standard close notification then send that notification from do_close() and return true (1). The CfxLifeSpanHandler.OnBeforeClose() function will be called after do_close() (if do_close() is called) and immediately before the browser object is destroyed. The application should only exit after on_before_close() has been called for all existing browsers. The below examples describe what should happen during window close when the browser is parented to an application-provided top-level window. Example 1: Using CfxBrowserHost.TryCloseBrowser(). This is recommended for clients using standard close handling and windows created on the browser process UI thread. 1. User clicks the window close button which sends a close notification to the application's top-level window. 2. Application's top-level window receives the close notification and calls TryCloseBrowser() (which internally calls CloseBrowser(false)). TryCloseBrowser() returns false so the client cancels the window close. 3. JavaScript 'onbeforeunload' handler executes and shows the close confirmation dialog (which can be overridden via CfxJSDialogHandler.OnBeforeUnloadDialog()). 4. User approves the close. 5. JavaScript 'onunload' handler executes. 6. CEF sends a close notification to the application's top-level window (because DoClose() returned false by default). 7. Application's top-level window receives the close notification and calls TryCloseBrowser(). TryCloseBrowser() returns true so the client allows the window close. 8. Application's top-level window is destroyed. 9. Application's on_before_close() handler is called and the browser object is destroyed. 10. Application exits by calling cef_quit_message_loop() if no other browsers exist. Example 2: Using CfxBrowserHost.CloseBrowser(false (0)) and implementing the do_close() callback. This is recommended for clients using non-standard close handling or windows that were not created on the browser process UI thread. 1. User clicks the window close button which sends a close notification to the application's top-level window. 2. Application's top-level window receives the close notification and: A. Calls CfxBrowserHost.CloseBrowser(false). B. Cancels the window close. 3. JavaScript 'onbeforeunload' handler executes and shows the close confirmation dialog (which can be overridden via CfxJSDialogHandler.OnBeforeUnloadDialog()). 4. User approves the close. 5. JavaScript 'onunload' handler executes. 6. Application's do_close() handler is called. Application will: A. Set a flag to indicate that the next close attempt will be allowed. B. Return false. 7. CEF sends an close notification to the application's top-level window. 8. Application's top-level window receives the close notification and allows the window to close based on the flag from #6B. 9. Application's top-level window is destroyed. 10. Application's on_before_close() handler is called and the browser object is destroyed. 11. Application exits by calling cef_quit_message_loop() if no other browsers exist.

See also the original CEF documentation in cef/include/capi/cef_life_span_handler_capi.h.

Get the Browser parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called just before a browser is destroyed. Release all references to the browser object and do not attempt to execute any functions on the browser object after this callback returns. This callback will be the last notification that references |Browser|. See do_close() documentation for additional usage information.

See also the original CEF documentation in cef/include/capi/cef_life_span_handler_capi.h.

Called just before a browser is destroyed. Release all references to the browser object and do not attempt to execute any functions on the browser object after this callback returns. This callback will be the last notification that references |Browser|. See do_close() documentation for additional usage information.

See also the original CEF documentation in cef/include/capi/cef_life_span_handler_capi.h.

Get the Browser parameter for the callback.

Called when the loading state has changed. This callback will be executed twice -- once when loading is initiated either programmatically or by user action, and once when loading is terminated due to completion, cancellation of failure. It will be called before any calls to OnLoadStart and after all calls to OnLoadError and/or OnLoadEnd.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called when the loading state has changed. This callback will be executed twice -- once when loading is initiated either programmatically or by user action, and once when loading is terminated due to completion, cancellation of failure. It will be called before any calls to OnLoadStart and after all calls to OnLoadError and/or OnLoadEnd.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Get the Browser parameter for the callback.

Get the IsLoading parameter for the callback.

Get the CanGoBack parameter for the callback.

Get the CanGoForward parameter for the callback.

Called after a navigation has been committed and before the browser begins loading contents in the frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. |TransitionType| provides information about the source of the navigation and an accurate value is only available in the browser process. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will not be called for same page navigations (fragments, history state, etc.) or for navigations that fail or are canceled before commit. For notification of overall browser load status use OnLoadingStateChange instead.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called after a navigation has been committed and before the browser begins loading contents in the frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. |TransitionType| provides information about the source of the navigation and an accurate value is only available in the browser process. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will not be called for same page navigations (fragments, history state, etc.) or for navigations that fail or are canceled before commit. For notification of overall browser load status use OnLoadingStateChange instead.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the TransitionType parameter for the callback.

Called when the browser is done loading a frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will not be called for same page navigations (fragments, history state, etc.) or for navigations that fail or are canceled before commit. For notification of overall browser load status use OnLoadingStateChange instead.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called when the browser is done loading a frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will not be called for same page navigations (fragments, history state, etc.) or for navigations that fail or are canceled before commit. For notification of overall browser load status use OnLoadingStateChange instead.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the HttpStatusCode parameter for the callback.

Called when a navigation fails or is canceled. This function may be called by itself if before commit or in combination with OnLoadStart/OnLoadEnd if after commit. |ErrorCode| is the error code number, |ErrorText| is the error text and |FailedUrl| is the URL that failed to load. See net\base\net_error_list.h for complete descriptions of the error codes.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called when a navigation fails or is canceled. This function may be called by itself if before commit or in combination with OnLoadStart/OnLoadEnd if after commit. |ErrorCode| is the error code number, |ErrorText| is the error text and |FailedUrl| is the URL that failed to load. See net\base\net_error_list.h for complete descriptions of the error codes.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the ErrorCode parameter for the callback.

Get the ErrorText parameter for the callback.

Get the FailedUrl parameter for the callback.

Perform the action associated with the specified |CommandId| and optional |EventFlags|.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Perform the action associated with the specified |CommandId| and optional |EventFlags|.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Get the MenuModel parameter for the callback.

Get the CommandId parameter for the callback.

Get the EventFlags parameter for the callback.

Called when the user moves the mouse outside the menu and over the owning window.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Called when the user moves the mouse outside the menu and over the owning window.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Get the MenuModel parameter for the callback.

Get the ScreenPoint parameter for the callback.

Called on unhandled open submenu keyboard commands. |IsRtl| will be true (1) if the menu is displaying a right-to-left language.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Called on unhandled open submenu keyboard commands. |IsRtl| will be true (1) if the menu is displaying a right-to-left language.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Get the MenuModel parameter for the callback.

Get the IsRtl parameter for the callback.

Called on unhandled close submenu keyboard commands. |IsRtl| will be true (1) if the menu is displaying a right-to-left language.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Called on unhandled close submenu keyboard commands. |IsRtl| will be true (1) if the menu is displaying a right-to-left language.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Get the MenuModel parameter for the callback.

Get the IsRtl parameter for the callback.

The menu is about to show.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

The menu is about to show.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Get the MenuModel parameter for the callback.

The menu has closed.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

The menu has closed.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Get the MenuModel parameter for the callback.

Optionally modify a menu item label. Return true (1) if |Label| was modified.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Optionally modify a menu item label. Return true (1) if |Label| was modified.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Get the MenuModel parameter for the callback.

Get or set the Label parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Method that will be executed. Do not keep a reference to |Entry| outside of this callback. Return true (1) to continue visiting entries or false (0) to stop. |Current| is true (1) if this entry is the currently loaded navigation entry. |Index| is the 0-based index of this entry and |Total| is the total number of entries.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Method that will be executed. Do not keep a reference to |Entry| outside of this callback. Return true (1) to continue visiting entries or false (0) to stop. |Current| is true (1) if this entry is the currently loaded navigation entry. |Index| is the 0-based index of this entry and |Total| is the total number of entries.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Get the Entry parameter for the callback.

Get the Current parameter for the callback.

Get the Index parameter for the callback.

Get the Total parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Method that will be executed when the PDF printing has completed. |Path| is the output path. |Ok| will be true (1) if the printing completed successfully or false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Method that will be executed when the PDF printing has completed. |Path| is the output path. |Ok| will be true (1) if the printing completed successfully or false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Get the Path parameter for the callback.

Get the Ok parameter for the callback.

Called when printing has started for the specified |Browser|. This function will be called before the other OnPrint*() functions and irrespective of how printing was initiated (e.g. CfxBrowserHost.Print(), JavaScript window.print() or PDF extension print button).

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Called when printing has started for the specified |Browser|. This function will be called before the other OnPrint*() functions and irrespective of how printing was initiated (e.g. CfxBrowserHost.Print(), JavaScript window.print() or PDF extension print button).

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Get the Browser parameter for the callback.

Synchronize |Settings| with client state. If |GetDefaults| is true (1) then populate |Settings| with the default print settings. Do not keep a reference to |Settings| outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Synchronize |Settings| with client state. If |GetDefaults| is true (1) then populate |Settings| with the default print settings. Do not keep a reference to |Settings| outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Get the Browser parameter for the callback.

Get the Settings parameter for the callback.

Get the GetDefaults parameter for the callback.

Show the print dialog. Execute |Callback| once the dialog is dismissed. Return true (1) if the dialog will be displayed or false (0) to cancel the printing immediately.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Show the print dialog. Execute |Callback| once the dialog is dismissed. Return true (1) if the dialog will be displayed or false (0) to cancel the printing immediately.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Get the Browser parameter for the callback.

Get the HasSelection parameter for the callback.

Get the Callback parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Send the print job to the printer. Execute |Callback| once the job is completed. Return true (1) if the job will proceed or false (0) to cancel the job immediately.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Send the print job to the printer. Execute |Callback| once the job is completed. Return true (1) if the job will proceed or false (0) to cancel the job immediately.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Get the Browser parameter for the callback.

Get the DocumentName parameter for the callback.

Get the PdfFilePath parameter for the callback.

Get the Callback parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Reset client state related to printing.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Reset client state related to printing.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Get the Browser parameter for the callback.

Return the PDF paper size in device units. Used in combination with CfxBrowserHost.PrintToPdf().

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Return the PDF paper size in device units. Used in combination with CfxBrowserHost.PrintToPdf().

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Get the DeviceUnitsPerInch parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Read raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Read raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Get the Ptr parameter for the callback.

Get the Size parameter for the callback.

Get the N parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Seek to the specified offset position. |Whence| may be any one of SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on failure.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Seek to the specified offset position. |Whence| may be any one of SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on failure.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Get the Offset parameter for the callback.

Get the Whence parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the current offset position.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return the current offset position.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return non-zero if at end of file.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return non-zero if at end of file.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return true (1) if this handler performs work like accessing the file system which may block. Used as a hint for determining the thread to access the handler from.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return true (1) if this handler performs work like accessing the file system which may block. Used as a hint for determining the thread to access the handler from.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Method that will be called when CDM registration is complete. |Result| will be CEF_CDM_REGISTRATION_ERROR_NONE if registration completed successfully. Otherwise, |Result| and |ErrorMessage| will contain additional information about why registration failed.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Method that will be called when CDM registration is complete. |Result| will be CEF_CDM_REGISTRATION_ERROR_NONE if registration completed successfully. Otherwise, |Result| and |ErrorMessage| will contain additional information about why registration failed.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Get the Result parameter for the callback.

Get the ErrorMessage parameter for the callback.

Return the handler for accessibility notifications. If no handler is provided the default implementation will be used.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Return the handler for accessibility notifications. If no handler is provided the default implementation will be used.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called to retrieve the root window rectangle in screen coordinates. Return true (1) if the rectangle was provided.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called to retrieve the root window rectangle in screen coordinates. Return true (1) if the rectangle was provided.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Get the Browser parameter for the callback.

Get the Rect parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called to retrieve the view rectangle which is relative to screen coordinates. Return true (1) if the rectangle was provided.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called to retrieve the view rectangle which is relative to screen coordinates. Return true (1) if the rectangle was provided.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Get the Browser parameter for the callback.

Get the Rect parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called to retrieve the translation from view coordinates to actual screen coordinates. Return true (1) if the screen coordinates were provided.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called to retrieve the translation from view coordinates to actual screen coordinates. Return true (1) if the screen coordinates were provided.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Get the Browser parameter for the callback.

Get the ViewX parameter for the callback.

Get the ViewY parameter for the callback.

Set the ScreenX out parameter for the callback.

Set the ScreenY out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called to allow the client to fill in the CfxScreenInfo object with appropriate values. Return true (1) if the |ScreenInfo| structure has been modified. If the screen info rectangle is left NULL the rectangle from GetViewRect will be used. If the rectangle is still NULL or invalid popups may not be drawn correctly.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called to allow the client to fill in the CfxScreenInfo object with appropriate values. Return true (1) if the |ScreenInfo| structure has been modified. If the screen info rectangle is left NULL the rectangle from GetViewRect will be used. If the rectangle is still NULL or invalid popups may not be drawn correctly.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Get the Browser parameter for the callback.

Get the ScreenInfo parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called when the browser wants to show or hide the popup widget. The popup should be shown if |Show| is true (1) and hidden if |Show| is false (0).

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when the browser wants to show or hide the popup widget. The popup should be shown if |Show| is true (1) and hidden if |Show| is false (0).

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Get the Browser parameter for the callback.

Get the Show parameter for the callback.

Called when the browser wants to move or resize the popup widget. |Rect| contains the new location and size in view coordinates.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when the browser wants to move or resize the popup widget. |Rect| contains the new location and size in view coordinates.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Get the Browser parameter for the callback.

Get the Rect parameter for the callback.

Called when an element should be painted. Pixel values passed to this function are scaled relative to view coordinates based on the value of CfxScreenInfo.DeviceScaleFactor returned from GetScreenInfo. |Type| indicates whether the element is the view or the popup widget. |Buffer| contains the pixel data for the whole image. |DirtyRects| contains the set of rectangles in pixel coordinates that need to be repainted. |Buffer| will be |Width|*|Height|*4 bytes in size and represents a BGRA image with an upper-left origin.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when an element should be painted. Pixel values passed to this function are scaled relative to view coordinates based on the value of CfxScreenInfo.DeviceScaleFactor returned from GetScreenInfo. |Type| indicates whether the element is the view or the popup widget. |Buffer| contains the pixel data for the whole image. |DirtyRects| contains the set of rectangles in pixel coordinates that need to be repainted. |Buffer| will be |Width|*|Height|*4 bytes in size and represents a BGRA image with an upper-left origin.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Get the Browser parameter for the callback.

Get the Type parameter for the callback.

Get the DirtyRects parameter for the callback. Do not keep a reference to the elements of this array outside of this function.

Get the Buffer parameter for the callback.

Get the Width parameter for the callback.

Get the Height parameter for the callback.

Called when the browser's cursor has changed. If |Type| is CT_CUSTOM then |CustomCursorInfo| will be populated with the custom cursor information.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when the browser's cursor has changed. If |Type| is CT_CUSTOM then |CustomCursorInfo| will be populated with the custom cursor information.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Get the Browser parameter for the callback.

Get the Cursor parameter for the callback.

Get the Type parameter for the callback.

Get the CustomCursorInfo parameter for the callback.

Called when the user starts dragging content in the web view. Contextual information about the dragged content is supplied by |DragData|. (|X|, |Y|) is the drag start location in screen coordinates. OS APIs that run a system message loop may be used within the StartDragging call. Return false (0) to abort the drag operation. Don't call any of CfxBrowserHost.DragSource*Ended* functions after returning false (0). Return true (1) to handle the drag operation. Call CfxBrowserHost.DragSourceEndedAt and DragSourceSystemDragEnded either synchronously or asynchronously to inform the web view that the drag operation has ended.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when the user starts dragging content in the web view. Contextual information about the dragged content is supplied by |DragData|. (|X|, |Y|) is the drag start location in screen coordinates. OS APIs that run a system message loop may be used within the StartDragging call. Return false (0) to abort the drag operation. Don't call any of CfxBrowserHost.DragSource*Ended* functions after returning false (0). Return true (1) to handle the drag operation. Call CfxBrowserHost.DragSourceEndedAt and DragSourceSystemDragEnded either synchronously or asynchronously to inform the web view that the drag operation has ended.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Get the Browser parameter for the callback.

Get the DragData parameter for the callback.

Get the AllowedOps parameter for the callback.

Get the X parameter for the callback.

Get the Y parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called when the web view wants to update the mouse cursor during a drag & drop operation. |Operation| describes the allowed operation (none, move, copy, link).

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when the web view wants to update the mouse cursor during a drag & drop operation. |Operation| describes the allowed operation (none, move, copy, link).

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Get the Browser parameter for the callback.

Get the Operation parameter for the callback.

Called when the scroll offset has changed.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when the scroll offset has changed.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Get the Browser parameter for the callback.

Get the X parameter for the callback.

Get the Y parameter for the callback.

Called when the IME composition range has changed. |SelectedRange| is the range of characters that have been selected. |CharacterBounds| is the bounds of each character in view coordinates.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when the IME composition range has changed. |SelectedRange| is the range of characters that have been selected. |CharacterBounds| is the bounds of each character in view coordinates.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Get the Browser parameter for the callback.

Get the SelectedRange parameter for the callback.

Get the CharacterBounds parameter for the callback. Do not keep a reference to the elements of this array outside of this function.

Called after the render process main thread has been created. |ExtraInfo| is a read-only value originating from CfxBrowserProcessHandler.OnRenderProcessThreadCreated(). Do not keep a reference to |ExtraInfo| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called after the render process main thread has been created. |ExtraInfo| is a read-only value originating from CfxBrowserProcessHandler.OnRenderProcessThreadCreated(). Do not keep a reference to |ExtraInfo| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the ExtraInfo parameter for the callback.

Called after a browser has been created. When browsing cross-origin a new browser will be created before the old browser with the same identifier is destroyed.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called after a browser has been created. When browsing cross-origin a new browser will be created before the old browser with the same identifier is destroyed.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the Browser parameter for the callback.

Called before a browser is destroyed.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called before a browser is destroyed.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the Browser parameter for the callback.

Called before browser navigation. Return true (1) to cancel the navigation or false (0) to allow the navigation to proceed. The |Request| object cannot be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called before browser navigation. Return true (1) to cancel the navigation or false (0) to allow the navigation to proceed. The |Request| object cannot be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Request parameter for the callback.

Get the NavigationType parameter for the callback.

Get the IsRedirect parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called immediately after the V8 context for a frame has been created. To retrieve the JavaScript 'window' object use the CfxV8Context.GetGlobal() function. V8 handles can only be accessed from the thread on which they are created. A task runner for posting tasks on the associated thread can be retrieved via the CfxV8Context.GetTaskRunner() function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called immediately after the V8 context for a frame has been created. To retrieve the JavaScript 'window' object use the CfxV8Context.GetGlobal() function. V8 handles can only be accessed from the thread on which they are created. A task runner for posting tasks on the associated thread can be retrieved via the CfxV8Context.GetTaskRunner() function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Context parameter for the callback.

Called immediately before the V8 context for a frame is released. No references to the context should be kept after this function is called.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called immediately before the V8 context for a frame is released. No references to the context should be kept after this function is called.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Context parameter for the callback.

Called for global uncaught exceptions in a frame. Execution of this callback is disabled by default. To enable set CfxSettings.UncaughtExceptionStackSize > 0.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called for global uncaught exceptions in a frame. Execution of this callback is disabled by default. To enable set CfxSettings.UncaughtExceptionStackSize > 0.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Context parameter for the callback.

Get the Exception parameter for the callback.

Get the StackTrace parameter for the callback.

Called when a new node in the the browser gets focus. The |Node| value may be NULL if no specific node has gained focus. The node object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called when a new node in the the browser gets focus. The |Node| value may be NULL if no specific node has gained focus. The node object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Node parameter for the callback.

Called on the browser process UI thread immediately after the request context has been initialized.

See also the original CEF documentation in cef/include/capi/cef_request_context_handler_capi.h.

Called on the browser process UI thread immediately after the request context has been initialized.

See also the original CEF documentation in cef/include/capi/cef_request_context_handler_capi.h.

Get the RequestContext parameter for the callback.

Called on the browser process IO thread to retrieve the cookie manager. If this function returns NULL the default cookie manager retrievable via CfxRequestContext.GetDefaultCookieManager() will be used.

See also the original CEF documentation in cef/include/capi/cef_request_context_handler_capi.h.

Called on the browser process IO thread to retrieve the cookie manager. If this function returns NULL the default cookie manager retrievable via CfxRequestContext.GetDefaultCookieManager() will be used.

See also the original CEF documentation in cef/include/capi/cef_request_context_handler_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called on multiple browser process threads before a plugin instance is loaded. |MimeType| is the mime type of the plugin that will be loaded. |PluginUrl| is the content URL that the plugin will load and may be NULL. |IsMainFrame| will be true (1) if the plugin is being loaded in the main (top-level) frame, |TopOriginUrl| is the URL for the top-level frame that contains the plugin when loading a specific plugin instance or NULL when building the initial list of enabled plugins for 'navigator.plugins' JavaScript state. |PluginInfo| includes additional information about the plugin that will be loaded. |PluginPolicy| is the recommended policy. Modify |PluginPolicy| and return true (1) to change the policy. Return false (0) to use the recommended policy. The default plugin policy can be set at runtime using the `--plugin-policy=[allow|Detect|block]` command- line flag. Decisions to mark a plugin as disabled by setting |PluginPolicy| to PLUGIN_POLICY_DISABLED may be cached when |TopOriginUrl| is NULL. To purge the plugin list cache and potentially trigger new calls to this function call CfxRequestContext.PurgePluginListCache.

See also the original CEF documentation in cef/include/capi/cef_request_context_handler_capi.h.

Called on multiple browser process threads before a plugin instance is loaded. |MimeType| is the mime type of the plugin that will be loaded. |PluginUrl| is the content URL that the plugin will load and may be NULL. |IsMainFrame| will be true (1) if the plugin is being loaded in the main (top-level) frame, |TopOriginUrl| is the URL for the top-level frame that contains the plugin when loading a specific plugin instance or NULL when building the initial list of enabled plugins for 'navigator.plugins' JavaScript state. |PluginInfo| includes additional information about the plugin that will be loaded. |PluginPolicy| is the recommended policy. Modify |PluginPolicy| and return true (1) to change the policy. Return false (0) to use the recommended policy. The default plugin policy can be set at runtime using the `--plugin-policy=[allow|Detect|block]` command- line flag. Decisions to mark a plugin as disabled by setting |PluginPolicy| to PLUGIN_POLICY_DISABLED may be cached when |TopOriginUrl| is NULL. To purge the plugin list cache and potentially trigger new calls to this function call CfxRequestContext.PurgePluginListCache.

See also the original CEF documentation in cef/include/capi/cef_request_context_handler_capi.h.

Get the MimeType parameter for the callback.

Get the PluginUrl parameter for the callback.

Get the IsMainFrame parameter for the callback.

Get the TopOriginUrl parameter for the callback.

Get the PluginInfo parameter for the callback.

Get or set the PluginPolicy parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called on the UI thread before browser navigation. Return true (1) to cancel the navigation or false (0) to allow the navigation to proceed. The |Request| object cannot be modified in this callback. CfxLoadHandler.OnLoadingStateChange will be called twice in all cases. If the navigation is allowed CfxLoadHandler.OnLoadStart and CfxLoadHandler.OnLoadEnd will be called. If the navigation is canceled CfxLoadHandler.OnLoadError will be called with an |ErrorCode| value of ERR_ABORTED.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the UI thread before browser navigation. Return true (1) to cancel the navigation or false (0) to allow the navigation to proceed. The |Request| object cannot be modified in this callback. CfxLoadHandler.OnLoadingStateChange will be called twice in all cases. If the navigation is allowed CfxLoadHandler.OnLoadStart and CfxLoadHandler.OnLoadEnd will be called. If the navigation is canceled CfxLoadHandler.OnLoadError will be called with an |ErrorCode| value of ERR_ABORTED.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Request parameter for the callback.

Get the IsRedirect parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called on the UI thread before OnBeforeBrowse in certain limited cases where navigating a new or different browser might be desirable. This includes user-initiated navigation that might open in a special way (e.g. links clicked via middle-click or ctrl + left-click) and certain types of cross-origin navigation initiated from the renderer process (e.g. navigating the top-level frame to/from a file URL). The |Browser| and |Frame| values represent the source of the navigation. The |TargetDisposition| value indicates where the user intended to navigate the browser based on standard Chromium behaviors (e.g. current tab, new tab, etc). The |UserGesture| value will be true (1) if the browser navigated via explicit user gesture (e.g. clicking a link) or false (0) if it navigated automatically (e.g. via the DomContentLoaded event). Return true (1) to cancel the navigation or false (0) to allow the navigation to proceed in the source browser's top-level frame.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the UI thread before OnBeforeBrowse in certain limited cases where navigating a new or different browser might be desirable. This includes user-initiated navigation that might open in a special way (e.g. links clicked via middle-click or ctrl + left-click) and certain types of cross-origin navigation initiated from the renderer process (e.g. navigating the top-level frame to/from a file URL). The |Browser| and |Frame| values represent the source of the navigation. The |TargetDisposition| value indicates where the user intended to navigate the browser based on standard Chromium behaviors (e.g. current tab, new tab, etc). The |UserGesture| value will be true (1) if the browser navigated via explicit user gesture (e.g. clicking a link) or false (0) if it navigated automatically (e.g. via the DomContentLoaded event). Return true (1) to cancel the navigation or false (0) to allow the navigation to proceed in the source browser's top-level frame.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the TargetUrl parameter for the callback.

Get the TargetDisposition parameter for the callback.

Get the UserGesture parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called on the IO thread before a resource request is loaded. The |Request| object may be modified. Return RV_CONTINUE to continue the request immediately. Return RV_CONTINUE_ASYNC and call CfxRequestCallback:: cont() at a later time to continue or cancel the request asynchronously. Return RV_CANCEL to cancel the request immediately.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread before a resource request is loaded. The |Request| object may be modified. Return RV_CONTINUE to continue the request immediately. Return RV_CONTINUE_ASYNC and call CfxRequestCallback:: cont() at a later time to continue or cancel the request asynchronously. Return RV_CANCEL to cancel the request immediately.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Request parameter for the callback.

Get the Callback parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called on the IO thread before a resource is loaded. To allow the resource to load normally return NULL. To specify a handler for the resource return a CfxResourceHandler object. The |Request| object should not be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread before a resource is loaded. To allow the resource to load normally return NULL. To specify a handler for the resource return a CfxResourceHandler object. The |Request| object should not be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Request parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called on the IO thread when a resource load is redirected. The |Request| parameter will contain the old URL and other request-related information. The |Response| parameter will contain the response that resulted in the redirect. The |NewUrl| parameter will contain the new URL and can be changed if desired. The |Request| object cannot be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread when a resource load is redirected. The |Request| parameter will contain the old URL and other request-related information. The |Response| parameter will contain the response that resulted in the redirect. The |NewUrl| parameter will contain the new URL and can be changed if desired. The |Request| object cannot be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Request parameter for the callback.

Get the Response parameter for the callback.

Get or set the NewUrl parameter for the callback.

Called on the IO thread when a resource response is received. To allow the resource to load normally return false (0). To redirect or retry the resource modify |Request| (url, headers or post body) and return true (1). The |Response| object cannot be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread when a resource response is received. To allow the resource to load normally return false (0). To redirect or retry the resource modify |Request| (url, headers or post body) and return true (1). The |Response| object cannot be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Request parameter for the callback.

Get the Response parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called on the IO thread to optionally filter resource response content. |Request| and |Response| represent the request and response respectively and cannot be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread to optionally filter resource response content. |Request| and |Response| represent the request and response respectively and cannot be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Request parameter for the callback.

Get the Response parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called on the IO thread when a resource load has completed. |Request| and |Response| represent the request and response respectively and cannot be modified in this callback. |Status| indicates the load completion status. |ReceivedContentLength| is the number of response bytes actually read.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread when a resource load has completed. |Request| and |Response| represent the request and response respectively and cannot be modified in this callback. |Status| indicates the load completion status. |ReceivedContentLength| is the number of response bytes actually read.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the Request parameter for the callback.

Get the Response parameter for the callback.

Get the Status parameter for the callback.

Get the ReceivedContentLength parameter for the callback.

Called on the IO thread when the browser needs credentials from the user. |IsProxy| indicates whether the host is a proxy server. |Host| contains the hostname and |Port| contains the port number. |Realm| is the realm of the challenge and may be NULL. |Scheme| is the authentication scheme used, such as "basic" or "digest", and will be NULL if the source of the request is an FTP server. Return true (1) to continue the request and call CfxAuthCallback.Continue() either in this function or at a later time when the authentication information is available. Return false (0) to cancel the request immediately.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread when the browser needs credentials from the user. |IsProxy| indicates whether the host is a proxy server. |Host| contains the hostname and |Port| contains the port number. |Realm| is the realm of the challenge and may be NULL. |Scheme| is the authentication scheme used, such as "basic" or "digest", and will be NULL if the source of the request is an FTP server. Return true (1) to continue the request and call CfxAuthCallback.Continue() either in this function or at a later time when the authentication information is available. Return false (0) to cancel the request immediately.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the IsProxy parameter for the callback.

Get the Host parameter for the callback.

Get the Port parameter for the callback.

Get the Realm parameter for the callback.

Get the Scheme parameter for the callback.

Get the Callback parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called on the IO thread when JavaScript requests a specific storage quota size via the webkitStorageInfo.requestQuota function. |OriginUrl| is the origin of the page making the request. |NewSize| is the requested quota size in bytes. Return true (1) to continue the request and call CfxRequestCallback.Continue() either in this function or at a later time to grant or deny the request. Return false (0) to cancel the request immediately.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread when JavaScript requests a specific storage quota size via the webkitStorageInfo.requestQuota function. |OriginUrl| is the origin of the page making the request. |NewSize| is the requested quota size in bytes. Return true (1) to continue the request and call CfxRequestCallback.Continue() either in this function or at a later time to grant or deny the request. Return false (0) to cancel the request immediately.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Get the OriginUrl parameter for the callback.

Get the NewSize parameter for the callback.

Get the Callback parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called on the UI thread to handle requests for URLs with an unknown protocol component. Set |AllowOsExecution| to true (1) to attempt execution via the registered OS protocol handler, if any. SECURITY WARNING: YOU SHOULD USE THIS METHOD TO ENFORCE RESTRICTIONS BASED ON SCHEME, HOST OR OTHER URL ANALYSIS BEFORE ALLOWING OS EXECUTION.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the UI thread to handle requests for URLs with an unknown protocol component. Set |AllowOsExecution| to true (1) to attempt execution via the registered OS protocol handler, if any. SECURITY WARNING: YOU SHOULD USE THIS METHOD TO ENFORCE RESTRICTIONS BASED ON SCHEME, HOST OR OTHER URL ANALYSIS BEFORE ALLOWING OS EXECUTION.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Get the Url parameter for the callback.

Set the AllowOsExecution out parameter for the callback.

Called on the UI thread to handle requests for URLs with an invalid SSL certificate. Return true (1) and call CfxRequestCallback.Continue() either in this function or at a later time to continue or cancel the request. Return false (0) to cancel the request immediately. If CfxSettings.IgnoreCertificateErrors is set all invalid certificates will be accepted without calling this function.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the UI thread to handle requests for URLs with an invalid SSL certificate. Return true (1) and call CfxRequestCallback.Continue() either in this function or at a later time to continue or cancel the request. Return false (0) to cancel the request immediately. If CfxSettings.IgnoreCertificateErrors is set all invalid certificates will be accepted without calling this function.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Get the CertError parameter for the callback.

Get the RequestUrl parameter for the callback.

Get the SslInfo parameter for the callback.

Get the Callback parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called on the UI thread when a client certificate is being requested for authentication. Return false (0) to use the default behavior and automatically select the first certificate available. Return true (1) and call CfxSelectClientCertificateCallback.Select either in this function or at a later time to select a certificate. Do not call Select or call it with NULL to continue without using any certificate. |IsProxy| indicates whether the host is an HTTPS proxy or the origin server. |Host| and |Port| contains the hostname and port of the SSL server. |Certificates| is the list of certificates to choose from; this list has already been pruned by Chromium so that it only contains certificates from issuers that the server trusts.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the UI thread when a client certificate is being requested for authentication. Return false (0) to use the default behavior and automatically select the first certificate available. Return true (1) and call CfxSelectClientCertificateCallback.Select either in this function or at a later time to select a certificate. Do not call Select or call it with NULL to continue without using any certificate. |IsProxy| indicates whether the host is an HTTPS proxy or the origin server. |Host| and |Port| contains the hostname and port of the SSL server. |Certificates| is the list of certificates to choose from; this list has already been pruned by Chromium so that it only contains certificates from issuers that the server trusts.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Get the IsProxy parameter for the callback.

Get the Host parameter for the callback.

Get the Port parameter for the callback.

Get the Certificates parameter for the callback.

Get the Callback parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called on the browser process UI thread when a plugin has crashed. |PluginPath| is the path of the plugin that crashed.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the browser process UI thread when a plugin has crashed. |PluginPath| is the path of the plugin that crashed.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Get the PluginPath parameter for the callback.

Called on the browser process UI thread when the render view associated with |Browser| is ready to receive/handle IPC messages in the render process.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the browser process UI thread when the render view associated with |Browser| is ready to receive/handle IPC messages in the render process.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Called on the browser process UI thread when the render process terminates unexpectedly. |Status| indicates how the process terminated.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the browser process UI thread when the render process terminates unexpectedly. |Status| indicates how the process terminated.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Get the Browser parameter for the callback.

Get the Status parameter for the callback.

Called on the UI thread after the ResolveHost request has completed. |Result| will be the result code. |ResolvedIps| will be the list of resolved IP addresses or NULL if the resolution failed.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Called on the UI thread after the ResolveHost request has completed. |Result| will be the result code. |ResolvedIps| will be the list of resolved IP addresses or NULL if the resolution failed.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Get the Result parameter for the callback.

Get the ResolvedIps parameter for the callback.

Called to retrieve a localized translation for the specified |StringId|. To provide the translation set |String| to the translation string and return true (1). To use the default translation return false (0). Include cef_pack_strings.h for a listing of valid string ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Called to retrieve a localized translation for the specified |StringId|. To provide the translation set |String| to the translation string and return true (1). To use the default translation return false (0). Include cef_pack_strings.h for a listing of valid string ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Get the StringId parameter for the callback.

Set the String out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called to retrieve data for the specified scale independent |ResourceId|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Called to retrieve data for the specified scale independent |ResourceId|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Get the ResourceId parameter for the callback.

Set the Data out parameter for the callback.

Set the DataSize out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called to retrieve data for the specified |ResourceId| nearest the scale factor |ScaleFactor|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Called to retrieve data for the specified |ResourceId| nearest the scale factor |ScaleFactor|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Get the ResourceId parameter for the callback.

Get the ScaleFactor parameter for the callback.

Set the Data out parameter for the callback.

Set the DataSize out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Begin processing the request. To handle the request return true (1) and call CfxCallback.Continue() once the response header information is available (CfxCallback.Continue() can also be called from inside this function if header information is available immediately). To cancel the request return false (0).

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Begin processing the request. To handle the request return true (1) and call CfxCallback.Continue() once the response header information is available (CfxCallback.Continue() can also be called from inside this function if header information is available immediately). To cancel the request return false (0).

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Get the Request parameter for the callback.

Get the Callback parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Retrieve response header information. If the response length is not known set |ResponseLength| to -1 and read_response() will be called until it returns false (0). If the response length is known set |ResponseLength| to a positive value and read_response() will be called until it returns false (0) or the specified number of bytes have been read. Use the |Response| object to set the mime type, http status code and other optional header values. To redirect the request to a new URL set |RedirectUrl| to the new URL. If an error occured while setting up the request you can call set_error() on |Response| to indicate the error condition.

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Retrieve response header information. If the response length is not known set |ResponseLength| to -1 and read_response() will be called until it returns false (0). If the response length is known set |ResponseLength| to a positive value and read_response() will be called until it returns false (0) or the specified number of bytes have been read. Use the |Response| object to set the mime type, http status code and other optional header values. To redirect the request to a new URL set |RedirectUrl| to the new URL. If an error occured while setting up the request you can call set_error() on |Response| to indicate the error condition.

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Get the Response parameter for the callback.

Set the ResponseLength out parameter for the callback.

Set the RedirectUrl out parameter for the callback.

Read response data. If data is available immediately copy up to |BytesToRead| bytes into |DataOut|, set |BytesRead| to the number of bytes copied, and return true (1). To read the data at a later time set |BytesRead| to 0, return true (1) and call CfxCallback.Continue() when the data is available. To indicate response completion return false (0).

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Read response data. If data is available immediately copy up to |BytesToRead| bytes into |DataOut|, set |BytesRead| to the number of bytes copied, and return true (1). To read the data at a later time set |BytesRead| to 0, return true (1) and call CfxCallback.Continue() when the data is available. To indicate response completion return false (0).

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Get the DataOut parameter for the callback.

Get the BytesToRead parameter for the callback.

Set the BytesRead out parameter for the callback.

Get the Callback parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return true (1) if the specified cookie can be sent with the request or false (0) otherwise. If false (0) is returned for any cookie then no cookies will be sent with the request.

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Return true (1) if the specified cookie can be sent with the request or false (0) otherwise. If false (0) is returned for any cookie then no cookies will be sent with the request.

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Get the Cookie parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return true (1) if the specified cookie returned with the response can be set or false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Return true (1) if the specified cookie returned with the response can be set or false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Get the Cookie parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Initialize the response filter. Will only be called a single time. The filter will not be installed if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_response_filter_capi.h.

Initialize the response filter. Will only be called a single time. The filter will not be installed if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_response_filter_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called to filter a chunk of data. Expected usage is as follows: A. Read input data from |DataIn| and set |DataInRead| to the number of bytes that were read up to a maximum of |DataInSize|. |DataIn| will be NULL if |DataInSize| is zero. B. Write filtered output data to |DataOut| and set |DataOutWritten| to the number of bytes that were written up to a maximum of |DataOutSize|. If no output data was written then all data must be read from |DataIn| (user must set |DataInRead| = |DataInSize|). C. Return RESPONSE_FILTER_DONE if all output data was written or RESPONSE_FILTER_NEED_MORE_DATA if output data is still pending. This function will be called repeatedly until the input buffer has been fully read (user sets |DataInRead| = |DataInSize|) and there is no more input data to filter (the resource response is complete). This function may then be called an additional time with an NULL input buffer if the user filled the output buffer (set |DataOutWritten| = |DataOutSize|) and returned RESPONSE_FILTER_NEED_MORE_DATA to indicate that output data is still pending. Calls to this function will stop when one of the following conditions is met: A. There is no more input data to filter (the resource response is complete) and the user sets |DataOutWritten| = 0 or returns RESPONSE_FILTER_DONE to indicate that all data has been written, or; B. The user returns RESPONSE_FILTER_ERROR to indicate an error. Do not keep a reference to the buffers passed to this function.

See also the original CEF documentation in cef/include/capi/cef_response_filter_capi.h.

Called to filter a chunk of data. Expected usage is as follows: A. Read input data from |DataIn| and set |DataInRead| to the number of bytes that were read up to a maximum of |DataInSize|. |DataIn| will be NULL if |DataInSize| is zero. B. Write filtered output data to |DataOut| and set |DataOutWritten| to the number of bytes that were written up to a maximum of |DataOutSize|. If no output data was written then all data must be read from |DataIn| (user must set |DataInRead| = |DataInSize|). C. Return RESPONSE_FILTER_DONE if all output data was written or RESPONSE_FILTER_NEED_MORE_DATA if output data is still pending. This function will be called repeatedly until the input buffer has been fully read (user sets |DataInRead| = |DataInSize|) and there is no more input data to filter (the resource response is complete). This function may then be called an additional time with an NULL input buffer if the user filled the output buffer (set |DataOutWritten| = |DataOutSize|) and returned RESPONSE_FILTER_NEED_MORE_DATA to indicate that output data is still pending. Calls to this function will stop when one of the following conditions is met: A. There is no more input data to filter (the resource response is complete) and the user sets |DataOutWritten| = 0 or returns RESPONSE_FILTER_DONE to indicate that all data has been written, or; B. The user returns RESPONSE_FILTER_ERROR to indicate an error. Do not keep a reference to the buffers passed to this function.

See also the original CEF documentation in cef/include/capi/cef_response_filter_capi.h.

Get the DataIn parameter for the callback.

Get the DataInSize parameter for the callback.

Set the DataInRead out parameter for the callback.

Get the DataOut parameter for the callback.

Get the DataOutSize parameter for the callback.

Set the DataOutWritten out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called asynchronously after the file dialog is dismissed. |SelectedAcceptFilter| is the 0-based index of the value selected from the accept filters array passed to CfxBrowserHost.RunFileDialog. |FilePaths| will be a single value or a list of values depending on the dialog mode. If the selection was cancelled |FilePaths| will be NULL.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Called asynchronously after the file dialog is dismissed. |SelectedAcceptFilter| is the 0-based index of the value selected from the accept filters array passed to CfxBrowserHost.RunFileDialog. |FilePaths| will be a single value or a list of values depending on the dialog mode. If the selection was cancelled |FilePaths| will be NULL.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Get the SelectedAcceptFilter parameter for the callback.

Get the FilePaths parameter for the callback.

Return a new resource handler instance to handle the request or an NULL reference to allow default handling of the request. |Browser| and |Frame| will be the browser window and frame respectively that originated the request or NULL if the request did not originate from a browser window (for example, if the request came from CfxUrlRequest). The |Request| object passed to this function will not contain cookie data.

See also the original CEF documentation in cef/include/capi/cef_scheme_capi.h.

Return a new resource handler instance to handle the request or an NULL reference to allow default handling of the request. |Browser| and |Frame| will be the browser window and frame respectively that originated the request or NULL if the request did not originate from a browser window (for example, if the request came from CfxUrlRequest). The |Request| object passed to this function will not contain cookie data.

See also the original CEF documentation in cef/include/capi/cef_scheme_capi.h.

Get the Browser parameter for the callback.

Get the Frame parameter for the callback.

Get the SchemeName parameter for the callback.

Get the Request parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Method that will be called upon completion. |Success| will be true (1) if the cookie was set successfully.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Method that will be called upon completion. |Success| will be true (1) if the cookie was set successfully.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Get the Success parameter for the callback.

Method that will be executed.

See also the original CEF documentation in cef/include/capi/cef_string_visitor_capi.h.

Method that will be executed.

See also the original CEF documentation in cef/include/capi/cef_string_visitor_capi.h.

Get the String parameter for the callback.

Notifies the client that the request has completed. Use the CfxUrlRequest.GetRequestStatus function to determine if the request was successful or not.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Notifies the client that the request has completed. Use the CfxUrlRequest.GetRequestStatus function to determine if the request was successful or not.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Get the Request parameter for the callback.

Notifies the client of upload progress. |Current| denotes the number of bytes sent so far and |Total| is the total size of uploading data (or -1 if chunked upload is enabled). This function will only be called if the UR_FLAG_REPORT_UPLOAD_PROGRESS flag is set on the request.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Notifies the client of upload progress. |Current| denotes the number of bytes sent so far and |Total| is the total size of uploading data (or -1 if chunked upload is enabled). This function will only be called if the UR_FLAG_REPORT_UPLOAD_PROGRESS flag is set on the request.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Get the Request parameter for the callback.

Get the Current parameter for the callback.

Get the Total parameter for the callback.

Notifies the client of download progress. |Current| denotes the number of bytes received up to the call and |Total| is the expected total size of the response (or -1 if not determined).

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Notifies the client of download progress. |Current| denotes the number of bytes received up to the call and |Total| is the expected total size of the response (or -1 if not determined).

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Get the Request parameter for the callback.

Get the Current parameter for the callback.

Get the Total parameter for the callback.

Called when some part of the response is read. |Data| contains the current bytes received since the last call. This function will not be called if the UR_FLAG_NO_DOWNLOAD_DATA flag is set on the request.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Called when some part of the response is read. |Data| contains the current bytes received since the last call. This function will not be called if the UR_FLAG_NO_DOWNLOAD_DATA flag is set on the request.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Get the Request parameter for the callback.

Get the Data parameter for the callback.

Get the DataLength parameter for the callback.

Called on the IO thread when the browser needs credentials from the user. |IsProxy| indicates whether the host is a proxy server. |Host| contains the hostname and |Port| contains the port number. Return true (1) to continue the request and call CfxAuthCallback.Continue() when the authentication information is available. Return false (0) to cancel the request. This function will only be called for requests initiated from the browser process.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Called on the IO thread when the browser needs credentials from the user. |IsProxy| indicates whether the host is a proxy server. |Host| contains the hostname and |Port| contains the port number. Return true (1) to continue the request and call CfxAuthCallback.Continue() when the authentication information is available. Return false (0) to cancel the request. This function will only be called for requests initiated from the browser process.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Get the IsProxy parameter for the callback.

Get the Host parameter for the callback.

Get the Port parameter for the callback.

Get the Realm parameter for the callback.

Get the Scheme parameter for the callback.

Get the Callback parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Handle retrieval the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. If retrieval succeeds set |Retval| to the return value. If retrieval fails set |Exception| to the exception that will be thrown. Return true (1) if accessor retrieval was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle retrieval the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. If retrieval succeeds set |Retval| to the return value. If retrieval fails set |Exception| to the exception that will be thrown. Return true (1) if accessor retrieval was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Get the Name parameter for the callback.

Get the Object parameter for the callback.

Set the Retval out parameter for the callback.

Set the Exception out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Handle assignment of the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. |Value| is the new value being assigned to the accessor. If assignment fails set |Exception| to the exception that will be thrown. Return true (1) if accessor assignment was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle assignment of the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. |Value| is the new value being assigned to the accessor. If assignment fails set |Exception| to the exception that will be thrown. Return true (1) if accessor assignment was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Get the Name parameter for the callback.

Get the Object parameter for the callback.

Get the Value parameter for the callback.

Set the Exception out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Handle execution of the function identified by |Name|. |Object| is the receiver ('this' object) of the function. |Arguments| is the list of arguments passed to the function. If execution succeeds set |Retval| to the function return value. If execution fails set |Exception| to the exception that will be thrown. Return true (1) if execution was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle execution of the function identified by |Name|. |Object| is the receiver ('this' object) of the function. |Arguments| is the list of arguments passed to the function. If execution succeeds set |Retval| to the function return value. If execution fails set |Exception| to the exception that will be thrown. Return true (1) if execution was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Get the Name parameter for the callback.

Get the Object parameter for the callback.

Get the Arguments parameter for the callback.

Set the Exception out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Handle retrieval of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. If the property has an associated accessor, it will be called only if you don't set |Retval|. Return true (1) if interceptor retrieval was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle retrieval of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. If the property has an associated accessor, it will be called only if you don't set |Retval|. Return true (1) if interceptor retrieval was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Get the Name parameter for the callback.

Get the Object parameter for the callback.

Set the Retval out parameter for the callback.

Set the Exception out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Handle retrieval of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor retrieval was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle retrieval of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor retrieval was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Get the Index parameter for the callback.

Get the Object parameter for the callback.

Set the Retval out parameter for the callback.

Set the Exception out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Handle assignment of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. This setter will always be called, even when the property has an associated accessor. Return true (1) if interceptor assignment was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle assignment of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. This setter will always be called, even when the property has an associated accessor. Return true (1) if interceptor assignment was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Get the Name parameter for the callback.

Get the Object parameter for the callback.

Get the Value parameter for the callback.

Set the Exception out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Handle assignment of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor assignment was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle assignment of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor assignment was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Get the Index parameter for the callback.

Get the Object parameter for the callback.

Get the Value parameter for the callback.

Set the Exception out parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Method that will be called once for each plugin. |Count| is the 0-based index for the current plugin. |Total| is the total number of plugins. Return false (0) to stop visiting plugins. This function may never be called if no plugins are found.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Method that will be called once for each plugin. |Count| is the 0-based index for the current plugin. |Total| is the total number of plugins. Return false (0) to stop visiting plugins. This function may never be called if no plugins are found.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Get the Info parameter for the callback.

Get the Count parameter for the callback.

Get the Total parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Method that will be called for the requested plugin. |Unstable| will be true (1) if the plugin has reached the crash count threshold of 3 times in 120 seconds.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Method that will be called for the requested plugin. |Unstable| will be true (1) if the plugin has reached the crash count threshold of 3 times in 120 seconds.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Get the Path parameter for the callback.

Get the Unstable parameter for the callback.

Write raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Write raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Get the Ptr parameter for the callback.

Get the Size parameter for the callback.

Get the N parameter for the callback.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Flush the stream.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Flush the stream.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Set the return value for the callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Implement this structure to provide handler implementations. Methods will be called by the process and/or thread indicated.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Provides an opportunity to view and/or modify command-line arguments before processing by CEF and Chromium. The |ProcessType| value will be NULL for the browser process. Do not keep a reference to the CfxCommandLine object passed to this function. The CfxSettings.CommandLineArgsDisabled value can be used to start with an NULL command-line object. Any values specified in CfxSettings that equate to command-line arguments will be set before this function is called. Be cautious when using this function to modify command-line arguments for non-browser processes as this may result in undefined behavior including crashes.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Provides an opportunity to register custom schemes. Do not keep a reference to the |Registrar| object. This function is called on the main thread for each process and the registered schemes should be the same across all processes.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Return the handler for resource bundle events. If CfxSettings.PackLoadingDisabled is true (1) a handler must be returned. If no handler is returned resources will be loaded from pack files. This function is called by the browser and render processes on multiple threads.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Retrieves the CfxResourceBundleHandler provided by the event handler attached to the GetResourceBundleHandler event, if any. Returns null if no event handler is attached.

Return the handler for functionality specific to the browser process. This function is called on multiple threads in the browser process.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Retrieves the CfxBrowserProcessHandler provided by the event handler attached to the GetBrowserProcessHandler event, if any. Returns null if no event handler is attached.

Return the handler for functionality specific to the render process. This function is called on the render process main thread.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Retrieves the CfxRenderProcessHandler provided by the event handler attached to the GetRenderProcessHandler event, if any. Returns null if no event handler is attached.

Callback structure used for asynchronous continuation of authentication requests.

See also the original CEF documentation in cef/include/capi/cef_auth_callback_capi.h.

Continue the authentication request.

See also the original CEF documentation in cef/include/capi/cef_auth_callback_capi.h.

Cancel the authentication request.

See also the original CEF documentation in cef/include/capi/cef_auth_callback_capi.h.

Callback structure used to asynchronously continue a download.

See also the original CEF documentation in cef/include/capi/cef_download_handler_capi.h.

Call to continue the download. Set |downloadPath| to the full file path for the download including the file name or leave blank to use the suggested name and the default temp directory. Set |showDialog| to true (1) if you do wish to show the default "Save As" dialog.

See also the original CEF documentation in cef/include/capi/cef_download_handler_capi.h.

Structure representing a binary value. Can be used on any process and thread.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Creates a new object that is not owned by any other object. The specified |data| will be copied.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object is valid. This object may become invalid if the underlying data is owned by another object (e.g. list or dictionary) and that other object is then modified or destroyed. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object is currently owned by another object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the data size.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have the same underlying data.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have an equivalent underlying value but are not necessarily the same object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns a copy of this object. The data in this object will also be copied.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Read up to |bufferSize| number of bytes into |buffer|. Reading begins at the specified byte |dataOffset|. Returns the number of bytes read.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Creates a new object that is not owned by any other object. The specified |data| will be copied.

Read up to (buffer.Length - bufferOffset) bytes into |buffer|. Reading begins at the specified byte dataOffset. Writing begins at the specified byte bufferOffset. Returns the number of bytes read.

Settings used when initializing a CfxBoxLayout.

See also the original CEF documentation in cef/include/internal/cef_types.h.

If true (1) the layout will be horizontal, otherwise the layout will be vertical.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Adds additional horizontal space between the child view area and the host view border.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Adds additional vertical space between the child view area and the host view border.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Adds additional space around the child view area.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Adds additional space between child views.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Specifies where along the main axis the child views should be laid out.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Specifies where along the cross axis the child views should be laid out.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Minimum cross axis size.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Default flex for views when none is specified via CfxBoxLayout methods. Using the preferred size as the basis, free space along the main axis is distributed to views in the ratio of their flex weights. Similarly, if the views will overflow the parent, space is subtracted in these ratios. A flex of 0 means this view is not resized. Flex values must not be negative.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Structure used to represent a 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.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the browser host object. This function can only be called in the browser process.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns true (1) if the browser can navigate backwards.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns true (1) if the browser can navigate forwards.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns true (1) if the browser is currently loading.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the globally unique identifier for this browser. This value is also used as the tabId for extension APIs.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns true (1) if the window is a popup window.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns true (1) if a document has been loaded in the browser.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the main (top-level) frame for the browser window.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the focused frame for the browser window.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the number of frames that currently exist.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the identifiers of all existing frames.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Navigate backwards.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Navigate forwards.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Reload the current page.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Reload the current page ignoring any cached data.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Stop loading the page.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns true (1) if this object is pointing to the same handle as |that| object.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the frame with the specified identifier, or NULL if not found.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the frame with the specified name, or NULL if not found.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the names of all existing frames.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Send a message to the specified |targetProcess|. Returns true (1) if the message was sent successfully.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Structure used to represent the browser process aspects of a browser window. 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.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Create a new browser window using the window parameters specified by |windowInfo|. All values will be copied internally and the actual window will be created on the UI thread. If |requestContext| is NULL the global request context will be used. This function can be called on any browser process thread and will not block.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Create a new browser window using the window parameters specified by |windowInfo|. If |requestContext| is NULL the global request context will be used. This function can only be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the hosted browser object.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Retrieve the window handle for this browser. If this browser is wrapped in a CfxBrowserView this function should be called on the browser process UI thread and it will return the handle for the top-level native window.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Retrieve the window handle of the browser that opened this browser. Will return NULL for non-popup windows or if this browser is wrapped in a CfxBrowserView. This function can be used in combination with custom handling of modal windows.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the client for this browser.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the request context for this browser.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Get the current zoom level. The default zoom level is 0.0. This function can only be called on the UI thread. Change the zoom level to the specified value. Specify 0.0 to reset the zoom level. If called on the UI thread the change will be applied immediately. Otherwise, the change will be applied asynchronously on the UI thread.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns true (1) if mouse cursor change is disabled.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns true (1) if window rendering is disabled.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the maximum rate in frames per second (fps) that CfxRenderHandler:: OnPaint will be called for a windowless browser. The actual fps may be lower if the browser cannot generate frames at the requested rate. The minimum value is 1 and the maximum value is 60 (default 30). This function can only be called on the UI thread. Set the maximum rate in frames per second (fps) that CfxRenderHandler:: OnPaint will be called for a windowless browser. The actual fps may be lower if the browser cannot generate frames at the requested rate. The minimum value is 1 and the maximum value is 60 (default 30). Can also be set at browser creation via CfxBrowserSettings.WindowlessFrameRate.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Set whether the browser is focused.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Download the file at |url| using CfxDownloadHandler.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Print the current browser contents.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Print the current browser contents to the PDF file specified by |path| and execute |callback| on completion. The caller is responsible for deleting |path| when done. For PDF printing to work on Linux you must implement the CfxPrintHandler.GetPdfPaperSize function.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Search for |searchText|. |identifier| must be a unique ID and these IDs must strictly increase so that newer requests always have greater IDs than older requests. If |identifier| is zero or less than the previous ID value then it will be automatically assigned a new valid ID. |forward| indicates whether to search forward or backward within the page. |matchCase| indicates whether the search should be case-sensitive. |findNext| indicates whether this is the first request or a follow-up. The CfxFindHandler instance, if any, returned via CfxClient.GetFindHandler will be called to report find results.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Cancel all searches that are currently going on.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Explicitly close the associated DevTools browser, if any.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Retrieve a snapshot of current navigation entries as values sent to the specified visitor. If |currentOnly| is true (1) only the current navigation entry will be sent, otherwise all navigation entries will be sent.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Set whether mouse cursor change is disabled.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Add the specified |word| to the spelling dictionary.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Notify the browser that it has been hidden or shown. Layouting and CfxRenderHandler.OnPaint notification will stop when the browser is hidden. This function is only used when window rendering is disabled.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Send a key event to the browser.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Send a mouse wheel event to the browser. The |x| and |y| coordinates are relative to the upper-left corner of the view. The |deltaX| and |deltaY| values represent the movement delta in the X and Y directions respectively. In order to scroll inside select popups with window rendering disabled CfxRenderHandler.GetScreenPoint should be implemented properly.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Send a focus event to the browser.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Send a capture lost event to the browser.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Completes the existing composition by optionally inserting the specified |text| into the composition node. |replacementRange| is an optional range of the existing text that will be replaced. |relativeCursorPos| is where the cursor will be positioned relative to the current cursor position. See comments on ImeSetComposition for usage. The |replacementRange| and |relativeCursorPos| values are only used on OS X. This function is only used when window rendering is disabled.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Call this function when the user drags the mouse into the web view (before calling DragTargetDragOver/DragTargetLeave/DragTargetDrop). |dragData| should not contain file contents as this type of data is not allowed to be dragged into the web view. File contents can be removed using CfxDragData.ResetFileContents (for example, if |dragData| comes from CfxRenderHandler.StartDragging). This function is only used when window rendering is disabled.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Call this function each time the mouse is moved across the web view during a drag operation (after calling DragTargetDragEnter and before calling DragTargetDragLeave/DragTargetDrop). This function is only used when window rendering is disabled.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Enable notifications of auto resize via CfxDisplayHandler.OnAutoResize. Notifications are disabled by default. |minSize| and |maxSize| define the range of allowed sizes.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Structure used to implement browser process callbacks. The functions of this structure will be called on the browser process main thread unless otherwise indicated.

See also the original CEF documentation in cef/include/capi/cef_browser_process_handler_capi.h.

Called on the browser process UI thread immediately after the CEF context has been initialized.

See also the original CEF documentation in cef/include/capi/cef_browser_process_handler_capi.h.

Called before a child process is launched. Will be called on the browser process UI thread when launching a render process and on the browser process IO thread when launching a GPU or plugin process. Provides an opportunity to modify the child process command line. Do not keep a reference to |CommandLine| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_browser_process_handler_capi.h.

Called on the browser process IO thread after the main thread has been created for a new render process. Provides an opportunity to specify extra information that will be passed to CfxRenderProcessHandler.OnRenderThreadCreated() in the render process. Do not keep a reference to |ExtraInfo| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_browser_process_handler_capi.h.

Return the handler for printing on Linux. If a print handler is not provided then printing will not be supported on the Linux platform.

See also the original CEF documentation in cef/include/capi/cef_browser_process_handler_capi.h.

Retrieves the CfxPrintHandler provided by the event handler attached to the GetPrintHandler event, if any. Returns null if no event handler is attached.

Called from any thread when work has been scheduled for the browser process main (UI) thread. This callback is used in combination with CfxSettings. external_message_pump and cef_do_message_loop_work() in cases where the CEF message loop must be integrated into an existing application message loop (see additional comments and warnings on CfxDoMessageLoopWork). This callback should schedule a cef_do_message_loop_work() call to happen on the main (UI) thread. |DelayMs| is the requested delay in milliseconds. If |DelayMs| is <= 0 then the call should happen reasonably soon. If |DelayMs| is > 0 then the call should be scheduled to happen after the specified delay and any currently pending scheduled call should be cancelled.

See also the original CEF documentation in cef/include/capi/cef_browser_process_handler_capi.h.

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.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The maximum rate in frames per second (fps) that CfxRenderHandler.OnPaint will be called for a windowless browser. The actual fps may be lower if the browser cannot generate frames at the requested rate. The minimum value is 1 and the maximum value is 60 (default 30). This value can also be changed dynamically via CfxBrowserHost.SetWindowlessFrameRate.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Font settings.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Default encoding for Web content. If empty "ISO-8859-1" will be used. Also configurable using the "default-encoding" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls the loading of fonts from remote sources. Also configurable using the "disable-remote-fonts" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether JavaScript can be executed. Also configurable using the "disable-javascript" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether JavaScript can be used to close windows that were not opened via JavaScript. JavaScript can still be used to close windows that were opened via JavaScript or that have no back/forward history. Also configurable using the "disable-javascript-close-windows" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether JavaScript can access the clipboard. Also configurable using the "disable-javascript-access-clipboard" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether DOM pasting is supported in the editor via execCommand("paste"). The |javascriptAccessClipboard| setting must also be enabled. Also configurable using the "disable-javascript-dom-paste" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether any plugins will be loaded. Also configurable using the "disable-plugins" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether file URLs will have access to all URLs. Also configurable using the "allow-universal-access-from-files" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether file URLs will have access to other file URLs. Also configurable using the "allow-access-from-files" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether web security restrictions (same-origin policy) will be enforced. Disabling this setting is not recommend as it will allow risky security behavior such as cross-site scripting (XSS). Also configurable using the "disable-web-security" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether image URLs will be loaded from the network. A cached image will still be rendered if requested. Also configurable using the "disable-image-loading" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether standalone images will be shrunk to fit the page. Also configurable using the "image-shrink-standalone-to-fit" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether text areas can be resized. Also configurable using the "disable-text-area-resize" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether the tab key can advance focus to links. Also configurable using the "disable-tab-to-links" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether local storage can be used. Also configurable using the "disable-local-storage" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether databases can be used. Also configurable using the "disable-databases" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether the application cache can be used. Also configurable using the "disable-application-cache" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Controls whether WebGL can be used. Note that WebGL requires hardware support and may not work on all systems even when enabled. Also configurable using the "disable-webgl" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Background color used for the browser before a document is loaded and when no document color is specified. The alpha component must be either fully opaque (0xFF) or fully transparent (0x00). If the alpha component is fully opaque then the RGB components will be used as the background color. If the alpha component is fully transparent for a windowed browser then the CfxSettings.BackgroundColor value will be used. If the alpha component is fully transparent for a windowless (off-screen) browser then transparent painting will be enabled.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Comma delimited ordered list of language codes without any whitespace that will be used in the "Accept-Language" HTTP header. May be set globally using the CfxBrowserSettings.AcceptLanguageList value. If both values are empty then "en-US,en" will be used.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Generic callback structure used for asynchronous continuation.

See also the original CEF documentation in cef/include/capi/cef_callback_capi.h.

Continue processing.

See also the original CEF documentation in cef/include/capi/cef_callback_capi.h.

Cancel processing.

See also the original CEF documentation in cef/include/capi/cef_callback_capi.h.

Implement this structure to provide handler implementations.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Return the handler for context menus. If no handler is provided the default implementation will be used.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Retrieves the CfxContextMenuHandler provided by the event handler attached to the GetContextMenuHandler event, if any. Returns null if no event handler is attached.

Return the handler for dialogs. If no handler is provided the default implementation will be used.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Retrieves the CfxDialogHandler provided by the event handler attached to the GetDialogHandler event, if any. Returns null if no event handler is attached.

Return the handler for browser display state events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Retrieves the CfxDisplayHandler provided by the event handler attached to the GetDisplayHandler event, if any. Returns null if no event handler is attached.

Return the handler for download events. If no handler is returned downloads will not be allowed.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Retrieves the CfxDownloadHandler provided by the event handler attached to the GetDownloadHandler event, if any. Returns null if no event handler is attached.

Return the handler for drag events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Retrieves the CfxDragHandler provided by the event handler attached to the GetDragHandler event, if any. Returns null if no event handler is attached.

Return the handler for find result events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Retrieves the CfxFindHandler provided by the event handler attached to the GetFindHandler event, if any. Returns null if no event handler is attached.

Return the handler for focus events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Retrieves the CfxFocusHandler provided by the event handler attached to the GetFocusHandler event, if any. Returns null if no event handler is attached.

Return the handler for geolocation permissions requests. If no handler is provided geolocation access will be denied by default.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Retrieves the CfxGeolocationHandler provided by the event handler attached to the GetGeolocationHandler event, if any. Returns null if no event handler is attached.

Return the handler for JavaScript dialogs. If no handler is provided the default implementation will be used.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Retrieves the CfxJsDialogHandler provided by the event handler attached to the GetJsDialogHandler event, if any. Returns null if no event handler is attached.

Return the handler for keyboard events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Retrieves the CfxKeyboardHandler provided by the event handler attached to the GetKeyboardHandler event, if any. Returns null if no event handler is attached.

Return the handler for browser life span events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Retrieves the CfxLifeSpanHandler provided by the event handler attached to the GetLifeSpanHandler event, if any. Returns null if no event handler is attached.

Return the handler for browser load status events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Retrieves the CfxLoadHandler provided by the event handler attached to the GetLoadHandler event, if any. Returns null if no event handler is attached.

Return the handler for off-screen rendering events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Retrieves the CfxRenderHandler provided by the event handler attached to the GetRenderHandler event, if any. Returns null if no event handler is attached.

Return the handler for browser request events.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

Retrieves the CfxRequestHandler provided by the event handler attached to the GetRequestHandler event, if any. Returns null if no event handler is attached.

Called when a new message is received from a different process. Return true (1) if the message was handled or false (0) otherwise. Do not keep a reference to or attempt to access the message outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_client_capi.h.

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 are considered case-insensitive. This structure can be used before cef_initialize() is called.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Create a new CfxCommandLine instance.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns the singleton global CfxCommandLine object. The returned object will be read-only.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns true (1) if this object is valid. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns true (1) if the values of this object are read-only. Some APIs may expose read-only objects.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Constructs and returns the represented command line string. Use this function cautiously because quoting behavior is unclear.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Get or set the program part of the command line string (the first item).

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns true (1) if the command line has switches.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

True if there are remaining command line arguments.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns a writable copy of this object.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Initialize the command line with the specified |argc| and |argv| values. The first argument must be the name of the program. This function is only supported on non-Windows platforms.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Initialize the command line with the string returned by calling GetCommandLineW(). This function is only supported on Windows.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Reset the command-line switches and arguments but leave the program component unchanged.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Retrieve the original command line string as a vector of strings. The argv array: { program, [(--|-|/)switch[=value]]*, [--], [argument]* }

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns true (1) if the command line contains the given switch.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns the value associated with the given switch. If the switch has no value or isn't present this function returns the NULL string.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns the map of switch names and values. If a switch has no value an NULL string is returned.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Add a switch to the end of the command line. If the switch has no value pass an NULL value string.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Add a switch with the specified value to the end of the command line.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Get the remaining command line arguments.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Add an argument to the end of the command line.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Insert a command before the current command. Common for debuggers, like "valgrind" or "gdb --args".

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Generic callback structure used for asynchronous completion.

See also the original CEF documentation in cef/include/capi/cef_callback_capi.h.

Method that will be called once the task is complete.

See also the original CEF documentation in cef/include/capi/cef_callback_capi.h.

Structure representing IME composition underline information. This is a thin wrapper around Blink's WebCompositionUnderline class and should be kept in sync with that.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Underline character range.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Text color.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Background color.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) for thick underline.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Implement this structure to handle context menu events. The functions of this structure will be called on the UI thread.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Called before a context menu is displayed. |Params| provides information about the context menu state. |Model| initially contains the default context menu. The |Model| can be cleared to show no context menu or modified to show a custom menu. Do not keep references to |Params| or |Model| outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Called to allow custom display of the context menu. |Params| provides information about the context menu state. |Model| contains the context menu model resulting from OnBeforeContextMenu. For custom display return true (1) and execute |Callback| either synchronously or asynchronously with the selected command ID. For default display return false (0). Do not keep references to |Params| or |Model| outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Called to execute a command selected from the context menu. Return true (1) if the command was handled or false (0) for the default implementation. See CfxMenuId 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. |Params| will have the same values as what was passed to on_before_context_menu(). Do not keep a reference to |Params| outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Called when the context menu is dismissed irregardless of whether the menu was NULL or a command was selected.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Provides information about the context menu state. The ethods of this structure can only be accessed on browser process the UI thread.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns the X coordinate of the mouse where the context menu was invoked. Coords are relative to the associated RenderView's origin.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns the Y coordinate of the mouse where the context menu was invoked. Coords are relative to the associated RenderView's origin.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns flags representing the type of node that the context menu was invoked on.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns the URL of the link, if any, that encloses the node that the context menu was invoked on.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns the link URL, if any, to be used ONLY for "copy link address". We don't validate this field in the frontend process.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns the source URL, if any, for the element that the context menu was invoked on. Example of elements with source URLs are img, audio, and video.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns true (1) if the context menu was invoked on an image which has non- NULL contents.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns the title text or the alt text if the context menu was invoked on an image.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns the URL of the top level page that the context menu was invoked on.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns the URL of the subframe that the context menu was invoked on.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns the character encoding of the subframe that the context menu was invoked on.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns the type of context node that the context menu was invoked on.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns flags representing the actions supported by the media element, if any, that the context menu was invoked on.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns the text of the selection, if any, that the context menu was invoked on.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns the text of the misspelled word, if any, that the context menu was invoked on.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns true (1) if the context menu was invoked on an editable node.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns true (1) if the context menu was invoked on an editable node where spell-check is enabled.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns flags representing the actions supported by the editable node, if any, that the context menu was invoked on.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns true (1) if the context menu contains items specified by the renderer process (for example, plugin placeholder or pepper plugin menu items).

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns true (1) if the context menu was invoked from a pepper plugin.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Returns true (1) if suggestions exist, false (0) otherwise. Fills in |suggestions| from the spell check service for the misspelled word if there is one.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Cookie information.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The cookie name.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The cookie value.

See also the original CEF documentation in cef/include/internal/cef_types.h.

If |domain| is empty a host cookie will be created instead of a domain cookie. Domain cookies are stored with a leading "." and are visible to sub-domains whereas host cookies are not.

See also the original CEF documentation in cef/include/internal/cef_types.h.

If |path| is non-empty only URLs at or below the path will get the cookie value.

See also the original CEF documentation in cef/include/internal/cef_types.h.

If |secure| is true the cookie will only be sent for HTTPS requests.

See also the original CEF documentation in cef/include/internal/cef_types.h.

If |httpOnly| is true the cookie will only be sent for HTTP requests.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The cookie creation date. This is automatically populated by the system on cookie creation.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The cookie last access date. This is automatically populated by the system on access.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The cookie expiration date is only valid if |hasExpires| is true.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Structure used for managing cookies. The functions of this structure may be called on any thread unless otherwise indicated.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Returns the global cookie manager. By default data will be stored at CfxSettings.CachePath if specified or in memory otherwise. If |callback| is non-NULL it will be executed asnychronously on the IO thread after the manager's storage has been initialized. Using this function is equivalent to calling CfxRequestContext.CfxRequestContextGetGlobalContext()->get_d efault_cookie_manager().

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Creates a new cookie manager. If |path| is NULL data will be stored in memory only. Otherwise, data will be stored at the specified |path|. To persist session cookies (cookies without an expiry date or validity interval) set |persistSessionCookies| to true (1). Session cookies are generally intended to be transient and most Web browsers do not persist them. If |callback| is non-NULL it will be executed asnychronously on the IO thread after the manager's storage has been initialized.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Set the schemes supported by this manager. The default schemes ("http", "https", "ws" and "wss") will always be supported. If |callback| is non- NULL it will be executed asnychronously on the IO thread after the change has been applied. Must be called before any cookies are accessed.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Visit all cookies on the IO thread. The returned cookies are ordered by longest path, then by earliest creation date. Returns false (0) if cookies cannot be accessed.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Visit a subset of cookies on the IO thread. The results are filtered by the given url scheme, host, domain and path. If |includeHttpOnly| is true (1) HTTP-only cookies will also be included in the results. The returned cookies are ordered by longest path, then by earliest creation date. Returns false (0) if cookies cannot be accessed.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Sets a cookie given a valid URL and explicit user-provided cookie attributes. This function expects each attribute to be well-formed. It will check for disallowed characters (e.g. the ';' character is disallowed within the cookie value attribute) and fail without setting the cookie if such characters are found. If |callback| is non-NULL it will be executed asnychronously on the IO thread after the cookie has been set. Returns false (0) if an invalid URL is specified or if cookies cannot be accessed.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Delete all cookies that match the specified parameters. If both |url| and |cookieName| values are specified all host and domain cookies matching both will be deleted. If only |url| is specified all host cookies (but not domain cookies) irrespective of path will be deleted. If |url| is NULL all cookies for all hosts and domains will be deleted. If |callback| is non- NULL it will be executed asnychronously on the IO thread after the cookies have been deleted. Returns false (0) if a non-NULL invalid URL is specified or if cookies cannot be accessed. Cookies can alternately be deleted using the Visit*Cookies() functions.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Sets the directory path that will be used for storing cookie data. If |path| is NULL data will be stored in memory only. Otherwise, data will be stored at the specified |path|. To persist session cookies (cookies without an expiry date or validity interval) set |persistSessionCookies| to true (1). Session cookies are generally intended to be transient and most Web browsers do not persist them. If |callback| is non-NULL it will be executed asnychronously on the IO thread after the manager's storage has been initialized. Returns false (0) if cookies cannot be accessed.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Flush the backing store (if any) to disk. If |callback| is non-NULL it will be executed asnychronously on the IO thread after the flush is complete. Returns false (0) if cookies cannot be accessed.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Structure to implement for visiting cookie values. The functions of this structure will always be called on the IO thread.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Method that will be called once for each cookie. |Count| is the 0-based index for the current cookie. |Total| is the total number of cookies. Set |DeleteCookie| to true (1) to delete the cookie currently being visited. Return false (0) to stop visiting cookies. This function may never be called if no cookies are found.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

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.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Structure to implement to be notified of asynchronous completion via CfxCookieManager.DeleteCookies().

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Method that will be called upon completion. |NumDeleted| will be the number of cookies that were deleted or -1 if unknown.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Implement this structure to handle dialog events. The functions of this structure will be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_dialog_handler_capi.h.

Called to run a file chooser dialog. |Mode| represents the type of dialog to display. |Title| to the title to be used for the dialog and may be NULL to show the default title ("Open" or "Save" depending on the mode). |DefaultFilePath| is the path with optional directory and/or file name component that should be initially selected in the dialog. |AcceptFilters| are used to restrict the selectable file types and may any combination of (a) valid lower-cased MIME types (e.g. "text/*" or "image/*"), (b) individual file extensions (e.g. ".txt" or ".png"), or (c) combined description and file extension delimited using "|" and ";" (e.g. "Image Types|.png;.gif;.jpg"). |SelectedAcceptFilter| is the 0-based index of the filter that should be selected by default. To display a custom dialog return true (1) and execute |Callback| either inline or at a later time. To display the default dialog return false (0).

See also the original CEF documentation in cef/include/capi/cef_dialog_handler_capi.h.

Structure representing a dictionary value. Can be used on any process and thread.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Creates a new object that is not owned by any other object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object is valid. This object may become invalid if the underlying data is owned by another object (e.g. list or dictionary) and that other object is then modified or destroyed. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object is currently owned by another object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if the values of this object are read-only. Some APIs may expose read-only objects.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the number of values.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have the same underlying data. If true (1) modifications to this object will also affect |that| object and vice-versa.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have an equivalent underlying value but are not necessarily the same object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns a writable copy of this object. If |excludeNullChildren| is true (1) any NULL dictionaries or lists will be excluded from the copy.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Removes all values. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if the current dictionary has a value for the given key.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Reads all keys for this dictionary into the specified vector.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Removes the value at the specified key. Returns true (1) is the value was removed successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value type for the specified key.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key. For simple types the returned value will copy existing data and modifications to the value will not modify this object. For complex types (binary, dictionary and list) the returned value will reference existing data and modifications to the value will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key as type bool.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key as type int.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key as type double.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key as type string.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key as type binary. The returned value will reference existing data.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key as type dictionary. The returned value will reference existing data and modifications to the value will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key as type list. The returned value will reference existing data and modifications to the value will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key. Returns true (1) if the value was set successfully. If |value| represents simple data then the underlying data will be copied and modifications to |value| will not modify this object. If |value| represents complex data (binary, dictionary or list) then the underlying data will be referenced and modifications to |value| will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type null. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type bool. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type int. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type double. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type string. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type binary. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type dict. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type list. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Implement this structure to handle events related to browser display state. The functions of this structure will be called on the UI thread.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called when a frame's address has changed.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called when the page title changes.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called when the page icon changes.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called when web content in the page has toggled fullscreen mode. If |Fullscreen| is true (1) the content will automatically be sized to fill the browser content area. If |Fullscreen| is false (0) the content will automatically return to its original size and position. The client is responsible for resizing the browser if desired.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called when the browser is about to display a tooltip. |Text| contains the text that will be displayed in the tooltip. To handle the display of the tooltip yourself return true (1). Otherwise, you can optionally modify |Text| and then return false (0) to allow the browser to display the tooltip. When window rendering is disabled the application is responsible for drawing tooltips and the return value is ignored.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called when the browser receives a status message. |Value| contains the text that will be displayed in the status message.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called to display a console message. Return true (1) to stop the message from being output to the console.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Called when auto-resize is enabled via CfxBrowserHost.SetAutoResizeEnabled and the contents have auto- resized. |NewSize| will be the desired size in view coordinates. Return true (1) if the resize was handled or false (0) for default handling.

See also the original CEF documentation in cef/include/capi/cef_display_handler_capi.h.

Structure used to represent a DOM document. The functions of this structure should only be called on the render process main thread thread.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the document type.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the root document node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the BODY node of an HTML document.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the HEAD node of an HTML document.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the title of an HTML document.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the node that currently has keyboard focus.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if a portion of the document is selected.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the selection offset within the start node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the selection offset within the end node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the contents of this selection as markup.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the contents of this selection as text.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the base URL for the document.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the document element with the specified ID value.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns a complete URL based on the document base URL and the specified partial URL.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Structure used to represent a DOM node. The functions of this structure should only be called on the render process main thread.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the type for this node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this is a text node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this is an element node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this is an editable node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this is a form control element node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the type of this form control element node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the name of this node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the value of this node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the contents of this node as markup.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the document associated with this node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the parent node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the previous sibling node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the next sibling node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this node has child nodes.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Return the first child node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the last child node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the tag name of this element.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this element has attributes.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the inner text of the element.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the bounds of the element.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this object is pointing to the same handle as |that| object.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Set the value of this node. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this element has an attribute named |attrName|.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the element attribute named |attrName|.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns a map of all element attributes.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Set the value for the element attribute named |attrName|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Structure to implement for visiting the DOM. The functions of this structure will be called on the render process main thread.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Method executed for visiting the DOM. The document object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Structure used to handle file downloads. The functions of this structure will called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_download_handler_capi.h.

Called before a download begins. |SuggestedName| is the suggested name for the download file. By default the download will be canceled. Execute |Callback| either asynchronously or in this function to continue the download if desired. Do not keep a reference to |DownloadItem| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_download_handler_capi.h.

Called when a download's status or progress information has been updated. This may be called multiple times before and after on_before_download(). Execute |Callback| either asynchronously or in this function to cancel the download if desired. Do not keep a reference to |DownloadItem| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_download_handler_capi.h.

Callback structure for CfxBrowserHost.DownloadImage. The functions of this structure will be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Method that will be executed when the image download has completed. |ImageUrl| is the URL that was downloaded and |HttpStatusCode| is the resulting HTTP status code. |Image| is the resulting image, possibly at multiple scale factors, or NULL if the download failed.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Structure used to represent a download item.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns true (1) if this object is valid. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns true (1) if the download is in progress.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns true (1) if the download is complete.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns true (1) if the download has been canceled or interrupted.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns a simple speed estimate in bytes/s.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns the rough percent complete or -1 if the receive total size is unknown.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns the total number of bytes.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns the number of received bytes.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns the time that the download started.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns the time that the download ended.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns the full path to the downloaded or downloading file.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns the unique identifier for this download.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns the URL.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns the original URL before any redirections.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns the suggested file name.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns the content disposition.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Returns the mime type.

See also the original CEF documentation in cef/include/capi/cef_download_item_capi.h.

Callback structure used to asynchronously cancel a download.

See also the original CEF documentation in cef/include/capi/cef_download_handler_capi.h.

Call to cancel the download.

See also the original CEF documentation in cef/include/capi/cef_download_handler_capi.h.

Call to pause the download.

See also the original CEF documentation in cef/include/capi/cef_download_handler_capi.h.

Call to resume the download.

See also the original CEF documentation in cef/include/capi/cef_download_handler_capi.h.

Structure used to represent drag data. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Create a new CfxDragData object.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Returns true (1) if this object is read-only.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Returns true (1) if the drag data is a link.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Returns true (1) if the drag data is a text or html fragment.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Returns true (1) if the drag data is a file.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Return the link URL that is being dragged. Set the link URL that is being dragged.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Return the title associated with the link being dragged. Set the title associated with the link being dragged.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Return the metadata, if any, associated with the link being dragged. Set the metadata associated with the link being dragged.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Return the plain text fragment that is being dragged. Set the plain text fragment that is being dragged.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Return the text/html fragment that is being dragged. Set the text/html fragment that is being dragged.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Return the base URL that the fragment came from. This value is used for resolving relative URLs and may be NULL. Set the base URL that the fragment came from.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Return the name of the file being dragged out of the browser window.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Get the image representation of drag data. May return NULL if no image representation is available.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Get the image hotspot (drag start location relative to image dimensions).

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Returns true (1) if an image representation of drag data is available.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Returns a copy of the current object.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Write the contents of the file being dragged out of the web view into |writer|. Returns the number of bytes sent to |writer|. If |writer| is NULL this function will return the size of the file contents in bytes. Call get_file_name() to get a suggested name for the file.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Retrieve the list of file names that are being dragged into the browser window.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Reset the file contents. You should do this before calling CfxBrowserHost.DragTargetDragEnter as the web view does not allow us to drag in this kind of data.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Add a file that is being dragged into the webview.

See also the original CEF documentation in cef/include/capi/cef_drag_data_capi.h.

Structure representing a draggable region.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Bounds of the region.

See also the original CEF documentation in cef/include/internal/cef_types.h.

True (1) this this region is draggable and false (0) otherwise.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Implement this structure to handle events related to dragging. The functions of this structure will be called on the UI thread.

See also the original CEF documentation in cef/include/capi/cef_drag_handler_capi.h.

Called when an external drag event enters the browser window. |DragData| contains the drag event data and |Mask| represents the type of drag operation. Return false (0) for default drag handling behavior or true (1) to cancel the drag event.

See also the original CEF documentation in cef/include/capi/cef_drag_handler_capi.h.

Called whenever draggable regions for the browser window change. These can be specified using the '-webkit-app-region: drag/no-drag' CSS-property. If draggable regions are never defined in a document this function will also never be called. If the last draggable region is removed from a document this function will be called with an NULL vector.

See also the original CEF documentation in cef/include/capi/cef_drag_handler_capi.h.

Implement this structure to receive notification when tracing has completed. The functions of this structure will be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_trace_capi.h.

Called after all processes have sent their trace data. |TracingFile| is the path at which tracing data was written. The client is responsible for deleting |TracingFile|.

See also the original CEF documentation in cef/include/capi/cef_trace_capi.h.

Describes how to interpret the alpha component of a pixel.

See also the original CEF documentation in cef/include/internal/cef_types.h.

No transparency. The alpha component is ignored.

Transparency with pre-multiplied alpha component.

Transparency with post-multiplied alpha component.

Specifies the button display state.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Error codes for CDM registration. See cef_web_plugin.h for details.

See also the original CEF documentation in cef/include/internal/cef_types.h.

No error. Registration completed successfully.

Required files or manifest contents are missing.

The CDM is incompatible with the current Chromium version.

CDM registration is not supported at this time.

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.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Print job color mode values.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Describes how to interpret the components of a pixel.

See also the original CEF documentation in cef/include/internal/cef_types.h.

RGBA with 8 bits per pixel (32bits total).

BGRA with 8 bits per pixel (32bits total).

Windows COM initialization mode. Specifies how COM will be initialized for a new thread.

See also the original CEF documentation in cef/include/internal/cef_types.h.

No COM initialization.

Initialize COM using single-threaded apartments.

Initialize COM using multi-threaded apartments.

Supported context menu edit state bit flags.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Supported context menu media state bit flags.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Supported context menu media types.

See also the original CEF documentation in cef/include/internal/cef_types.h.

No special node is in context.

An image node is selected.

A video node is selected.

An audio node is selected.

A file node is selected.

A plugin node is selected.

Supported context menu type flags.

See also the original CEF documentation in cef/include/internal/cef_types.h.

No node is selected.

The top page is selected.

A subframe page is selected.

A link is selected.

A media node is selected.

There is a textual or mixed selection that is selected.

An editable element is selected.

Specifies where along the cross axis the CfxBoxLayout child views should be laid out.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Child views will be stretched to fit.

Child views will be left-aligned.

Child views will be center-aligned.

Child views will be right-aligned.

Cursor type values.

See also the original CEF documentation in cef/include/internal/cef_types.h.

DOM document types.

See also the original CEF documentation in cef/include/internal/cef_types.h.

DOM event category flags.

See also the original CEF documentation in cef/include/internal/cef_types.h.

DOM event processing phases.

See also the original CEF documentation in cef/include/internal/cef_types.h.

DOM node types.

See also the original CEF documentation in cef/include/internal/cef_types.h.

"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.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Print job duplex mode values.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Supported error code values. See net\base\net_error_list.h for complete descriptions of the error codes.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Supported event bit flags.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Supported file dialog modes.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Requires that the file exists before allowing the user to pick it.

Like Open, but allows picking multiple files to open.

Like Open, but selects a folder to open.

Allows picking a nonexistent file, and prompts to overwrite if the file already exists.

General mask defining the bits used for the type values.

Prompt to overwrite if the user selects an existing file with the Save dialog.

Do not display read-only files.

Focus sources.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The source is explicit navigation via the API (LoadURL(), etc).

The source is a system-generated focus event.

Geoposition error codes.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Specifies the horizontal text alignment mode.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Align the text's left edge with that of its display area.

Align the text's center with that of its display area.

Align the text's right edge with that of its display area.

Supported JavaScript dialog types.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Error codes that can be returned from CfxParseJSONAndReturnError.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Options that can be passed to CfxParseJSON.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Parses the input strictly according to RFC 4627. See comments in Chromium's base/json/json_reader.h file for known limitations/deviations from the RFC.

Allows commas to exist after the last element in structures.

Options that can be passed to CfxWriteJSON.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Default behavior.

This option instructs the writer that if a Binary value is encountered, the value (and key if within a dictionary) will be omitted from the output, and success will be returned. Otherwise, if a binary value is encountered, failure will be returned.

This option instructs the writer to write doubles that have no fractional part as a normal integer (i.e., without using exponential notation or appending a '.0') as long as the value is within the range of a 64-bit int.

Return a slightly nicer formatted json string (pads with whitespace to help with readability).

Key event types.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Notification that a key transitioned from "up" to "down".

Notification that a key was pressed. This does not necessarily correspond to a character depending on the key and language. Use KEYEVENT_CHAR for character input.

Notification that a key was released.

Notification that a character was typed. Use this for text input. Key down events may generate 0, 1, or more than one character event depending on the key, locale, and operating system.

Log severity levels.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Default logging (currently INFO logging).

Verbose logging.

INFO logging.

WARNING logging.

ERROR logging.

Completely disable logging.

Specifies where along the main axis the CfxBoxLayout child views should be laid out.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Child views will be left-aligned.

Child views will be center-aligned.

Child views will be right-aligned.

Specifies how a menu will be anchored for non-RTL languages. The opposite position will be used for RTL languages.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Supported color types for menu items.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Supported menu IDs. Non-English translations can be provided for the IDS_MENU_* strings in CfxResourceBundleHandler.GetLocalizedString().

See also the original CEF documentation in cef/include/internal/cef_types.h.

Supported menu item types.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Message loop types. Indicates the set of asynchronous events that a message loop can process.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Supports tasks and timers.

Supports tasks, timers and native UI events (e.g. Windows messages).

Supports tasks, timers and asynchronous IO events.

Mouse button types.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Navigation types.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Paint element types.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Path key values.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Current directory.

Directory containing PK_FILE_EXE.

Directory containing PK_FILE_MODULE.

Temporary directory.

Path and filename of the current executable.

Path and filename of the module containing the CEF code (usually the libcef module).

"Local Settings\Application Data" directory under the user profile directory on Windows.

"Application Data" directory under the user profile directory on Windows and "~/Library/Application Support" directory on Mac OS X.

Directory containing application resources. Can be configured via CfxSettings.ResourcesDirPath.

Margin type for PDF printing.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Default margins.

No margins.

Minimum margins.

Custom margins using the |margin_*| values from CfxPdfPrintSettings.

Plugin policies supported by CfxRequestContextHandler.OnBeforePluginLoad.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Allow the content.

Allow important content and block unimportant content based on heuristics. The user can manually load blocked content.

Block the content. The user can manually load blocked content.

Disable the content. The user cannot load disabled content.

Post data elements may represent either bytes or files.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Existing process IDs.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Browser process.

Renderer process.

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.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Clear the referrer header if the header value is HTTPS but the request destination is HTTP. This is the default behavior.

A slight variant on CLEAR_REFERRER_ON_TRANSITION_FROM_SECURE_TO_INSECURE: If the request destination is HTTP, an HTTPS referrer will be cleared. If the request's destination is cross-origin with the referrer (but does not downgrade), the referrer's granularity will be stripped down to an origin rather than a full URL. Same-origin requests will send the full referrer.

Strip the referrer down to an origin when the origin of the referrer is different from the destination's origin.

Never change the referrer.

Strip the referrer down to the origin regardless of the redirect location.

Clear the referrer when the request's referrer is cross-origin with the request's destination.

Strip the referrer down to the origin, but clear it entirely if the referrer value is HTTPS and the destination is HTTP.

Always clear the referrer regardless of the request destination.

Resource type for a request.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Top level page.

Frame or iframe.

CSS stylesheet.

External script.

Image (jpg/gif/png/etc).

Font.

Some other subresource. This is the default type if the actual type is unknown.

Object (or embed) tag for a plugin, or a resource that a plugin requested.

Media resource.

Main resource of a dedicated worker.

Main resource of a shared worker.

Explicitly requested prefetch.

Favicon.

XMLHttpRequest.

A request for a <ping>

Main resource of a service worker.

A report of Content Security Policy violations.

A resource that a plugin requested.

Return values for CfxResponseFilter.Filter().

See also the original CEF documentation in cef/include/internal/cef_types.h.

Some or all of the pre-filter data was read successfully but more data is needed in order to continue filtering (filtered output is pending).

Some or all of the pre-filter data was read successfully and all available filtered output has been written.

An error occurred during filtering.

Return value types.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Cancel immediately.

Continue immediately.

Continue asynchronously (usually via a callback).

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

See also the original CEF documentation in cef/include/internal/cef_types.h.

Supported SSL content status flags. See content/public/common/ssl_status.h for more information.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Supported SSL version values. See net/ssl/ssl_connection_status_flags.h for more information.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Represents the state of a setting.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Use the default state for the setting.

Enable or allow the setting.

Disable or disallow the setting.

Storage types.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Process termination status values.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Non-zero exit status.

SIGKILL or task manager kill.

Segmentation fault.

Text style types. Should be kepy in sync with gfx::TextStyle.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Existing thread IDs.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The main thread in the browser. This will be the same as the main application thread if CfxInitialize() is called with a CfxSettings.MultiThreadedMessageLoop value of false.

Used to interact with the database.

Used to interact with the file system.

Used for file system operations that block user interactions. Responsiveness of this thread affects users.

Used to launch and terminate browser processes.

Used to handle slow HTTP cache operations.

Used to process IPC and network messages.

The main thread in the renderer. Used for all WebKit and V8 interaction.

Thread priority values listed in increasing order of importance.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Suitable for threads that shouldn't disrupt high priority work.

Default priority level.

Suitable for threads which generate data for the display (at ~60Hz).

Suitable for low-latency, glitch-resistant audio.

Transition type for a request. Made up of one source value and 0 or more qualifiers.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Source is a link click or the JavaScript window.open function. This is also the default value for requests like sub-resource loads that are not navigations.

Source is some other "explicit" navigation action such as creating a new browser or using the LoadURL function. This is also the default value for navigations where the actual type is unknown.

Source is a subframe navigation. This is any content that is automatically loaded in a non-toplevel frame. For example, if a page consists of several frames containing ads, those ad URLs will have this transition type. The user may not even realize the content in these pages is a separate frame, so may not care about the URL.

Source is a subframe navigation explicitly requested by the user that will generate new navigation entries in the back/forward list. These are probably more important than frames that were automatically loaded in the background because the user probably cares about the fact that this link was loaded.

Source is a form submission by the user. NOTE: In some situations submitting a form does not result in this transition type. This can happen if the form uses a script to submit the contents.

Source is a "reload" of the page via the Reload function or by re-visiting the same URL. NOTE: This is distinct from the concept of whether a particular load uses "reload semantics" (i.e. bypasses cached data).

General mask defining the bits used for the source values.

Attempted to visit a URL but was blocked.

Used the Forward or Back function to navigate among browsing history.

The beginning of a navigation chain.

The last transition in a redirect chain.

Redirects caused by JavaScript or a meta refresh tag on the page.

Redirects sent from the server by HTTP headers.

Used to test whether a transition involves a redirect.

General mask defining the bits used for the qualifiers.

URI unescape rules passed to CfxURIDecode().

See also the original CEF documentation in cef/include/internal/cef_types.h.

Don't unescape anything at all.

Don't unescape anything special, but all normal unescaping will happen. This is a placeholder and can't be combined with other flags (since it's just the absence of them). All other unescape rules imply "normal" in addition to their special meaning. Things like escaped letters, digits, and most symbols will get unescaped with this mode.

Convert %20 to spaces. In some places where we're showing URLs, we may want this. In places where the URL may be copied and pasted out, then you wouldn't want this since it might not be interpreted in one piece by other applications.

Unescapes '/' and '\\'. If these characters were unescaped, the resulting URL won't be the same as the source one. Moreover, they are dangerous to unescape in strings that will be used as file paths or names. This value should only be used when slashes don't have special meaning, like data URLs.

Unescapes various characters that will change the meaning of URLs, including '%', '+', '&', '#'. Does not unescape path separators. If these characters were unescaped, the resulting URL won't be the same as the source one. This flag is used when generating final output like filenames for URLs where we won't be interpreting as a URL and want to do as much unescaping as possible.

Unescapes characters that can be used in spoofing attempts (such as LOCK) and control characters (such as BiDi control characters and %01). This INCLUDES NULLs. This is used for rare cases such as data: URL decoding where the result is binary data. DO NOT use UU_SPOOFING_AND_CONTROL_CHARS if the URL is going to be displayed in the UI for security reasons.

URL queries use "+" for space. This flag controls that replacement.

Flags used to customize the behavior of CfxURLRequest.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Default behavior.

If set the cache will be skipped when handling the request.

If set user name, password, and cookies may be sent with the request, and cookies may be saved from the response.

If set upload progress events will be generated when a request has a body.

If set the CfxURLRequestClient.OnDownloadData method will not be called.

If set 5XX redirect errors will be propagated to the observer instead of automatically re-tried. This currently only applies for requests originated in the browser process.

Flags that represent CfxURLRequest status.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Unknown status.

Request succeeded.

An IO request is pending, and the caller will be informed when it is completed.

Request was canceled programatically.

Request failed for some reason.

V8 access control values.

See also the original CEF documentation in cef/include/internal/cef_types.h.

V8 property attribute values.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Supported value types.

See also the original CEF documentation in cef/include/internal/cef_types.h.

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.

See also the original CEF documentation in cef/include/internal/cef_types.h.

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.

See also the original CEF documentation in cef/include/internal/cef_types.h.

XML node types.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Object representing an extension. Methods may be called on any thread unless otherwise indicated.

See also the original CEF documentation in cef/include/capi/cef_extension_capi.h.

Returns the unique extension identifier. This is calculated based on the extension public key, if available, or on the extension path. See https://developer.chrome.com/extensions/manifest/key for details.

See also the original CEF documentation in cef/include/capi/cef_extension_capi.h.

Returns the absolute path to the extension directory on disk. This value will be prefixed with PK_DIR_RESOURCES if a relative path was passed to CfxRequestContext.LoadExtension.

See also the original CEF documentation in cef/include/capi/cef_extension_capi.h.

Returns the extension manifest contents as a CfxDictionaryValue object. See https://developer.chrome.com/extensions/manifest for details.

See also the original CEF documentation in cef/include/capi/cef_extension_capi.h.

Returns the handler for this extension. Will return NULL for internal extensions or if no handler was passed to CfxRequestContext.LoadExtension.

See also the original CEF documentation in cef/include/capi/cef_extension_capi.h.

Returns the request context that loaded this extension. Will return NULL for internal extensions or if the extension has been unloaded. See the CfxRequestContext.LoadExtension documentation for more information about loader contexts. Must be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_extension_capi.h.

Returns true (1) if this extension is currently loaded. Must be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_extension_capi.h.

Returns true (1) if this object is the same extension as |that| object. Extensions are considered the same if identifier, path and loader context match.

See also the original CEF documentation in cef/include/capi/cef_extension_capi.h.

Unload this extension if it is not an internal extension and is currently loaded. Will result in a call to CfxExtensionHandler.OnExtensionUnloaded on success.

See also the original CEF documentation in cef/include/capi/cef_extension_capi.h.

Implement this structure to handle events related to browser extensions. The functions of this structure will be called on the UI thread. See CfxRequestContext.LoadExtension for information about extension loading.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called if the CfxRequestContext.LoadExtension request fails. |Result| will be the error code.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called if the CfxRequestContext.LoadExtension request succeeds. |Extension| is the loaded extension.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called after the CfxExtension.Unload request has completed.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called when an extension needs a browser to host a background script specified via the "background" manifest key. The browser will have no visible window and cannot be displayed. |Extension| is the extension that is loading the background script. |Url| is an internally generated reference to an HTML page that will be used to load the background script via a <script> src attribute. To allow creation of the browser optionally modify |Client| and |Settings| and return false (0). To cancel creation of the browser (and consequently cancel load of the background script) return true (1). Successful creation will be indicated by a call to CfxLifeSpanHandler.OnAfterCreated, and CfxBrowserHost.IsBackgroundHost will return true (1) for the resulting browser. See https://developer.chrome.com/extensions/event_pages for more information about extension background script usage.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called when an extension API (e.g. chrome.tabs.create) requests creation of a new browser. |Extension| and |Browser| are the source of the API call. |ActiveBrowser| may optionally be specified via the windowId property or returned via the get_active_browser() callback and provides the default |Client| and |Settings| values for the new browser. |Index| is the position value optionally specified via the index property. |Url| is the URL that will be loaded in the browser. |Active| is true (1) if the new browser should be active when opened. To allow creation of the browser optionally modify |WindowInfo|, |Client| and |Settings| and return false (0). To cancel creation of the browser return true (1). Successful creation will be indicated by a call to CfxLifeSpanHandler.OnAfterCreated. Any modifications to |WindowInfo| will be ignored if |ActiveBrowser| is wrapped in a CfxBrowserView.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called when no tabId is specified to an extension API call that accepts a tabId parameter (e.g. chrome.tabs.*). |Extension| and |Browser| are the source of the API call. Return the browser that will be acted on by the API call or return NULL to act on |Browser|. The returned browser must share the same CfxRequestContext as |Browser|. Incognito browsers should not be considered unless the source extension has incognito access enabled, in which case |IncludeIncognito| will be true (1).

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called when the tabId associated with |TargetBrowser| is specified to an extension API call that accepts a tabId parameter (e.g. chrome.tabs.*). |Extension| and |Browser| are the source of the API call. Return true (1) to allow access of false (0) to deny access. Access to incognito browsers should not be allowed unless the source extension has incognito access enabled, in which case |IncludeIncognito| will be true (1).

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Called to retrieve an extension resource that would normally be loaded from disk (e.g. if a file parameter is specified to chrome.tabs.executeScript). |Extension| and |Browser| are the source of the resource request. |File| is the requested relative file path. To handle the resource request return true (1) and execute |Callback| either synchronously or asynchronously. For the default behavior which reads the resource from the extension directory on disk return false (0). Localization substitutions will not be applied to resources handled via this function.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Callback structure for asynchronous continuation of file dialog requests.

See also the original CEF documentation in cef/include/capi/cef_dialog_handler_capi.h.

Continue the file selection. |selectedAcceptFilter| should be the 0-based index of the value selected from the accept filters array passed to CfxDialogHandler.OnFileDialog. |filePaths| should be a single value or a list of values depending on the dialog mode. An NULL |filePaths| value is treated the same as calling cancel().

See also the original CEF documentation in cef/include/capi/cef_dialog_handler_capi.h.

Cancel the file selection.

See also the original CEF documentation in cef/include/capi/cef_dialog_handler_capi.h.

Implement this structure to handle events related to find results. The functions of this structure will be called on the UI thread.

See also the original CEF documentation in cef/include/capi/cef_find_handler_capi.h.

Called to report find results returned by CfxBrowserHost.Find(). |Identifer| is the identifier passed to find(), |Count| is the number of matches currently identified, |SelectionRect| is the location of where the match was found (in window coordinates), |ActiveMatchOrdinal| is the current position in the search results, and |FinalUpdate| is true (1) if this is the last find notification.

See also the original CEF documentation in cef/include/capi/cef_find_handler_capi.h.

Implement this structure to handle events related to focus. The functions of this structure will be called on the UI thread.

See also the original CEF documentation in cef/include/capi/cef_focus_handler_capi.h.

Called when the browser component is about to loose focus. For instance, if focus was on the last HTML element and the user pressed the TAB key. |Next| will be true (1) if the browser is giving focus to the next component and false (0) if the browser is giving focus to the previous component.

See also the original CEF documentation in cef/include/capi/cef_focus_handler_capi.h.

Called when the browser component is requesting focus. |Source| indicates where the focus request is originating from. Return false (0) to allow the focus to be set or true (1) to cancel setting the focus.

See also the original CEF documentation in cef/include/capi/cef_focus_handler_capi.h.

Called when the browser component has received focus.

See also the original CEF documentation in cef/include/capi/cef_focus_handler_capi.h.

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.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

True if this object is currently attached to a valid frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Returns true (1) if this is the main (top-level) frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Returns true (1) if this is the focused frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Returns the name for this frame. If the frame has an assigned name (for example, set via the iframe "name" attribute) then that value will be returned. Otherwise a unique name will be constructed based on the frame parent hierarchy. The main (top-level) frame will always have an NULL name value.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Returns the globally unique identifier for this frame or < 0 if the underlying frame does not yet exist.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Returns the parent of this frame or NULL if this is the main (top-level) frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Returns the URL currently loaded in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Returns the browser that this frame belongs to.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Get the V8 context associated with the frame. This function can only be called from the render process.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute undo in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute redo in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute cut in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute copy in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute paste in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute delete in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute select all in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Save this frame's HTML source to a temporary file and open it in the default text viewing application. This function can only be called from the browser process.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Retrieve this frame's HTML source as a string sent to the specified visitor.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Retrieve this frame's display text as a string sent to the specified visitor.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Load the request represented by the |request| object.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Load the specified |url|.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Load the contents of |stringVal| with the specified dummy |url|. |url| should have a standard scheme (for example, http scheme) or behaviors like link clicks and web security restrictions may not behave as expected.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute a string of JavaScript code in this frame. The |scriptUrl| parameter is the URL where the script in question can be found, if any. The renderer may request this URL to show the developer the source of the error. The |startLine| parameter is the base line number to use for error reporting.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Visit the DOM document. This function can only be called from the render process.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Callback structure used for asynchronous continuation of geolocation permission requests.

See also the original CEF documentation in cef/include/capi/cef_geolocation_handler_capi.h.

Call to allow or deny geolocation access.

See also the original CEF documentation in cef/include/capi/cef_geolocation_handler_capi.h.

Implement this structure to handle events related to geolocation permission requests. The functions of this structure will be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_geolocation_handler_capi.h.

Called when a page requests permission to access geolocation information. |RequestingUrl| is the URL requesting permission and |RequestId| is the unique ID for the permission request. Return true (1) and call CfxGeolocationCallback.Continue() either in this function or at a later time to continue or cancel the request. Return false (0) to cancel the request immediately.

See also the original CEF documentation in cef/include/capi/cef_geolocation_handler_capi.h.

Called when a geolocation access request is canceled. |RequestId| is the unique ID for the permission request.

See also the original CEF documentation in cef/include/capi/cef_geolocation_handler_capi.h.

Structure representing geoposition information. The properties of this structure correspond to those of the JavaScript Position object although their types may differ.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Latitude in decimal degrees north (WGS84 coordinate frame).

See also the original CEF documentation in cef/include/internal/cef_types.h.

Longitude in decimal degrees west (WGS84 coordinate frame).

See also the original CEF documentation in cef/include/internal/cef_types.h.

Altitude in meters (above WGS84 datum).

See also the original CEF documentation in cef/include/internal/cef_types.h.

Accuracy of horizontal position in meters.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Accuracy of altitude in meters.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Heading in decimal degrees clockwise from true north.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Horizontal component of device velocity in meters per second.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Time of position measurement in milliseconds since Epoch in UTC time. This is taken from the host computer's system clock.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Error code, see enum above.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Human-readable error message.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Callback structure used for asynchronous continuation of CfxExtensionHandler.GetExtensionResource.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Continue the request. Read the resource contents from |stream|.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Cancel the request.

See also the original CEF documentation in cef/include/capi/cef_extension_handler_capi.h.

Implement this structure to receive geolocation updates. The functions of this structure will be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_geolocation_capi.h.

Called with the 'best available' location information or, if the location update failed, with error information.

See also the original CEF documentation in cef/include/capi/cef_geolocation_capi.h.

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 must be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_image_capi.h.

Create a new CfxImage. It will initially be NULL. Use the Add*() functions to add representations at different scale factors.

See also the original CEF documentation in cef/include/capi/cef_image_capi.h.

Returns true (1) if this Image is NULL.

See also the original CEF documentation in cef/include/capi/cef_image_capi.h.

Returns the image width in density independent pixel (DIP) units.

See also the original CEF documentation in cef/include/capi/cef_image_capi.h.

Returns the image height in density independent pixel (DIP) units.

See also the original CEF documentation in cef/include/capi/cef_image_capi.h.

Returns true (1) if this Image and |that| Image share the same underlying storage. Will also return true (1) if both images are NULL.

See also the original CEF documentation in cef/include/capi/cef_image_capi.h.

Add a bitmap image representation for |scaleFactor|. Only 32-bit RGBA/BGRA formats are supported. |pixelWidth| and |pixelHeight| are the bitmap representation size in pixel coordinates. |pixelData| is the array of pixel data and should be |pixelWidth| x |pixelHeight| x 4 bytes in size. |colorType| and |alphaType| values specify the pixel format.

See also the original CEF documentation in cef/include/capi/cef_image_capi.h.

Add a PNG image representation for |scaleFactor|. |pngData| is the image data of size |pngDataSize|. Any alpha transparency in the PNG data will be maintained.

See also the original CEF documentation in cef/include/capi/cef_image_capi.h.

Create a JPEG image representation for |scaleFactor|. |jpegData| is the image data of size |jpegDataSize|. The JPEG format does not support transparency so the alpha byte will be set to 0xFF for all pixels.

See also the original CEF documentation in cef/include/capi/cef_image_capi.h.

Returns true (1) if this image contains a representation for |scaleFactor|.

See also the original CEF documentation in cef/include/capi/cef_image_capi.h.

Removes the representation for |scaleFactor|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_image_capi.h.

Returns information for the representation that most closely matches |scaleFactor|. |actualScaleFactor| is the actual scale factor for the representation. |pixelWidth| and |pixelHeight| are the representation size in pixel coordinates. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_image_capi.h.

Returns the bitmap representation that most closely matches |scaleFactor|. Only 32-bit RGBA/BGRA formats are supported. |colorType| and |alphaType| values specify the desired output pixel format. |pixelWidth| and |pixelHeight| are the output representation size in pixel coordinates. Returns a CfxBinaryValue containing the pixel data on success or NULL on failure.

See also the original CEF documentation in cef/include/capi/cef_image_capi.h.

Returns the PNG representation that most closely matches |scaleFactor|. If |withTransparency| is true (1) any alpha transparency in the image will be represented in the resulting PNG data. |pixelWidth| and |pixelHeight| are the output representation size in pixel coordinates. Returns a CfxBinaryValue containing the PNG image data on success or NULL on failure.

See also the original CEF documentation in cef/include/capi/cef_image_capi.h.

Returns the JPEG representation that most closely matches |scaleFactor|. |quality| determines the compression level with 0 == lowest and 100 == highest. The JPEG format does not support alpha transparency and the alpha channel, if any, will be discarded. |pixelWidth| and |pixelHeight| are the output representation size in pixel coordinates. Returns a CfxBinaryValue containing the JPEG image data on success or NULL on failure.

See also the original CEF documentation in cef/include/capi/cef_image_capi.h.

Structure representing insets.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Callback structure used for asynchronous continuation of JavaScript dialog requests.

See also the original CEF documentation in cef/include/capi/cef_jsdialog_handler_capi.h.

Continue the JS dialog request. Set |success| to true (1) if the OK button was pressed. The |userInput| value should be specified for prompt dialogs.

See also the original CEF documentation in cef/include/capi/cef_jsdialog_handler_capi.h.

Implement this structure to handle events related to JavaScript dialogs. The functions of this structure will be called on the UI thread.

See also the original CEF documentation in cef/include/capi/cef_jsdialog_handler_capi.h.

Called to run a JavaScript dialog. If |OriginUrl| is non-NULL it can be passed to the CfxFormatUrlForSecurityDisplay function to retrieve a secure and user-friendly display string. The |DefaultPromptText| value will be specified for prompt dialogs only. Set |SuppressMessage| to true (1) and return false (0) to suppress the message (suppressing messages is preferable to immediately executing the callback as this is used to detect presumably malicious behavior like spamming alert messages in onbeforeunload). Set |SuppressMessage| to false (0) and return false (0) to use the default implementation (the default implementation will show one modal dialog at a time and suppress any additional dialog requests until the displayed dialog is dismissed). Return true (1) if the application will use a custom dialog or if the callback has been executed immediately. Custom dialogs may be either modal or modeless. If a custom dialog is used the application must execute |Callback| once the custom dialog is dismissed.

See also the original CEF documentation in cef/include/capi/cef_jsdialog_handler_capi.h.

Called to run a dialog asking the user if they want to leave a page. Return false (0) to use the default dialog implementation. Return true (1) if the application will use a custom dialog or if the callback has been executed immediately. Custom dialogs may be either modal or modeless. If a custom dialog is used the application must execute |Callback| once the custom dialog is dismissed.

See also the original CEF documentation in cef/include/capi/cef_jsdialog_handler_capi.h.

Called to cancel any pending dialogs and reset any saved dialog state. Will be called due to events like page navigation irregardless of whether any dialogs are currently pending.

See also the original CEF documentation in cef/include/capi/cef_jsdialog_handler_capi.h.

Called when the default implementation dialog is closed.

See also the original CEF documentation in cef/include/capi/cef_jsdialog_handler_capi.h.

Implement this structure to handle events related to keyboard input. The functions of this structure will be called on the UI thread.

See also the original CEF documentation in cef/include/capi/cef_keyboard_handler_capi.h.

Called before a keyboard event is sent to the renderer. |Event| contains information about the keyboard event. |OsEvent| is the operating system event message, if any. Return true (1) if the event was handled or false (0) otherwise. If the event will be handled in on_key_event() as a keyboard shortcut set |IsKeyboardShortcut| to true (1) and return false (0).

See also the original CEF documentation in cef/include/capi/cef_keyboard_handler_capi.h.

Called after the renderer and JavaScript in the page has had a chance to handle the event. |Event| contains information about the keyboard event. |OsEvent| is the operating system event message, if any. Return true (1) if the keyboard event was handled or false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_keyboard_handler_capi.h.

Structure representing keyboard event information.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The type of keyboard event.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Bit flags describing any pressed modifier keys. See CfxEventFlags for values.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The Windows key code for the key event. This value is used by the DOM specification. Sometimes it comes directly from the event (i.e. on Windows) and sometimes it's determined using a mapping function. See WebCore/platform/chromium/KeyboardCodes.h for the list of values.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The actual key code genenerated by the platform.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Indicates whether the event is considered a "system key" event (see http://msdn.microsoft.com/en-us/library/ms646286(VS.85).aspx for details). This value will always be false on non-Windows platforms.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The character generated by the keystroke.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Same as |character| but unmodified by any concurrently-held modifiers (except shift). This is useful for working out shortcut keys.

See also the original CEF documentation in cef/include/internal/cef_types.h.

True if the focus is currently on an editable field on the page. This is useful for determining if standard key events should be intercepted.

See also the original CEF documentation in cef/include/internal/cef_types.h.

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.

See also the original CEF documentation in cef/include/capi/cef_life_span_handler_capi.h.

Called on the UI thread before a new popup browser is created. The |Browser| and |Frame| values represent the source of the popup request. The |TargetUrl| and |TargetFrameName| values indicate where the popup browser should navigate and may be NULL if not specified with the request. The |TargetDisposition| value indicates where the user intended to open the popup (e.g. current tab, new tab, etc). The |UserGesture| value will be true (1) if the popup was opened via explicit user gesture (e.g. clicking a link) or false (0) if the popup opened automatically (e.g. via the DomContentLoaded event). The |PopupFeatures| structure contains additional information about the requested popup window. To allow creation of the popup browser optionally modify |WindowInfo|, |Client|, |Settings| and |NoJavascriptAccess| and return false (0). To cancel creation of the popup browser return true (1). The |Client| and |Settings| values will default to the source browser's values. If the |NoJavascriptAccess| value is set to false (0) the new browser will not be scriptable and may not be hosted in the same renderer process as the source browser. Any modifications to |WindowInfo| will be ignored if the parent browser is wrapped in a CfxBrowserView. Popup browser creation will be canceled if the parent browser is destroyed before the popup browser creation completes (indicated by a call to OnAfterCreated for the popup browser).

See also the original CEF documentation in cef/include/capi/cef_life_span_handler_capi.h.

Called after a new browser is created. This callback will be the first notification that references |Browser|.

See also the original CEF documentation in cef/include/capi/cef_life_span_handler_capi.h.

Called when a browser has recieved a request to close. This may result directly from a call to CfxBrowserHost::*close_browser() or indirectly if the browser is parented to a top-level window created by CEF and the user attempts to close that window (by clicking the 'X', for example). The do_close() function will be called after the JavaScript 'onunload' event has been fired. An application should handle top-level owner window close notifications by calling CfxBrowserHost.TryCloseBrowser() or CfxBrowserHost.CloseBrowser(false (0)) instead of allowing the window to close immediately (see the examples below). This gives CEF an opportunity to process the 'onbeforeunload' event and optionally cancel the close before do_close() is called. When windowed rendering is enabled CEF will internally create a window or view to host the browser. In that case returning false (0) from do_close() will send the standard close notification to the browser's top-level owner window (e.g. WM_CLOSE on Windows, performClose: on OS X, "delete_event" on Linux or CfxWindowDelegate.CanClose() callback from Views). If the browser's host window/view has already been destroyed (via view hierarchy tear-down, for example) then do_close() will not be called for that browser since is no longer possible to cancel the close. When windowed rendering is disabled returning false (0) from do_close() will cause the browser object to be destroyed immediately. If the browser's top-level owner window requires a non-standard close notification then send that notification from do_close() and return true (1). The CfxLifeSpanHandler.OnBeforeClose() function will be called after do_close() (if do_close() is called) and immediately before the browser object is destroyed. The application should only exit after on_before_close() has been called for all existing browsers. The below examples describe what should happen during window close when the browser is parented to an application-provided top-level window. Example 1: Using CfxBrowserHost.TryCloseBrowser(). This is recommended for clients using standard close handling and windows created on the browser process UI thread. 1. User clicks the window close button which sends a close notification to the application's top-level window. 2. Application's top-level window receives the close notification and calls TryCloseBrowser() (which internally calls CloseBrowser(false)). TryCloseBrowser() returns false so the client cancels the window close. 3. JavaScript 'onbeforeunload' handler executes and shows the close confirmation dialog (which can be overridden via CfxJSDialogHandler.OnBeforeUnloadDialog()). 4. User approves the close. 5. JavaScript 'onunload' handler executes. 6. CEF sends a close notification to the application's top-level window (because DoClose() returned false by default). 7. Application's top-level window receives the close notification and calls TryCloseBrowser(). TryCloseBrowser() returns true so the client allows the window close. 8. Application's top-level window is destroyed. 9. Application's on_before_close() handler is called and the browser object is destroyed. 10. Application exits by calling cef_quit_message_loop() if no other browsers exist. Example 2: Using CfxBrowserHost.CloseBrowser(false (0)) and implementing the do_close() callback. This is recommended for clients using non-standard close handling or windows that were not created on the browser process UI thread. 1. User clicks the window close button which sends a close notification to the application's top-level window. 2. Application's top-level window receives the close notification and: A. Calls CfxBrowserHost.CloseBrowser(false). B. Cancels the window close. 3. JavaScript 'onbeforeunload' handler executes and shows the close confirmation dialog (which can be overridden via CfxJSDialogHandler.OnBeforeUnloadDialog()). 4. User approves the close. 5. JavaScript 'onunload' handler executes. 6. Application's do_close() handler is called. Application will: A. Set a flag to indicate that the next close attempt will be allowed. B. Return false. 7. CEF sends an close notification to the application's top-level window. 8. Application's top-level window receives the close notification and allows the window to close based on the flag from #6B. 9. Application's top-level window is destroyed. 10. Application's on_before_close() handler is called and the browser object is destroyed. 11. Application exits by calling cef_quit_message_loop() if no other browsers exist.

See also the original CEF documentation in cef/include/capi/cef_life_span_handler_capi.h.

Called just before a browser is destroyed. Release all references to the browser object and do not attempt to execute any functions on the browser object after this callback returns. This callback will be the last notification that references |Browser|. See do_close() documentation for additional usage information.

See also the original CEF documentation in cef/include/capi/cef_life_span_handler_capi.h.

Structure representing a list value. Can be used on any process and thread.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Creates a new object that is not owned by any other object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object is valid. This object may become invalid if the underlying data is owned by another object (e.g. list or dictionary) and that other object is then modified or destroyed. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object is currently owned by another object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if the values of this object are read-only. Some APIs may expose read-only objects.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the number of values.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have the same underlying data. If true (1) modifications to this object will also affect |that| object and vice-versa.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have an equivalent underlying value but are not necessarily the same object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns a writable copy of this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the number of values. If the number of values is expanded all new value slots will default to type null. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Removes all values. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Removes the value at the specified index.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value type at the specified index.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index. For simple types the returned value will copy existing data and modifications to the value will not modify this object. For complex types (binary, dictionary and list) the returned value will reference existing data and modifications to the value will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index as type bool.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index as type int.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index as type double.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index as type string.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index as type binary. The returned value will reference existing data.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index as type dictionary. The returned value will reference existing data and modifications to the value will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index as type list. The returned value will reference existing data and modifications to the value will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index. Returns true (1) if the value was set successfully. If |value| represents simple data then the underlying data will be copied and modifications to |value| will not modify this object. If |value| represents complex data (binary, dictionary or list) then the underlying data will be referenced and modifications to |value| will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type null. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type bool. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type int. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type double. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type string. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type binary. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type dict. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type list. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called when the loading state has changed. This callback will be executed twice -- once when loading is initiated either programmatically or by user action, and once when loading is terminated due to completion, cancellation of failure. It will be called before any calls to OnLoadStart and after all calls to OnLoadError and/or OnLoadEnd.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called after a navigation has been committed and before the browser begins loading contents in the frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. |TransitionType| provides information about the source of the navigation and an accurate value is only available in the browser process. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will not be called for same page navigations (fragments, history state, etc.) or for navigations that fail or are canceled before commit. For notification of overall browser load status use OnLoadingStateChange instead.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called when the browser is done loading a frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will not be called for same page navigations (fragments, history state, etc.) or for navigations that fail or are canceled before commit. For notification of overall browser load status use OnLoadingStateChange instead.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called when a navigation fails or is canceled. This function may be called by itself if before commit or in combination with OnLoadStart/OnLoadEnd if after commit. |ErrorCode| is the error code number, |ErrorText| is the error text and |FailedUrl| is the URL that failed to load. See net\base\net_error_list.h for complete descriptions of the error codes.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Structure representing CfxExecuteProcess arguments.

See also the original CEF documentation in cef/include/internal/cef_types_linux.h.

Structure representing CfxExecuteProcess arguments.

See also the original CEF documentation in cef/include/internal/cef_types_win.h.

Supports creation and modification of menus. See CfxMenuId 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.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Create a new MenuModel with the specified |delegate|.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns true (1) if this menu is a submenu.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns the number of items in this menu.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Clears the menu. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Add a separator to the menu. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Add an item to the menu. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Add a check item to the menu. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Add a radio item to the menu. Only a single item with the specified |groupId| can be checked at a time. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Add a sub-menu to the menu. The new sub-menu is returned.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Insert a separator in the menu at the specified |index|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Insert an item in the menu at the specified |index|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Insert a check item in the menu at the specified |index|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Insert a radio item in the menu at the specified |index|. Only a single item with the specified |groupId| can be checked at a time. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Insert a sub-menu in the menu at the specified |index|. The new sub-menu is returned.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Removes the item with the specified |commandId|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Removes the item at the specified |index|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns the index associated with the specified |commandId| or -1 if not found due to the command id not existing in the menu.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns the command id at the specified |index| or -1 if not found due to invalid range or the index being a separator.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Sets the command id at the specified |index|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns the label for the specified |commandId| or NULL if not found.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns the label at the specified |index| or NULL if not found due to invalid range or the index being a separator.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Sets the label for the specified |commandId|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Set the label at the specified |index|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns the item type for the specified |commandId|.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns the item type at the specified |index|.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns the group id for the specified |commandId| or -1 if invalid.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns the group id at the specified |index| or -1 if invalid.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Sets the group id for the specified |commandId|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Sets the group id at the specified |index|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns the submenu for the specified |commandId| or NULL if invalid.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns the submenu at the specified |index| or NULL if invalid.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns true (1) if the specified |commandId| is visible.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns true (1) if the specified |index| is visible.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Change the visibility of the specified |commandId|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Change the visibility at the specified |index|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns true (1) if the specified |commandId| is enabled.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns true (1) if the specified |index| is enabled.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Change the enabled status of the specified |commandId|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Change the enabled status at the specified |index|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns true (1) if the specified |commandId| is checked. Only applies to check and radio items.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns true (1) if the specified |index| is checked. Only applies to check and radio items.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Check the specified |commandId|. Only applies to check and radio items. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Check the specified |index|. Only applies to check and radio items. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns true (1) if the specified |commandId| has a keyboard accelerator assigned.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns true (1) if the specified |index| has a keyboard accelerator assigned.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Set the keyboard accelerator for the specified |commandId|. |keyCode| can be any virtual key or character value. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Set the keyboard accelerator at the specified |index|. |keyCode| can be any virtual key or character value. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Remove the keyboard accelerator for the specified |commandId|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Remove the keyboard accelerator at the specified |index|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Retrieves the keyboard accelerator for the specified |commandId|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Retrieves the keyboard accelerator for the specified |index|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Set the explicit color for |commandId| and |colorType| to |color|. Specify a |color| value of 0 to remove the explicit color. If no explicit color or default color is set for |colorType| then the system color will be used. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Set the explicit color for |commandId| and |index| to |color|. Specify a |color| value of 0 to remove the explicit color. Specify an |index| value of -1 to set the default color for items that do not have an explicit color set. If no explicit color or default color is set for |colorType| then the system color will be used. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns in |color| the color that was explicitly set for |commandId| and |colorType|. If a color was not set then 0 will be returned in |color|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Returns in |color| the color that was explicitly set for |commandId| and |colorType|. Specify an |index| value of -1 to return the default color in |color|. If a color was not set then 0 will be returned in |color|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Sets the font list for the specified |commandId|. If |fontList| is NULL the system font will be used. Returns true (1) on success. The format is "<FONT_FAMILY_LIST>,[STYLES] <SIZE>", where: - FONT_FAMILY_LIST is a comma- separated list of font family names, - STYLES is an optional space- separated list of style names (case-sensitive "Bold" and "Italic" are supported), and - SIZE is an integer font size in pixels with the suffix "px". Here are examples of valid font description strings: - "Arial, Helvetica, Bold Italic 14px" - "Arial, 14px"

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

Sets the font list for the specified |index|. Specify an |index| value of -1 to set the default font. If |fontList| is NULL the system font will be used. Returns true (1) on success. The format is "<FONT_FAMILY_LIST>,[STYLES] <SIZE>", where: - FONT_FAMILY_LIST is a comma- separated list of font family names, - STYLES is an optional space- separated list of style names (case-sensitive "Bold" and "Italic" are supported), and - SIZE is an integer font size in pixels with the suffix "px". Here are examples of valid font description strings: - "Arial, Helvetica, Bold Italic 14px" - "Arial, 14px"

See also the original CEF documentation in cef/include/capi/cef_menu_model_capi.h.

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.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Perform the action associated with the specified |CommandId| and optional |EventFlags|.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Called when the user moves the mouse outside the menu and over the owning window.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Called on unhandled open submenu keyboard commands. |IsRtl| will be true (1) if the menu is displaying a right-to-left language.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Called on unhandled close submenu keyboard commands. |IsRtl| will be true (1) if the menu is displaying a right-to-left language.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

The menu is about to show.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

The menu has closed.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Optionally modify a menu item label. Return true (1) if |Label| was modified.

See also the original CEF documentation in cef/include/capi/cef_menu_model_delegate_capi.h.

Structure representing mouse event information.

See also the original CEF documentation in cef/include/internal/cef_types.h.

X coordinate relative to the left side of the view.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Y coordinate relative to the top side of the view.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Bit flags describing any pressed modifier keys. See CfxEventFlags for values.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Structure used to represent an entry in navigation history.

See also the original CEF documentation in cef/include/capi/cef_navigation_entry_capi.h.

Returns true (1) if this object is valid. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_navigation_entry_capi.h.

Returns the actual URL of the page. For some pages this may be data: URL or similar. Use get_display_url() to return a display-friendly version.

See also the original CEF documentation in cef/include/capi/cef_navigation_entry_capi.h.

Returns a display-friendly version of the URL.

See also the original CEF documentation in cef/include/capi/cef_navigation_entry_capi.h.

Returns the original URL that was entered by the user before any redirects.

See also the original CEF documentation in cef/include/capi/cef_navigation_entry_capi.h.

Returns the title set by the page. This value may be NULL.

See also the original CEF documentation in cef/include/capi/cef_navigation_entry_capi.h.

Returns the transition type which indicates what the user did to move to this page from the previous page.

See also the original CEF documentation in cef/include/capi/cef_navigation_entry_capi.h.

Returns true (1) if this navigation includes post data.

See also the original CEF documentation in cef/include/capi/cef_navigation_entry_capi.h.

Returns the time for the last known successful navigation completion. A navigation may be completed more than once if the page is reloaded. May be 0 if the navigation has not yet completed.

See also the original CEF documentation in cef/include/capi/cef_navigation_entry_capi.h.

Returns the HTTP status code for the last known successful navigation response. May be 0 if the response has not yet been received or if the navigation has not yet completed.

See also the original CEF documentation in cef/include/capi/cef_navigation_entry_capi.h.

Returns the SSL information for this navigation entry.

See also the original CEF documentation in cef/include/capi/cef_navigation_entry_capi.h.

Callback structure for CfxBrowserHost.GetNavigationEntries. The functions of this structure will be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Method that will be executed. Do not keep a reference to |Entry| outside of this callback. Return true (1) to continue visiting entries or false (0) to stop. |Current| is true (1) if this entry is the currently loaded navigation entry. |Index| is the 0-based index of this entry and |Total| is the total number of entries.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Callback structure for CfxBrowserHost.PrintToPDF. The functions of this structure will be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Method that will be executed when the PDF printing has completed. |Path| is the output path. |Ok| will be true (1) if the printing completed successfully or false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Structure representing PDF print settings.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Page title to display in the header. Only used if |headerFooterEnabled| is set to true (1).

See also the original CEF documentation in cef/include/internal/cef_types.h.

URL to display in the footer. Only used if |headerFooterEnabled| is set to true (1).

See also the original CEF documentation in cef/include/internal/cef_types.h.

Output page size in microns. If either of these values is less than or equal to zero then the default paper size (A4) will be used.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The percentage to scale the PDF by before printing (e.g. 50 is 50%). If this value is less than or equal to zero the default value of 100 will be used.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Margins in millimeters. Only used if |marginType| is set to PDF_PRINT_MARGIN_CUSTOM.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Margin type.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) to print headers and footers or false (0) to not print headers and footers.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) to print the selection only or false (0) to print all.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) for landscape mode or false (0) for portrait mode.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) to print background graphics or false (0) to not print background graphics.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Structure representing a point.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Popup window features.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Structure used to represent post data for a web request. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Create a new CfxPostData object.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Returns true (1) if this object is read-only.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Returns true (1) if the underlying POST data includes elements that are not represented by this CfxPostData object (for example, multi-part file upload data). Modifying CfxPostData objects with excluded elements may result in the request failing.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Returns the number of existing post data elements.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Retrieve the post data elements.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Remove the specified post data element. Returns true (1) if the removal succeeds.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Add the specified post data element. Returns true (1) if the add succeeds.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Remove all existing post data elements.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Structure used to represent a single element in the request post data. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Create a new CfxPostDataElement object.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Returns true (1) if this object is read-only.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Return the type of this post data element.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Return the file name.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Return the number of bytes.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Remove all contents from the post data element.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

The post data element will represent a file.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

The post data element will represent bytes. The bytes passed in will be copied.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Read up to |size| bytes into |bytes| and return the number of bytes actually read.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Callback structure for asynchronous continuation of print dialog requests.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Continue printing with the specified |settings|.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Cancel the printing.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

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.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Called when printing has started for the specified |Browser|. This function will be called before the other OnPrint*() functions and irrespective of how printing was initiated (e.g. CfxBrowserHost.Print(), JavaScript window.print() or PDF extension print button).

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Synchronize |Settings| with client state. If |GetDefaults| is true (1) then populate |Settings| with the default print settings. Do not keep a reference to |Settings| outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Show the print dialog. Execute |Callback| once the dialog is dismissed. Return true (1) if the dialog will be displayed or false (0) to cancel the printing immediately.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Send the print job to the printer. Execute |Callback| once the job is completed. Return true (1) if the job will proceed or false (0) to cancel the job immediately.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Reset client state related to printing.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Return the PDF paper size in device units. Used in combination with CfxBrowserHost.PrintToPdf().

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Callback structure for asynchronous continuation of print job requests.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Indicate completion of the print job.

See also the original CEF documentation in cef/include/capi/cef_print_handler_capi.h.

Structure representing print settings.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Create a new CfxPrintSettings object.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Returns true (1) if this object is valid. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Returns true (1) if the values of this object are read-only. Some APIs may expose read-only objects.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Returns true (1) if the orientation is landscape.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Get or set the device name.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Get or set the DPI (dots per inch).

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Returns the number of page ranges that currently exist.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Returns true (1) if only the selection will be printed.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Get or set the color model.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Get or set the number of copies.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Get or set the duplex mode.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Returns a writable copy of this object.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Set the page orientation.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Set the printer printable area in device units. Some platforms already provide flipped area. Set |landscapeNeedsFlip| to false (0) on those platforms to avoid double flipping.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Set the page ranges.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Retrieve the page ranges.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Set whether only the selection will be printed.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Set whether pages will be collated.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Returns true (1) if pages will be collated.

See also the original CEF documentation in cef/include/capi/cef_print_settings_capi.h.

Structure representing a message. Can be used on any process and thread.

See also the original CEF documentation in cef/include/capi/cef_process_message_capi.h.

Create a new CfxProcessMessage object with the specified name.

See also the original CEF documentation in cef/include/capi/cef_process_message_capi.h.

Returns true (1) if this object is valid. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_process_message_capi.h.

Returns true (1) if the values of this object are read-only. Some APIs may expose read-only objects.

See also the original CEF documentation in cef/include/capi/cef_process_message_capi.h.

Returns the message name.

See also the original CEF documentation in cef/include/capi/cef_process_message_capi.h.

Returns the list of arguments.

See also the original CEF documentation in cef/include/capi/cef_process_message_capi.h.

Returns a writable copy of this object.

See also the original CEF documentation in cef/include/capi/cef_process_message_capi.h.

Structure representing a range.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Structure the client can implement to provide a custom stream reader. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Read raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Seek to the specified offset position. |Whence| may be any one of SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on failure.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return the current offset position.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return non-zero if at end of file.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return true (1) if this handler performs work like accessing the file system which may block. Used as a hint for determining the thread to access the handler from.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Structure representing a rectangle.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Implement this structure to receive notification when CDM registration is complete. The functions of this structure will be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Method that will be called when CDM registration is complete. |Result| will be CEF_CDM_REGISTRATION_ERROR_NONE if registration completed successfully. Otherwise, |Result| and |ErrorMessage| will contain additional information about why registration failed.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Implement this structure to handle events when window rendering is disabled. The functions of this structure will be called on the UI thread.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Return the handler for accessibility notifications. If no handler is provided the default implementation will be used.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Retrieves the CfxAccessibilityHandler provided by the event handler attached to the GetAccessibilityHandler event, if any. Returns null if no event handler is attached.

Called to retrieve the root window rectangle in screen coordinates. Return true (1) if the rectangle was provided.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called to retrieve the view rectangle which is relative to screen coordinates. Return true (1) if the rectangle was provided.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called to retrieve the translation from view coordinates to actual screen coordinates. Return true (1) if the screen coordinates were provided.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called to allow the client to fill in the CfxScreenInfo object with appropriate values. Return true (1) if the |ScreenInfo| structure has been modified. If the screen info rectangle is left NULL the rectangle from GetViewRect will be used. If the rectangle is still NULL or invalid popups may not be drawn correctly.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when the browser wants to show or hide the popup widget. The popup should be shown if |Show| is true (1) and hidden if |Show| is false (0).

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when the browser wants to move or resize the popup widget. |Rect| contains the new location and size in view coordinates.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when an element should be painted. Pixel values passed to this function are scaled relative to view coordinates based on the value of CfxScreenInfo.DeviceScaleFactor returned from GetScreenInfo. |Type| indicates whether the element is the view or the popup widget. |Buffer| contains the pixel data for the whole image. |DirtyRects| contains the set of rectangles in pixel coordinates that need to be repainted. |Buffer| will be |Width|*|Height|*4 bytes in size and represents a BGRA image with an upper-left origin.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when the browser's cursor has changed. If |Type| is CT_CUSTOM then |CustomCursorInfo| will be populated with the custom cursor information.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when the user starts dragging content in the web view. Contextual information about the dragged content is supplied by |DragData|. (|X|, |Y|) is the drag start location in screen coordinates. OS APIs that run a system message loop may be used within the StartDragging call. Return false (0) to abort the drag operation. Don't call any of CfxBrowserHost.DragSource*Ended* functions after returning false (0). Return true (1) to handle the drag operation. Call CfxBrowserHost.DragSourceEndedAt and DragSourceSystemDragEnded either synchronously or asynchronously to inform the web view that the drag operation has ended.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when the web view wants to update the mouse cursor during a drag & drop operation. |Operation| describes the allowed operation (none, move, copy, link).

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when the scroll offset has changed.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

Called when the IME composition range has changed. |SelectedRange| is the range of characters that have been selected. |CharacterBounds| is the bounds of each character in view coordinates.

See also the original CEF documentation in cef/include/capi/cef_render_handler_capi.h.

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.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called after the render process main thread has been created. |ExtraInfo| is a read-only value originating from CfxBrowserProcessHandler.OnRenderProcessThreadCreated(). Do not keep a reference to |ExtraInfo| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called after WebKit has been initialized.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called after a browser has been created. When browsing cross-origin a new browser will be created before the old browser with the same identifier is destroyed.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called before a browser is destroyed.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Return the handler for browser load status events.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Retrieves the CfxLoadHandler provided by the event handler attached to the GetLoadHandler event, if any. Returns null if no event handler is attached.

Called before browser navigation. Return true (1) to cancel the navigation or false (0) to allow the navigation to proceed. The |Request| object cannot be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called immediately after the V8 context for a frame has been created. To retrieve the JavaScript 'window' object use the CfxV8Context.GetGlobal() function. V8 handles can only be accessed from the thread on which they are created. A task runner for posting tasks on the associated thread can be retrieved via the CfxV8Context.GetTaskRunner() function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called immediately before the V8 context for a frame is released. No references to the context should be kept after this function is called.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called for global uncaught exceptions in a frame. Execution of this callback is disabled by default. To enable set CfxSettings.UncaughtExceptionStackSize > 0.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called when a new node in the the browser gets focus. The |Node| value may be NULL if no specific node has gained focus. The node object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called when a new message is received from a different process. Return true (1) if the message was handled or false (0) otherwise. Do not keep a reference to or attempt to access the message outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Structure used to represent a web request. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Create a new CfxRequest object.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Returns true (1) if this object is read-only.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get or set the fully qualified URL.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the request function type. The value will default to POST if post data is provided and GET otherwise. Set the request function type.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the referrer URL.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the referrer policy.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get or set the post data.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the flags used in combination with CfxUrlRequest. See CfxUrlRequestFlags for supported values. Set the flags used in combination with CfxUrlRequest. See CfxUrlRequestFlags for supported values.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Set the URL to the first party for cookies used in combination with CfxUrlRequest. Get the URL to the first party for cookies used in combination with CfxUrlRequest.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the resource type for this request. Only available in the browser process.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the transition type for this request. Only available in the browser process and only applies to requests that represent a main frame or sub- frame navigation.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Returns the globally unique identifier for this request or 0 if not specified. Can be used by CfxRequestHandler implementations in the browser process to track a single request across multiple callbacks.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Set the referrer URL and policy. If non-NULL the referrer URL must be fully qualified with an HTTP or HTTPS scheme component. Any username, password or ref component will be removed.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the header values. Will not include the Referer value if any.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Set the header values. If a Referer value exists in the header map it will be removed and ignored.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Set all values at one time.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Callback structure used for asynchronous continuation of url requests.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Continue the url request. If |allow| is true (1) the request will be continued. Otherwise, the request will be canceled.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Cancel the url request.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

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 CfxBrowserHost static factory functions or when creating a new URL request via the CfxUrlRequest 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 CfxBrowserHost static factory function and all other request context objects will be ignored.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Returns the global context object.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Creates a new context object with the specified |settings| and optional |handler|.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Returns true (1) if this object is the global context. The global context is used by default when creating a browser or URL request with a NULL context argument.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Returns the handler for this context if any.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Returns the cache path for this object. If NULL an "incognito mode" in- memory cache is being used.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Returns true (1) if this object is pointing to the same context as |that| object.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Returns true (1) if this object is sharing the same storage as |that| object.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Returns the default cookie manager for this object. This will be the global cookie manager if this object is the global request context. Otherwise, this will be the default cookie manager used when this request context does not receive a value via CfxRequestContextHandler.GetCookieManager(). If |callback| is non-NULL it will be executed asnychronously on the IO thread after the manager's storage has been initialized.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Register a scheme handler factory for the specified |schemeName| and optional |domainName|. An NULL |domainName| value for a standard scheme will cause the factory to match all domain names. The |domainName| value will be ignored for non-standard schemes. If |schemeName| is a built-in scheme and no handler is returned by |factory| then the built-in scheme handler factory will be called. If |schemeName| is a custom scheme then you must also implement the CfxApp.OnRegisterCustomSchemes() function in all processes. This function may be called multiple times to change or remove the factory that matches the specified |schemeName| and optional |domainName|. Returns false (0) if an error occurs. This function may be called on any thread in the browser process.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Clear all registered scheme handler factories. Returns false (0) on error. This function may be called on any thread in the browser process.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Tells all renderer processes associated with this context to throw away their plugin list cache. If |reloadPages| is true (1) they will also reload all pages with plugins. CfxRequestContextHandler.OnBeforePluginLoad may be called to rebuild the plugin list cache.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Returns true (1) if a preference with the specified |name| exists. This function must be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Returns the value for the preference with the specified |name|. Returns NULL if the preference does not exist. The returned object contains a copy of the underlying preference value and modifications to the returned object will not modify the underlying preference value. This function must be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Returns all preferences as a dictionary. If |includeDefaults| is true (1) then preferences currently at their default value will be included. The returned object contains a copy of the underlying preference values and modifications to the returned object will not modify the underlying preference values. This function must be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Returns true (1) if the preference with the specified |name| can be modified using SetPreference. As one example preferences set via the command-line usually cannot be modified. This function must be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Set the |value| associated with preference |name|. Returns true (1) if the value is set successfully and false (0) otherwise. If |value| is NULL the preference will be restored to its default value. If setting the preference fails then |error| will be populated with a detailed description of the problem. This function must be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Clears all certificate exceptions that were added as part of handling CfxRequestHandler.OnCertificateError(). If you call this it is recommended that you also call close_all_connections() or you risk not being prompted again for server certificates if you reconnect quickly. If |callback| is non-NULL it will be executed on the UI thread after completion.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Clears all active and idle connections that Chromium currently has. This is only recommended if you have released all other CEF objects but don't yet want to call cef_shutdown(). If |callback| is non-NULL it will be executed on the UI thread after completion.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Attempts to resolve |origin| to a list of associated IP addresses. |callback| will be executed on the UI thread after completion.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Attempts to resolve |origin| to a list of associated IP addresses using cached data. |resolvedIps| will be populated with the list of resolved IP addresses or NULL if no cached data is available. Returns ERR_NONE on success. This function must be called on the browser process IO thread.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Load an extension. If extension resources will be read from disk using the default load implementation then |rootDirectory| should be the absolute path to the extension resources directory and |manifest| should be NULL. If extension resources will be provided by the client (e.g. via CfxRequestHandler and/or CfxExtensionHandler) then |rootDirectory| should be a path component unique to the extension (if not absolute this will be internally prefixed with the PK_DIR_RESOURCES path) and |manifest| should contain the contents that would otherwise be read from the "manifest.json" file on disk. The loaded extension will be accessible in all contexts sharing the same storage (HasExtension returns true (1)). However, only the context on which this function was called is considered the loader (DidLoadExtension returns true (1)) and only the loader will receive CfxRequestContextHandler callbacks for the extension. CfxExtensionHandler.OnExtensionLoaded will be called on load success or CfxExtensionHandler.OnExtensionLoadFailed will be called on load failure. If the extension specifies a background script via the "background" manifest key then CfxExtensionHandler.OnBeforeBackgroundBrowser will be called to create the background browser. See that function for additional information about background scripts. For visible extension views the client application should evaluate the manifest to determine the correct extension URL to load and then pass that URL to the CfxBrowserHost.CreateBrowser* function after the extension has loaded. For example, the client can look for the "browser_action" manifest key as documented at https://developer.chrome.com/extensions/browserAction. Extension URLs take the form "chrome-extension://<extension_id>/<path>". Browsers that host extensions differ from normal browsers as follows: - Can access chrome.* JavaScript APIs if allowed by the manifest. Visit chrome://extensions-support for the list of extension APIs currently supported by CEF. - Main frame navigation to non-extension content is blocked. - Pinch-zooming is disabled. - CfxBrowserHost.GetExtension returns the hosted extension. - CfxBrowserHost.IsBackgroundHost returns true for background hosts. See https://developer.chrome.com/extensions for extension implementation and usage documentation.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Returns true (1) if this context was used to load the extension identified by |extensionId|. Other contexts sharing the same storage will also have access to the extension (see HasExtension). This function must be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Returns true (1) if this context has access to the extension identified by |extensionId|. This may not be the context that was used to load the extension (see DidLoadExtension). This function must be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Retrieve the list of all extensions that this context has access to (see HasExtension). |extensionIds| will be populated with the list of extension ID values. Returns true (1) on success. This function must be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Returns the extension matching |extensionId| or NULL if no matching extension is accessible in this context (see HasExtension). This function must be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Implement this structure to provide handler implementations. The handler instance will not be released until all objects related to the context have been destroyed.

See also the original CEF documentation in cef/include/capi/cef_request_context_handler_capi.h.

Called on the browser process UI thread immediately after the request context has been initialized.

See also the original CEF documentation in cef/include/capi/cef_request_context_handler_capi.h.

Called on the browser process IO thread to retrieve the cookie manager. If this function returns NULL the default cookie manager retrievable via CfxRequestContext.GetDefaultCookieManager() will be used.

See also the original CEF documentation in cef/include/capi/cef_request_context_handler_capi.h.

Retrieves the CfxCookieManager provided by the event handler attached to the GetCookieManager event, if any. Returns null if no event handler is attached.

Called on multiple browser process threads before a plugin instance is loaded. |MimeType| is the mime type of the plugin that will be loaded. |PluginUrl| is the content URL that the plugin will load and may be NULL. |IsMainFrame| will be true (1) if the plugin is being loaded in the main (top-level) frame, |TopOriginUrl| is the URL for the top-level frame that contains the plugin when loading a specific plugin instance or NULL when building the initial list of enabled plugins for 'navigator.plugins' JavaScript state. |PluginInfo| includes additional information about the plugin that will be loaded. |PluginPolicy| is the recommended policy. Modify |PluginPolicy| and return true (1) to change the policy. Return false (0) to use the recommended policy. The default plugin policy can be set at runtime using the `--plugin-policy=[allow|Detect|block]` command- line flag. Decisions to mark a plugin as disabled by setting |PluginPolicy| to PLUGIN_POLICY_DISABLED may be cached when |TopOriginUrl| is NULL. To purge the plugin list cache and potentially trigger new calls to this function call CfxRequestContext.PurgePluginListCache.

See also the original CEF documentation in cef/include/capi/cef_request_context_handler_capi.h.

Request context initialization settings. Specify NULL or 0 to get the recommended default values.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The location where cache data will be stored on disk. If empty then browsers will be created in "incognito mode" where in-memory caches are used for storage and no data is persisted to disk. HTML5 databases such as localStorage will only persist across sessions if a cache path is specified. To share the global browser cache and related configuration set this value to match the CfxSettings.CachePath value.

See also the original CEF documentation in cef/include/internal/cef_types.h.

To persist session cookies (cookies without an expiry date or validity interval) by default when using the global cookie manager set this value to true (1). Session cookies are generally intended to be transient and most Web browsers do not persist them. Can be set globally using the CfxSettings.PersistSessionCookies value. This value will be ignored if |cachePath| is empty or if it matches the CfxSettings.CachePath value.

See also the original CEF documentation in cef/include/internal/cef_types.h.

To persist user preferences as a JSON file in the cache path directory set this value to true (1). Can be set globally using the CfxSettings.PersistUserPreferences value. This value will be ignored if |cachePath| is empty or if it matches the CfxSettings.CachePath value.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) to ignore errors related to invalid SSL certificates. Enabling this setting can lead to potential security vulnerabilities like "man in the middle" attacks. Applications that load content from the internet should not enable this setting. Can be set globally using the CfxSettings.IgnoreCertificateErrors value. This value will be ignored if |cachePath| matches the CfxSettings.CachePath value.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) to enable date-based expiration of built in network security information (i.e. certificate transparency logs, HSTS preloading and pinning information). Enabling this option improves network security but may cause HTTPS load failures when using CEF binaries built more than 10 weeks in the past. See https://www.certificate-transparency.org/ and https://www.chromium.org/hsts for details. Can be set globally using the CfxSettings.EnableNetSecurityExpiration value.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Comma delimited ordered list of language codes without any whitespace that will be used in the "Accept-Language" HTTP header. Can be set globally using the CfxSettings.AcceptLanguageList value or overridden on a per- browser basis using the CfxBrowserSettings.AcceptLanguageList value. If all values are empty then "en-US,en" will be used. This value will be ignored if |cachePath| matches the CfxSettings.CachePath value.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Implement this structure to handle events related to browser requests. The functions of this structure will be called on the thread indicated.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the UI thread before browser navigation. Return true (1) to cancel the navigation or false (0) to allow the navigation to proceed. The |Request| object cannot be modified in this callback. CfxLoadHandler.OnLoadingStateChange will be called twice in all cases. If the navigation is allowed CfxLoadHandler.OnLoadStart and CfxLoadHandler.OnLoadEnd will be called. If the navigation is canceled CfxLoadHandler.OnLoadError will be called with an |ErrorCode| value of ERR_ABORTED.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the UI thread before OnBeforeBrowse in certain limited cases where navigating a new or different browser might be desirable. This includes user-initiated navigation that might open in a special way (e.g. links clicked via middle-click or ctrl + left-click) and certain types of cross-origin navigation initiated from the renderer process (e.g. navigating the top-level frame to/from a file URL). The |Browser| and |Frame| values represent the source of the navigation. The |TargetDisposition| value indicates where the user intended to navigate the browser based on standard Chromium behaviors (e.g. current tab, new tab, etc). The |UserGesture| value will be true (1) if the browser navigated via explicit user gesture (e.g. clicking a link) or false (0) if it navigated automatically (e.g. via the DomContentLoaded event). Return true (1) to cancel the navigation or false (0) to allow the navigation to proceed in the source browser's top-level frame.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread before a resource request is loaded. The |Request| object may be modified. Return RV_CONTINUE to continue the request immediately. Return RV_CONTINUE_ASYNC and call CfxRequestCallback:: cont() at a later time to continue or cancel the request asynchronously. Return RV_CANCEL to cancel the request immediately.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread before a resource is loaded. To allow the resource to load normally return NULL. To specify a handler for the resource return a CfxResourceHandler object. The |Request| object should not be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread when a resource load is redirected. The |Request| parameter will contain the old URL and other request-related information. The |Response| parameter will contain the response that resulted in the redirect. The |NewUrl| parameter will contain the new URL and can be changed if desired. The |Request| object cannot be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread when a resource response is received. To allow the resource to load normally return false (0). To redirect or retry the resource modify |Request| (url, headers or post body) and return true (1). The |Response| object cannot be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread to optionally filter resource response content. |Request| and |Response| represent the request and response respectively and cannot be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread when a resource load has completed. |Request| and |Response| represent the request and response respectively and cannot be modified in this callback. |Status| indicates the load completion status. |ReceivedContentLength| is the number of response bytes actually read.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread when the browser needs credentials from the user. |IsProxy| indicates whether the host is a proxy server. |Host| contains the hostname and |Port| contains the port number. |Realm| is the realm of the challenge and may be NULL. |Scheme| is the authentication scheme used, such as "basic" or "digest", and will be NULL if the source of the request is an FTP server. Return true (1) to continue the request and call CfxAuthCallback.Continue() either in this function or at a later time when the authentication information is available. Return false (0) to cancel the request immediately.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the IO thread when JavaScript requests a specific storage quota size via the webkitStorageInfo.requestQuota function. |OriginUrl| is the origin of the page making the request. |NewSize| is the requested quota size in bytes. Return true (1) to continue the request and call CfxRequestCallback.Continue() either in this function or at a later time to grant or deny the request. Return false (0) to cancel the request immediately.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the UI thread to handle requests for URLs with an unknown protocol component. Set |AllowOsExecution| to true (1) to attempt execution via the registered OS protocol handler, if any. SECURITY WARNING: YOU SHOULD USE THIS METHOD TO ENFORCE RESTRICTIONS BASED ON SCHEME, HOST OR OTHER URL ANALYSIS BEFORE ALLOWING OS EXECUTION.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the UI thread to handle requests for URLs with an invalid SSL certificate. Return true (1) and call CfxRequestCallback.Continue() either in this function or at a later time to continue or cancel the request. Return false (0) to cancel the request immediately. If CfxSettings.IgnoreCertificateErrors is set all invalid certificates will be accepted without calling this function.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the UI thread when a client certificate is being requested for authentication. Return false (0) to use the default behavior and automatically select the first certificate available. Return true (1) and call CfxSelectClientCertificateCallback.Select either in this function or at a later time to select a certificate. Do not call Select or call it with NULL to continue without using any certificate. |IsProxy| indicates whether the host is an HTTPS proxy or the origin server. |Host| and |Port| contains the hostname and port of the SSL server. |Certificates| is the list of certificates to choose from; this list has already been pruned by Chromium so that it only contains certificates from issuers that the server trusts.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the browser process UI thread when a plugin has crashed. |PluginPath| is the path of the plugin that crashed.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the browser process UI thread when the render view associated with |Browser| is ready to receive/handle IPC messages in the render process.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Called on the browser process UI thread when the render process terminates unexpectedly. |Status| indicates how the process terminated.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Callback structure for CfxRequestContext.ResolveHost.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Called on the UI thread after the ResolveHost request has completed. |Result| will be the result code. |ResolvedIps| will be the list of resolved IP addresses or NULL if the resolution failed.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Structure used for retrieving resources from the resource bundle (*.pak) files loaded by CEF during startup or via the CfxResourceBundleHandler returned from CfxApp.GetResourceBundleHandler. See CfxSettings for additional options related to resource bundle loading. The functions of this structure may be called on any thread unless otherwise indicated.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_capi.h.

Returns the global resource bundle instance.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_capi.h.

Returns the localized string for the specified |stringId| or an NULL string if the value is not found. Include cef_pack_strings.h for a listing of valid string ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_capi.h.

Retrieves the contents of the specified scale independent |resourceId|. If the value is found then |data| and |dataSize| will be populated and this function will return true (1). If the value is not found then this function will return false (0). The returned |data| pointer will remain resident in memory and should not be freed. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_capi.h.

Retrieves the contents of the specified |resourceId| nearest the scale factor |scaleFactor|. Use a |scaleFactor| value of SCALE_FACTOR_NONE for scale independent resources or call GetDataResource instead. If the value is found then |data| and |dataSize| will be populated and this function will return true (1). If the value is not found then this function will return false (0). The returned |data| pointer will remain resident in memory and should not be freed. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_capi.h.

Structure used to implement a custom resource bundle structure. See CfxSettings for additional options related to resource bundle loading. The functions of this structure may be called on multiple threads.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Called to retrieve a localized translation for the specified |StringId|. To provide the translation set |String| to the translation string and return true (1). To use the default translation return false (0). Include cef_pack_strings.h for a listing of valid string ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Called to retrieve data for the specified scale independent |ResourceId|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Called to retrieve data for the specified |ResourceId| nearest the scale factor |ScaleFactor|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Structure used to implement a custom request handler structure. The functions of this structure will always be called on the IO thread.

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Begin processing the request. To handle the request return true (1) and call CfxCallback.Continue() once the response header information is available (CfxCallback.Continue() can also be called from inside this function if header information is available immediately). To cancel the request return false (0).

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Retrieve response header information. If the response length is not known set |ResponseLength| to -1 and read_response() will be called until it returns false (0). If the response length is known set |ResponseLength| to a positive value and read_response() will be called until it returns false (0) or the specified number of bytes have been read. Use the |Response| object to set the mime type, http status code and other optional header values. To redirect the request to a new URL set |RedirectUrl| to the new URL. If an error occured while setting up the request you can call set_error() on |Response| to indicate the error condition.

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Read response data. If data is available immediately copy up to |BytesToRead| bytes into |DataOut|, set |BytesRead| to the number of bytes copied, and return true (1). To read the data at a later time set |BytesRead| to 0, return true (1) and call CfxCallback.Continue() when the data is available. To indicate response completion return false (0).

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Return true (1) if the specified cookie can be sent with the request or false (0) otherwise. If false (0) is returned for any cookie then no cookies will be sent with the request.

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Return true (1) if the specified cookie returned with the response can be set or false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Request processing has been canceled.

See also the original CEF documentation in cef/include/capi/cef_resource_handler_capi.h.

Structure used to represent a web response. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Create a new CfxResponse object.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Returns true (1) if this object is read-only.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Get the response error code. Returns ERR_NONE if there was no error. Set the response error code. This can be used by custom scheme handlers to return errors during initial request processing.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Get or set the response status code.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Get or set the response status text.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Get or set the response mime type.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Get the value for the specified response header field.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Get all response header fields.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Set all response header fields.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Implement this structure to filter resource response content. The functions of this structure will be called on the browser process IO thread.

See also the original CEF documentation in cef/include/capi/cef_response_filter_capi.h.

Initialize the response filter. Will only be called a single time. The filter will not be installed if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_response_filter_capi.h.

Called to filter a chunk of data. Expected usage is as follows: A. Read input data from |DataIn| and set |DataInRead| to the number of bytes that were read up to a maximum of |DataInSize|. |DataIn| will be NULL if |DataInSize| is zero. B. Write filtered output data to |DataOut| and set |DataOutWritten| to the number of bytes that were written up to a maximum of |DataOutSize|. If no output data was written then all data must be read from |DataIn| (user must set |DataInRead| = |DataInSize|). C. Return RESPONSE_FILTER_DONE if all output data was written or RESPONSE_FILTER_NEED_MORE_DATA if output data is still pending. This function will be called repeatedly until the input buffer has been fully read (user sets |DataInRead| = |DataInSize|) and there is no more input data to filter (the resource response is complete). This function may then be called an additional time with an NULL input buffer if the user filled the output buffer (set |DataOutWritten| = |DataOutSize|) and returned RESPONSE_FILTER_NEED_MORE_DATA to indicate that output data is still pending. Calls to this function will stop when one of the following conditions is met: A. There is no more input data to filter (the resource response is complete) and the user sets |DataOutWritten| = 0 or returns RESPONSE_FILTER_DONE to indicate that all data has been written, or; B. The user returns RESPONSE_FILTER_ERROR to indicate an error. Do not keep a reference to the buffers passed to this function.

See also the original CEF documentation in cef/include/capi/cef_response_filter_capi.h.

Callback structure used for continuation of custom context menu display.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Complete context menu display by selecting the specified |commandId| and |eventFlags|.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Cancel context menu display.

See also the original CEF documentation in cef/include/capi/cef_context_menu_handler_capi.h.

Callback structure for CfxBrowserHost.RunFileDialog. The functions of this structure will be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Called asynchronously after the file dialog is dismissed. |SelectedAcceptFilter| is the 0-based index of the value selected from the accept filters array passed to CfxBrowserHost.RunFileDialog. |FilePaths| will be a single value or a list of values depending on the dialog mode. If the selection was cancelled |FilePaths| will be NULL.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Collection of global static CEF functions.

Add an entry to the cross-origin access whitelist. The same-origin policy restricts how scripts hosted from different origins (scheme + domain + port) can communicate. By default, scripts can only access resources with the same origin. Scripts hosted on the HTTP and HTTPS schemes (but no other schemes) can use the "Access-Control-Allow-Origin" header to allow cross-origin requests. For example, https://source.example.com can make XMLHttpRequest requests on http://target.example.com if the http://target.example.com request returns an "Access-Control-Allow-Origin: https://source.example.com" response header. Scripts in separate frames or iframes and hosted from the same protocol and domain suffix can execute cross-origin JavaScript if both pages set the document.domain value to the same domain suffix. For example, scheme://foo.example.com and scheme://bar.example.com can communicate using JavaScript if both domains set document.domain="example.com". This function is used to allow access to origins that would otherwise violate the same-origin policy. Scripts hosted underneath the fully qualified |sourceOrigin| URL (like http://www.example.com) will be allowed access to all resources hosted on the specified |targetProtocol| and |targetDomain|. If |targetDomain| is non-NULL and |allowTargetSubdomains| if false (0) only exact domain matches will be allowed. If |targetDomain| contains a top- level domain component (like "example.com") and |allowTargetSubdomains| is true (1) sub-domain matches will be allowed. If |targetDomain| is NULL and |allowTargetSubdomains| if true (1) all domains and IP addresses will be allowed. This function cannot be used to bypass the restrictions on local or display isolated schemes. See the comments on CfxRegisterCustomScheme for more information. This function may be called on any thread. Returns false (0) if |sourceOrigin| is invalid or the whitelist cannot be accessed.

See also the original CEF documentation in cef/include/capi/cef_origin_whitelist_capi.h.

Returns CEF API hashes for the libcef library. The returned string is owned by the library and should not be freed. The |entry| parameter describes which hash value will be returned: 0 - CEF_API_HASH_PLATFORM 1 - CEF_API_HASH_UNIVERSAL 2 - CEF_COMMIT_HASH

See also the original CEF documentation in cef/include/cef_version.h.

Decodes the base64 encoded string |data|. The returned value will be NULL if the decoding fails.

See also the original CEF documentation in cef/include/capi/cef_parser_capi.h.

Encodes |data| as a base64 string.

See also the original CEF documentation in cef/include/capi/cef_parser_capi.h.

Start tracing events on all processes. Tracing is initialized asynchronously and |callback| will be executed on the UI thread after initialization is complete. If CfxBeginTracing was called previously, or if a CfxEndTracingAsync call is pending, CfxBeginTracing will fail and return false (0). |categories| is a comma-delimited list of category wildcards. A category can have an optional '-' prefix to make it an excluded category. Having both included and excluded categories in the same list is not supported. Example: "test_MyTest*" Example: "test_MyTest*,test_OtherStuff" Example: "-excluded_category1,-excluded_category2" This function must be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_trace_capi.h.

Remove all entries from the cross-origin access whitelist. Returns false (0) if the whitelist cannot be accessed.

See also the original CEF documentation in cef/include/capi/cef_origin_whitelist_capi.h.

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 c ef_request_tContext::cef_request_context_get_global_context()->clear_scheme_h andler_factories().

See also the original CEF documentation in cef/include/capi/cef_scheme_capi.h.

Crash reporting is configured using an INI-style config file named "crash_reporter.cfg". On Windows and Linux this file must be placed next to the main application executable. On macOS this file must be placed in the top-level app bundle Resources directory (e.g. "<appname>.app/Contents/Resources"). File contents are as follows: # Comments start with a hash character and must be on their own line. [Config] ProductName=<Value of the "prod" crash key; defaults to "cef"> ProductVersion=<Value of the "ver" crash key; defaults to the CEF version> AppName=<Windows only; App-specific folder name component for storing crash information; default to "CEF"> ExternalHandler=<Windows only; Name of the external handler exe to use instead of re-launching the main exe; default to empty> BrowserCrashForwardingEnabled=<macOS only; True if browser process crashes should be forwarded to the system crash reporter; default to false> ServerURL=<crash server URL; default to empty> RateLimitEnabled=<True if uploads should be rate limited; default to true> MaxUploadsPerDay=<Max uploads per 24 hours, used if rate limit is enabled; default to 5> MaxDatabaseSizeInMb=<Total crash report disk usage greater than this value will cause older reports to be deleted; default to 20> MaxDatabaseAgeInDays=<Crash reports older than this value will be deleted; default to 5> [CrashKeys] my_key1=<small|medium|large> my_key2=<small|medium|large> Config section: If "ProductName" and/or "ProductVersion" are set then the specified values will be included in the crash dump metadata. On macOS if these values are set to NULL then they will be retrieved from the Info.plist file using the "CFBundleName" and "CFBundleShortVersionString" keys respectively. If "AppName" is set on Windows then crash report information (metrics, database and dumps) will be stored locally on disk under the "C:\Users\[CurrentUser]\AppData\Local\[AppName]\User Data" folder. On other platforms the CfxSettings.UserDataPath value will be used. If "ExternalHandler" is set on Windows then the specified exe will be launched as the crashpad-handler instead of re-launching the main process exe. The value can be an absolute path or a path relative to the main exe directory. On Linux the CfxSettings.BrowserSubprocessPath value will be used. On macOS the existing subprocess app bundle will be used. If "BrowserCrashForwardingEnabled" is set to true (1) on macOS then browser process crashes will be forwarded to the system crash reporter. This results in the crash UI dialog being displayed to the user and crash reports being logged under "~/Library/Logs/DiagnosticReports". Forwarding of crash reports from non-browser processes and Debug builds is always disabled. If "ServerURL" is set then crashes will be uploaded as a multi-part POST request to the specified URL. Otherwise, reports will only be stored locally on disk. If "RateLimitEnabled" is set to true (1) then crash report uploads will be rate limited as follows: 1. If "MaxUploadsPerDay" is set to a positive value then at most the specified number of crashes will be uploaded in each 24 hour period. 2. If crash upload fails due to a network or server error then an incremental backoff delay up to a maximum of 24 hours will be applied for retries. 3. If a backoff delay is applied and "MaxUploadsPerDay" is > 1 then the "MaxUploadsPerDay" value will be reduced to 1 until the client is restarted. This helps to avoid an upload flood when the network or server error is resolved. Rate limiting is not supported on Linux. If "MaxDatabaseSizeInMb" is set to a positive value then crash report storage on disk will be limited to that size in megabytes. For example, on Windows each dump is about 600KB so a "MaxDatabaseSizeInMb" value of 20 equates to about 34 crash reports stored on disk. Not supported on Linux. If "MaxDatabaseAgeInDays" is set to a positive value then crash reports older than the specified age in days will be deleted. Not supported on Linux. CrashKeys section: Any number of crash keys can be specified for use by the application. Crash key values will be truncated based on the specified size (small = 63 bytes, medium = 252 bytes, large = 1008 bytes). The value of crash keys can be set from any thread or process using the CfxSetCrashKeyValue function. These key/value pairs will be sent to the crash server along with the crash dump file. Medium and large values will be chunked for submission. For example, if your key is named "mykey" then the value will be broken into ordered chunks and submitted using keys named "mykey-1", "mykey-2", etc.

See also the original CEF documentation in cef/include/capi/cef_crash_util_capi.h.

Creates a new context object that shares storage with |other| and uses an optional |handler|.

See also the original CEF documentation in cef/include/capi/cef_request_context_capi.h.

Creates a directory and all parent directories if they don't already exist. Returns true (1) on successful creation or if the directory already exists. The directory is only readable by the current user. Calling this function on the browser process UI or IO threads is not allowed.

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

Creates a new directory. On Windows if |prefix| is provided the new directory name is in the format of "prefixyyyy". Returns true (1) on success and sets |newTempPath| to the full path of the directory that was created. The directory is only readable by the current user. Calling this function on the browser process UI or IO threads is not allowed.

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

Creates a directory within another directory. Extra characters will be appended to |prefix| to ensure that the new directory does not have the same name as an existing directory. Returns true (1) on success and sets |newDir| to the full path of the directory that was created. The directory is only readable by the current user. Calling this function on the browser process UI or IO threads is not allowed.

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

Creates a URL from the specified |parts|, which must contain a non-NULL spec or a non-NULL host and path (at a minimum), but not both. Returns false (0) if |parts| isn't initialized as described.

See also the original CEF documentation in cef/include/capi/cef_parser_capi.h.

Returns true (1) if called on the specified thread. Equivalent to using CfxTaskRunner.GetForThread(threadId).BelongsToCurrentThread().

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Deletes the given path whether it's a file or a directory. If |path| is a directory all contents will be deleted. If |recursive| is true (1) any sub- directories and their contents will also be deleted (equivalent to executing "rm -rf", so use with caution). On POSIX environments if |path| is a symbolic link then only the symlink will be deleted. Returns true (1) on successful deletion or if |path| does not exist. Calling this function on the browser process UI or IO threads is not allowed.

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

Returns true (1) if the given path exists and is a directory. Calling this function on the browser process UI or IO threads is not allowed.

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

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 CfxSettings.MultiThreadedMessageLoop if possible. When using this function care must be taken to balance performance against excessive CPU usage. It is recommended to enable the CfxSettings.ExternalMessagePump option when using this function so that CfxBrowserProcessHandler.OnScheduleMessagePumpWork() 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 CfxSettings.MultiThreadedMessageLoop value of false (0). This function will not block.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Call during process startup to enable High-DPI support on Windows 7 or newer. Older versions of Windows should be left DPI-unaware because they do not support DirectWrite and GDI fonts are kerned very badly.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Stop tracing events on all processes. This function will fail and return false (0) if a previous call to CfxEndTracingAsync is already pending or if CfxBeginTracing was not called. |tracingFile| is the path at which tracing data will be written and |callback| is the callback that will be executed once all processes have sent their trace data. If |tracingFile| is NULL a new temporary file path will be used. If |callback| is NULL no trace data will be written. This function must be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_trace_capi.h.

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 CfxSettings.BrowserSubprocessPath 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 |windowsSandboxInfo| parameter is only used on Windows and may be NULL (see cef_sandbox_win.h for details).

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

This is a convenience function for formatting a URL in a concise and human- friendly way to help users make security-related decisions (or in other circumstances when people need to distinguish sites, origins, or otherwise- simplified URLs from each other). Internationalized domain names (IDN) may be presented in Unicode if the conversion is considered safe. The returned value will (a) omit the path for standard schemes, excepting file and filesystem, and (b) omit the port if it is the default for the scheme. Do not use this for URLs which will be parsed or sent to other applications.

See also the original CEF documentation in cef/include/capi/cef_parser_capi.h.

Get the extensions associated with the given mime type. This should be passed in lower case. There could be multiple extensions for a given mime type, like "html,htm" for "text/html", or "txt,text,html,..." for "text/*". Any existing elements in the provided vector will not be erased.

See also the original CEF documentation in cef/include/capi/cef_parser_capi.h.

Request a one-time geolocation update. This function bypasses any user permission checks so should only be used by code that is allowed to access location information.

See also the original CEF documentation in cef/include/capi/cef_geolocation_capi.h.

Returns the mime type for the specified file extension or an NULL string if unknown.

See also the original CEF documentation in cef/include/capi/cef_parser_capi.h.

Retrieve the path associated with the specified |key|. Returns true (1) on success. Can be called on any thread in the browser process.

See also the original CEF documentation in cef/include/capi/cef_path_util_capi.h.

Get the temporary directory provided by the system. WARNING: In general, you should use the temp directory variants below instead of this function. Those variants will ensure that the proper permissions are set so that other users on the system can't edit them while they're open (which could lead to security issues).

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

This function should be called on the main application thread to initialize the CEF browser process. The |application| parameter may be NULL. A return value of true (1) indicates that it succeeded and false (0) indicates that it failed. The |windowsSandboxInfo| parameter is only used on Windows and may be NULL (see cef_sandbox_win.h for details).

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Returns true (1) if the certificate status has any error, major or minor.

See also the original CEF documentation in cef/include/capi/cef_ssl_info_capi.h.

Returns true (1) if the certificate status represents only minor errors (e.g. failure to verify certificate revocation).

See also the original CEF documentation in cef/include/capi/cef_ssl_info_capi.h.

Query if a plugin is unstable. Can be called on any thread in the browser process.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Launches the process specified via |commandLine|. Returns true (1) upon success. Must be called on the browser process TID_PROCESS_LAUNCHER thread. Unix-specific notes: - All file descriptors open in the parent process will be closed in the child process except for stdin, stdout, and stderr. - If the first argument on the command line does not contain a slash, PATH will be searched. (See man execvp.)

See also the original CEF documentation in cef/include/capi/cef_process_util_capi.h.

Loads the existing "Certificate Revocation Lists" file that is managed by Google Chrome. This file can generally be found in Chrome's User Data directory (e.g. "C:\Users\[User]\AppData\Local\Google\Chrome\User Data\" on Windows) and is updated periodically by Chrome's component updater service. Must be called in the browser process after the context has been initialized. See https://dev.chromium.org/Home/chromium-security/crlsets for background.

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

Returns the current system trace time or, if none is defined, the current high-res time. Can be used by clients to synchronize with the time information in trace events.

See also the original CEF documentation in cef/include/capi/cef_trace_capi.h.

Parses the specified |jsonString| and returns a dictionary or list representation. If JSON parsing fails this function returns NULL.

See also the original CEF documentation in cef/include/capi/cef_parser_capi.h.

Parses the specified |jsonString| and returns a dictionary or list representation. If JSON parsing fails this function returns NULL and populates |errorCodeOut| and |errorMsgOut| with an error code and a formatted error message respectively.

See also the original CEF documentation in cef/include/capi/cef_parser_capi.h.

Parse the specified |url| into its component parts. Returns false (0) if the URL is NULL or invalid.

See also the original CEF documentation in cef/include/capi/cef_parser_capi.h.

Post a task for delayed execution on the specified thread. Equivalent to using CfxTaskRunner.GetForThread(threadId).PostDelayedTask(task, delay_ms).

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Post a task for execution on the specified thread. Equivalent to using CfxTaskRunner.GetForThread(threadId).PostTask(task).

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

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.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Cause the plugin list to refresh the next time it is accessed regardless of whether it has already been loaded. Can be called on any thread in the browser process.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

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. Example JavaScript extension code: <pre> // create the 'example' global object if it doesn't already exist. if (!example) example = {}; // create the 'example.test' global object if it doesn't already exist. if (!example.test) example.test = {}; (function() { // Define the function 'example.test.myfunction'. example.test.myfunction = function() { // Call CfxV8Handler.Execute() with the function name 'MyFunction' // and no arguments. native function MyFunction(); return MyFunction(); }; // Define the getter function for parameter 'example.test.myparam'. example.test.__defineGetter__('myparam', function() { // Call CfxV8Handler.Execute() with the function name 'GetMyParam' // and no arguments. native function GetMyParam(); return GetMyParam(); }); // Define the setter function for parameter 'example.test.myparam'. example.test.__defineSetter__('myparam', function(b) { // Call CfxV8Handler.Execute() with the function name 'SetMyParam' // and a single argument. native function SetMyParam(); if(b) SetMyParam(b); }); // Extension definitions can also contain normal JavaScript variables // and functions. var myint = 0; example.test.increment = function() { myint += 1; return myint; }; })(); </pre> Example usage in the page: <pre> // Call the function. example.test.myfunction(); // Set the parameter. example.test.myparam = value; // Get the parameter. value = example.test.myparam; // Call another function. example.test.increment(); </pre>

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Register a scheme handler factory with the global request context. An NULL |domainName| value for a standard scheme will cause the factory to match all domain names. The |domainName| value will be ignored for non-standard schemes. If |schemeName| is a built-in scheme and no handler is returned by |factory| then the built-in scheme handler factory will be called. If |schemeName| is a custom scheme then you must also implement the CfxApp.OnRegisterCustomSchemes() function in all processes. This function may be called multiple times to change or remove the factory that matches the specified |schemeName| and optional |domainName|. 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 CfxRequestCo ntext::cef_request_context_get_global_context()->register_scheme_handler_fact ory().

See also the original CEF documentation in cef/include/capi/cef_scheme_capi.h.

Register a plugin crash. Can be called on any thread in the browser process but will be executed on the IO thread.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Register the Widevine CDM plugin. The client application is responsible for downloading an appropriate platform-specific CDM binary distribution from Google, extracting the contents, and building the required directory structure on the local machine. The CfxBrowserHost.StartDownload function and CfxZipArchive structure can be used to implement this functionality in CEF. Contact Google via https://www.widevine.com/contact.html for details on CDM download. |path| is a directory that must contain the following files: 1. manifest.json file from the CDM binary distribution (see below). 2. widevinecdm file from the CDM binary distribution (e.g. widevinecdm.dll on on Windows, libwidevinecdm.dylib on OS X, libwidevinecdm.so on Linux). 3. widevidecdmadapter file from the CEF binary distribution (e.g. widevinecdmadapter.dll on Windows, widevinecdmadapter.plugin on OS X, libwidevinecdmadapter.so on Linux). If any of these files are missing or if the manifest file has incorrect contents the registration will fail and |callback| will receive a |result| value of CEF_CDM_REGISTRATION_ERROR_INCORRECT_CONTENTS. The manifest.json file must contain the following keys: A. "os": Supported OS (e.g. "mac", "win" or "linux"). B. "arch": Supported architecture (e.g. "ia32" or "x64"). C. "x-cdm-module-versions": Module API version (e.g. "4"). D. "x-cdm-interface-versions": Interface API version (e.g. "8"). E. "x-cdm-host-versions": Host API version (e.g. "8"). F. "version": CDM version (e.g. "1.4.8.903"). G. "x-cdm-codecs": List of supported codecs (e.g. "vp8,vp9.0,avc1"). A through E are used to verify compatibility with the current Chromium version. If the CDM is not compatible the registration will fail and |callback| will receive a |result| value of CEF_CDM_REGISTRATION_ERROR_INCOMPATIBLE. |callback| will be executed asynchronously once registration is complete. On Linux this function must be called before cef_initialize() and the registration cannot be changed during runtime. If registration is not supported at the time that cef_register_widevine_cdm() is called then |callback| will receive a |result| value of CEF_CDM_REGISTRATION_ERROR_NOT_SUPPORTED.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Remove an entry from the cross-origin access whitelist. Returns false (0) if |sourceOrigin| is invalid or the whitelist cannot be accessed.

See also the original CEF documentation in cef/include/capi/cef_origin_whitelist_capi.h.

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 CfxSettings.MultiThreadedMessageLoop value of false (0). This function will block until a quit message is received by the system.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Sets or clears a specific key-value pair from the crash metadata.

See also the original CEF documentation in cef/include/capi/cef_crash_util_capi.h.

Set to true (1) before calling Windows APIs like TrackPopupMenu that enter a modal message loop. Set to false (0) after exiting the modal message loop.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

This function should be called on the main application thread to shut down the CEF browser process before the application exits.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Unregister an internal plugin. This may be undone the next time cef_refresh_web_plugins() is called. Can be called on any thread in the browser process.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Unescapes |text| and returns the result. Unescaping consists of looking for the exact pattern "%XX" where each X is a hex digit and converting to the character with the numerical value of those digits (e.g. "i%20=%203%3b" unescapes to "i = 3;"). If |convertToUtf8| is true (1) this function will attempt to interpret the initial decoded result as UTF-8. If the result is convertable into UTF-8 it will be returned as converted. Otherwise the initial decoded result will be returned. The |unescapeRule| parameter supports further customization the decoding process.

See also the original CEF documentation in cef/include/capi/cef_parser_capi.h.

Escapes characters in |text| which are unsuitable for use as a query parameter value. Everything except alphanumerics and -_.!~*'() will be converted to "%XX". If |usePlus| is true (1) spaces will change to "+". The result is basically the same as encodeURIComponent in Javacript.

See also the original CEF documentation in cef/include/capi/cef_parser_capi.h.

Returns CEF version information for the libcef library. The |entry| parameter describes which version component will be returned: 0 - CEF_VERSION_MAJOR 1 - CEF_COMMIT_NUMBER 2 - CHROME_VERSION_MAJOR 3 - CHROME_VERSION_MINOR 4 - CHROME_VERSION_BUILD 5 - CHROME_VERSION_PATCH

See also the original CEF documentation in cef/include/cef_version.h.

Visit web plugin information. Can be called on any thread in the browser process.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Generates a JSON string from the specified root |node| which should be a dictionary or list value. Returns an NULL string on failure. This function requires exclusive access to |node| including any underlying data.

See also the original CEF documentation in cef/include/capi/cef_parser_capi.h.

Writes the contents of |srcDir| into a zip archive at |destFile|. If |includeHiddenFiles| is true (1) files starting with "." will be included. Returns true (1) on success. Calling this function on the browser process UI or IO threads is not allowed.

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

Return the singleton X11 display shared with Chromium. The display is not thread-safe and must only be accessed on the browser process UI thread.

See also the original CEF documentation in cef/include/internal/cef_types_linux.h.

Set the path to the directory containing the libcef library. If left blank the default locations are searched.

Set the path to the directory containing the libcfx library. If left blank the default locations are searched.

True if the native libraries are loaded.

The operating system ChromiumFX is currently running on.

The system architecture ChromiumFX is currently running on.

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 CefSettings.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. If the browser process was initialized with a valid render process startup callback, the render main thread will be redirected through the remoting interface into the browser process. The browser process' render process startup callback routine is then responsible for calling CfrRuntime.ExecuteProcess(). The chromium sandbox is currently not supported within ChromiumFX.

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 CefSettings.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. If the browser process was initialized with a valid render process startup callback, the render main thread will be redirected through the remoting interface into the browser process. The browser process' render process startup callback routine is then responsible for calling CfrRuntime.ExecuteProcess() and the |application| parameter will be ignored. The chromium sandbox is currently not supported within ChromiumFX.

This function should be called on the main application thread to initialize the CEF browser process with support for the remote interface to the render process. The |application| parameter may be NULL. A return value of true (1) indicates that it succeeded and false (0) indicates that it failed. If |renderProcessMain| is provided, then every newly created render process main thread will be redirected through this callback and the callee is responsible for calling CfrRuntime.ExecuteProcess() from within the scope of this callback. The chromium sandbox is currently not supported within ChromiumFX.

This function should be called on the main application thread to initialize the CEF browser process. The |application| parameter may be NULL. A return value of true (1) indicates that it succeeded and false (0) indicates that it failed. The chromium sandbox is currently not supported within ChromiumFX.

This function should be called on the main application thread to shut down the CEF browser process before the application exits.

Structure that creates CfxResourceHandler instances for handling scheme requests. The functions of this structure will always be called on the IO thread.

See also the original CEF documentation in cef/include/capi/cef_scheme_capi.h.

Return a new resource handler instance to handle the request or an NULL reference to allow default handling of the request. |Browser| and |Frame| will be the browser window and frame respectively that originated the request or NULL if the request did not originate from a browser window (for example, if the request came from CfxUrlRequest). The |Request| object passed to this function will not contain cookie data.

See also the original CEF documentation in cef/include/capi/cef_scheme_capi.h.

Structure that manages custom scheme registrations.

See also the original CEF documentation in cef/include/capi/cef_scheme_capi.h.

Register a custom scheme. This function should not be called for the built- in HTTP, HTTPS, FILE, FTP, ABOUT and DATA schemes. If |isStandard| is true (1) the scheme will be treated as a standard scheme. Standard schemes are subject to URL canonicalization and parsing rules as defined in the Common Internet Scheme Syntax RFC 1738 Section 3.1 available at http://www.ietf.org/rfc/rfc1738.txt In particular, the syntax for standard scheme URLs must be of the form: <pre> [scheme]://[username]:[password]@[host]:[port]/[url-path] </pre> Standard scheme URLs must have a host component that is a fully qualified domain name as defined in Section 3.5 of RFC 1034 [13] and Section 2.1 of RFC 1123. These URLs will be canonicalized to "scheme://host/path" in the simplest case and "scheme://username:password@host:port/path" in the most explicit case. For example, "scheme:host/path" and "scheme:///host/path" will both be canonicalized to "scheme://host/path". The origin of a standard scheme URL is the combination of scheme, host and port (i.e., "scheme://host:port" in the most explicit case). For non-standard scheme URLs only the "scheme:" component is parsed and canonicalized. The remainder of the URL will be passed to the handler as- is. For example, "scheme:///some%20text" will remain the same. Non-standard scheme URLs cannot be used as a target for form submission. If |isLocal| is true (1) the scheme will be treated with the same security rules as those applied to "file" URLs. Normal pages cannot link to or access local URLs. Also, by default, local URLs can only perform XMLHttpRequest calls to the same URL (origin + path) that originated the request. To allow XMLHttpRequest calls from a local URL to other URLs with the same origin set the CfxSettings.FileAccessFromFileUrlsAllowed value to true (1). To allow XMLHttpRequest calls from a local URL to all origins set the CfxSettings.UniversalAccessFromFileUrlsAllowed value to true (1). If |isDisplayIsolated| is true (1) the scheme can only be displayed from other content hosted with the same scheme. For example, pages in other origins cannot create iframes or hyperlinks to URLs with the scheme. For schemes that must be accessible from other schemes set this value to false (0), set |isCorsEnabled| to true (1), and use CORS "Access-Control-Allow- Origin" headers to further restrict access. If |isSecure| is true (1) the scheme will be treated with the same security rules as those applied to "https" URLs. For example, loading this scheme from other secure schemes will not trigger mixed content warnings. If |isCorsEnabled| is true (1) the scheme can be sent CORS requests. This value should be true (1) in most cases where |isStandard| is true (1). If |isCspBypassing| is true (1) the scheme can bypass Content-Security- Policy (CSP) checks. This value should be false (0) in most cases where |isStandard| is true (1). This function may be called on any thread. It should only be called once per unique |schemeName| value. If |schemeName| is already registered or if an error occurs this function will return false (0).

See also the original CEF documentation in cef/include/capi/cef_scheme_capi.h.

Screen information used when window rendering is disabled. This structure is passed as a parameter to CfxRenderHandler.GetScreenInfo and should be filled in by the client.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Device scale factor. Specifies the ratio between physical and logical pixels.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The screen depth in bits per pixel.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The bits per color component. This assumes that the colors are balanced equally.

See also the original CEF documentation in cef/include/internal/cef_types.h.

This can be true for black and white printers.

See also the original CEF documentation in cef/include/internal/cef_types.h.

This is set from the rcMonitor member of MONITORINFOEX, to whit: "A RECT structure that specifies the display monitor rectangle, expressed in virtual-screen coordinates. Note that if the monitor is not the primary display monitor, some of the rectangle's coordinates may be negative values." The |rect| and |availableRect| properties are used to determine the available surface for rendering popup views.

See also the original CEF documentation in cef/include/internal/cef_types.h.

This is set from the rcWork member of MONITORINFOEX, to whit: "A RECT structure that specifies the work area rectangle of the display monitor that can be used by applications, expressed in virtual-screen coordinates. Windows uses this rectangle to maximize an application on the monitor. The rest of the area in rcMonitor contains system windows such as the task bar and side bars. Note that if the monitor is not the primary display monitor, some of the rectangle's coordinates may be negative values". The |rect| and |availableRect| properties are used to determine the available surface for rendering popup views.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Callback structure used to select a client certificate for authentication.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Chooses the specified certificate for client certificate authentication. NULL value means that no client certificate should be used.

See also the original CEF documentation in cef/include/capi/cef_request_handler_capi.h.

Structure to implement to be notified of asynchronous completion via CfxCookieManager.SetCookie().

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

Method that will be called upon completion. |Success| will be true (1) if the cookie was set successfully.

See also the original CEF documentation in cef/include/capi/cef_cookie_capi.h.

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.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) to use a single process for the browser and renderer. This run mode is not officially supported by Chromium and is less stable than the multi-process default. Also configurable using the "single-process" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) to disable the sandbox for sub-processes. See cef_sandbox_win.h for requirements to enable the sandbox on Windows. Also configurable using the "no-sandbox" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The path to a separate executable that will be launched for sub-processes. If this value is empty on Windows or Linux then the main process executable will be used. If this value is empty on macOS then a helper executable must exist at "Contents/Frameworks/<app> Helper.app/Contents/MacOS/<app> Helper" in the top-level app bundle. See the comments on CfxExecuteProcess() for details. Also configurable using the "browser-subprocess-path" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The path to the CEF framework directory on macOS. If this value is empty then the framework must exist at "Contents/Frameworks/Chromium Embedded Framework.framework" in the top-level app bundle. Also configurable using the "framework-dir-path" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) to have the browser process message loop run in a separate thread. If false (0) than the CfxDoMessageLoopWork() function must be called from your application message loop. This option is only supported on Windows.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) to control browser process main (UI) thread message pump scheduling via the CfxBrowserProcessHandler.OnScheduleMessagePumpWork() callback. This option is recommended for use in combination with the CfxDoMessageLoopWork() function in cases where the CEF message loop must be integrated into an existing application message loop (see additional comments and warnings on CfxDoMessageLoopWork). Enabling this option is not recommended for most users; leave this option disabled and use either the CfxRunMessageLoop() function or multi_threaded_message_loop if possible.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) to enable windowless (off-screen) rendering support. Do not enable this value if the application does not use windowless rendering as it may reduce rendering performance on some systems.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) to disable configuration of browser process features using standard CEF and Chromium command-line arguments. Configuration can still be specified using CEF data structures or via the CfxApp.OnBeforeCommandLineProcessing() method.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The location where cache data will be stored on disk. If empty then browsers will be created in "incognito mode" where in-memory caches are used for storage and no data is persisted to disk. HTML5 databases such as localStorage will only persist across sessions if a cache path is specified. Can be overridden for individual CfxRequestContext instances via the CfxRequestContextSettings.CachePath value.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The location where user data such as spell checking dictionary files will be stored on disk. If empty then the default platform-specific user data directory will be used ("~/.cef_user_data" directory on Linux, "~/Library/Application Support/CEF/User Data" directory on Mac OS X, "Local Settings\Application Data\CEF\User Data" directory under the user profile directory on Windows).

See also the original CEF documentation in cef/include/internal/cef_types.h.

To persist session cookies (cookies without an expiry date or validity interval) by default when using the global cookie manager set this value to true (1). Session cookies are generally intended to be transient and most Web browsers do not persist them. A |cachePath| value must also be specified to enable this feature. Also configurable using the "persist-session-cookies" command-line switch. Can be overridden for individual CfxRequestContext instances via the CfxRequestContextSettings.PersistSessionCookies value.

See also the original CEF documentation in cef/include/internal/cef_types.h.

To persist user preferences as a JSON file in the cache path directory set this value to true (1). A |cachePath| value must also be specified to enable this feature. Also configurable using the "persist-user-preferences" command-line switch. Can be overridden for individual CfxRequestContext instances via the CfxRequestContextSettings.PersistUserPreferences value.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Value that will be returned as the User-Agent HTTP header. If empty the default User-Agent string will be used. Also configurable using the "user-agent" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Value that will be inserted as the product portion of the default User-Agent string. If empty the Chromium product version will be used. If |userAgent| is specified this value will be ignored. Also configurable using the "product-version" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The locale string that will be passed to WebKit. If empty the default locale of "en-US" will be used. This value is ignored on Linux where locale is determined using environment variable parsing with the precedence order: LANGUAGE, LC_ALL, LC_MESSAGES and LANG. Also configurable using the "lang" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The directory and file name to use for the debug log. If empty a default log file name and location will be used. On Windows and Linux a "debug.log" file will be written in the main executable directory. On Mac OS X a "~/Library/Logs/<app name>_debug.log" file will be written where <app name> is the name of the main app executable. Also configurable using the "log-file" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The log severity. Only messages of this severity level or higher will be logged. Also configurable using the "log-severity" command-line switch with a value of "verbose", "info", "warning", "error", "error-report" or "disable".

See also the original CEF documentation in cef/include/internal/cef_types.h.

Custom flags that will be used when initializing the V8 JavaScript engine. The consequences of using custom flags may not be well tested. Also configurable using the "js-flags" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The fully qualified path for the resources directory. If this value is empty the cef.pak and/or devtools_resources.pak files must be located in the module directory on Windows/Linux or the app bundle Resources directory on Mac OS X. Also configurable using the "resources-dir-path" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The fully qualified path for the locales directory. If this value is empty the locales directory must be located in the module directory. This value is ignored on Mac OS X where pack files are always loaded from the app bundle Resources directory. Also configurable using the "locales-dir-path" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) to disable loading of pack files for resources and locales. A resource bundle handler must be provided for the browser and render processes via CfxApp.GetResourceBundleHandler() if loading of pack files is disabled. Also configurable using the "disable-pack-loading" command- line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to a value between 1024 and 65535 to enable remote debugging on the specified port. For example, if 8080 is specified the remote debugging URL will be http://localhost:8080. CEF can be remotely debugged from any CEF or Chrome browser window. Also configurable using the "remote-debugging-port" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The number of stack trace frames to capture for uncaught exceptions. Specify a positive value to enable the CfxRenderProcessHandler:: OnUncaughtException() callback. Specify 0 (default value) and OnUncaughtException() will not be called. Also configurable using the "uncaught-exception-stack-size" command-line switch.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) to ignore errors related to invalid SSL certificates. Enabling this setting can lead to potential security vulnerabilities like "man in the middle" attacks. Applications that load content from the internet should not enable this setting. Also configurable using the "ignore-certificate-errors" command-line switch. Can be overridden for individual CfxRequestContext instances via the CfxRequestContextSettings.IgnoreCertificateErrors value.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Set to true (1) to enable date-based expiration of built in network security information (i.e. certificate transparency logs, HSTS preloading and pinning information). Enabling this option improves network security but may cause HTTPS load failures when using CEF binaries built more than 10 weeks in the past. See https://www.certificate-transparency.org/ and https://www.chromium.org/hsts for details. Also configurable using the "enable-net-security-expiration" command-line switch. Can be overridden for individual CfxRequestContext instances via the CfxRequestContextSettings.EnableNetSecurityExpiration value.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Background color used for the browser before a document is loaded and when no document color is specified. The alpha component must be either fully opaque (0xFF) or fully transparent (0x00). If the alpha component is fully opaque then the RGB components will be used as the background color. If the alpha component is fully transparent for a windowed browser then the default value of opaque white be used. If the alpha component is fully transparent for a windowless (off-screen) browser then transparent painting will be enabled.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Comma delimited ordered list of language codes without any whitespace that will be used in the "Accept-Language" HTTP header. May be overridden on a per-browser basis using the CfxBrowserSettings.AcceptLanguageList value. If both values are empty then "en-US,en" will be used. Can be overridden for individual CfxRequestContext instances via the CfxRequestContextSettings.AcceptLanguageList value.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Structure representing a size.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Structure representing SSL information.

See also the original CEF documentation in cef/include/capi/cef_ssl_info_capi.h.

Returns a bitmask containing any and all problems verifying the server certificate.

See also the original CEF documentation in cef/include/capi/cef_ssl_info_capi.h.

Returns the X.509 certificate.

See also the original CEF documentation in cef/include/capi/cef_ssl_info_capi.h.

Structure representing the SSL information for a navigation entry.

See also the original CEF documentation in cef/include/capi/cef_ssl_status_capi.h.

Returns true (1) if the status is related to a secure SSL/TLS connection.

See also the original CEF documentation in cef/include/capi/cef_ssl_status_capi.h.

Returns a bitmask containing any and all problems verifying the server certificate.

See also the original CEF documentation in cef/include/capi/cef_ssl_status_capi.h.

Returns the SSL version used for the SSL connection.

See also the original CEF documentation in cef/include/capi/cef_ssl_status_capi.h.

Returns a bitmask containing the page security content status.

See also the original CEF documentation in cef/include/capi/cef_ssl_status_capi.h.

Returns the X.509 certificate.

See also the original CEF documentation in cef/include/capi/cef_ssl_status_capi.h.

Structure used to read data from a stream. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Create a new CfxStreamReader object from a file.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Create a new CfxStreamReader object from data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Create a new CfxStreamReader object from a custom handler.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Read raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Seek to the specified offset position. |whence| may be any one of SEEK_CUR, SEEK_END or SEEK_SET. Returns zero on success and non-zero on failure.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return the current offset position.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return non-zero if at end of file.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Returns true (1) if this reader performs work like accessing the file system which may block. Used as a hint for determining the thread to access the reader from.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Structure used to write data to a stream. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Create a new CfxStreamWriter object for a file.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Create a new CfxStreamWriter object for a custom handler.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Write raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Seek to the specified offset position. |whence| may be any one of SEEK_CUR, SEEK_END or SEEK_SET. Returns zero on success and non-zero on failure.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return the current offset position.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Flush the stream.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Returns true (1) if this writer performs work like accessing the file system which may block. Used as a hint for determining the thread to access the writer from.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Implement this structure to receive string values asynchronously.

See also the original CEF documentation in cef/include/capi/cef_string_visitor_capi.h.

Method that will be executed.

See also the original CEF documentation in cef/include/capi/cef_string_visitor_capi.h.

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.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Method that will be executed on the target thread.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Structure that asynchronously executes tasks on the associated thread. It is safe to call the functions of this structure on any thread. CEF maintains multiple internal threads that are used for handling different types of tasks in different processes. The CfxThreadId definitions in cef_types.h list the common CEF threads. Task runners are also available for other CEF threads as appropriate (for example, V8 WebWorker threads).

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

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.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Returns the task runner for the specified CEF thread.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Returns true (1) if this object is pointing to the same task runner as |that| object.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Returns true (1) if this task runner belongs to the current thread.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Returns true (1) if this task runner is for the specified CEF thread.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Post a task for execution on the thread associated with this task runner. Execution will occur asynchronously.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Post a task for delayed execution on the thread associated with this task runner. Execution will occur asynchronously. Delayed tasks are not supported on V8 WebWorker threads and will be executed without the specified delay.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

A simple thread abstraction that establishes a message loop on a new thread. The consumer uses CfxTaskRunner to execute code on the thread's message loop. The thread is terminated when the CfxThread object is destroyed or stop() is called. All pending tasks queued on the thread's message loop will run to completion before the thread is terminated. cef_thread_create() can be called on any valid CEF thread in either the browser or render process. This structure should only be used for tasks that require a dedicated thread. In most cases you can post tasks to an existing CEF thread instead of creating a new one; see cef_task.h for details.

See also the original CEF documentation in cef/include/capi/cef_thread_capi.h.

Create and start a new thread. This function does not block waiting for the thread to run initialization. |displayName| is the name that will be used to identify the thread. |priority| is the thread execution priority. |messageLoopType| indicates the set of asynchronous events that the thread can process. If |stoppable| is true (1) the thread will stopped and joined on destruction or when stop() is called; otherwise, the the thread cannot be stopped and will be leaked on shutdown. On Windows the |comInitMode| value specifies how COM will be initialized for the thread. If |comInitMode| is set to COM_INIT_MODE_STA then |messageLoopType| must be set to ML_TYPE_UI.

See also the original CEF documentation in cef/include/capi/cef_thread_capi.h.

Returns the CfxTaskRunner that will execute code on this thread's message loop. This function is safe to call from any thread.

See also the original CEF documentation in cef/include/capi/cef_thread_capi.h.

Returns the platform thread ID. It will return the same value after stop() is called. This function is safe to call from any thread.

See also the original CEF documentation in cef/include/capi/cef_thread_capi.h.

Returns true (1) if the thread is currently running. This function must be called from the same thread that called cef_thread_create().

See also the original CEF documentation in cef/include/capi/cef_thread_capi.h.

Stop and join the thread. This function must be called from the same thread that called cef_thread_create(). Do not call this function if cef_thread_create() was called with a |stoppable| value of false (0).

See also the original CEF documentation in cef/include/capi/cef_thread_capi.h.

Time information. Values should always be in UTC.

See also the original CEF documentation in cef/include/internal/cef_time.h.

URL component parts.

See also the original CEF documentation in cef/include/internal/cef_types.h.

The complete URL specification.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Scheme component not including the colon (e.g., "http").

See also the original CEF documentation in cef/include/internal/cef_types.h.

User name component.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Password component.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Host component. This may be a hostname, an IPv4 address or an IPv6 literal surrounded by square brackets (e.g., "[2001:db8::1]").

See also the original CEF documentation in cef/include/internal/cef_types.h.

Port number component.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Origin contains just the scheme, host, and port from a URL. Equivalent to clearing any username and password, replacing the path with a slash, and clearing everything after that. This value will be empty for non-standard URLs.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Path component including the first slash following the host.

See also the original CEF documentation in cef/include/internal/cef_types.h.

Query string component (i.e., everything following the '?').

See also the original CEF documentation in cef/include/internal/cef_types.h.

Structure used to make a URL request. URL requests are not associated with a browser instance so no CfxClient 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.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Create a new URL request. Only GET, POST, HEAD, DELETE and PUT request functions are supported. Multiple post data elements are not supported and elements of type PDE_TYPE_FILE are only supported for requests originating from the browser process. Requests originating from the render process will receive the same handling as requests originating from Web content -- if the response contains Content-Disposition or Mime-Type header values that would not normally be rendered then the response may receive special handling inside the browser (for example, via the file download code path instead of the URL request code path). The |request| object will be marked as read-only after calling this function. In the browser process if |requestContext| is NULL the global request context will be used. In the render process |requestContext| must be NULL and the context associated with the current renderer process' browser will be used.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Returns the request object used to create this URL request. The returned object is read-only and should not be modified.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Returns the client.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Returns the request status.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Returns the request error if status is UR_CANCELED or UR_FAILED, or 0 otherwise.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Returns the response, or NULL if no response information is available. Response information will only be available after the upload has completed. The returned object is read-only and should not be modified.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Cancel the request.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Structure that should be implemented by the CfxUrlRequest client. The functions of this structure will be called on the same thread that created the request unless otherwise documented.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Notifies the client that the request has completed. Use the CfxUrlRequest.GetRequestStatus function to determine if the request was successful or not.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Notifies the client of upload progress. |Current| denotes the number of bytes sent so far and |Total| is the total size of uploading data (or -1 if chunked upload is enabled). This function will only be called if the UR_FLAG_REPORT_UPLOAD_PROGRESS flag is set on the request.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Notifies the client of download progress. |Current| denotes the number of bytes received up to the call and |Total| is the expected total size of the response (or -1 if not determined).

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Called when some part of the response is read. |Data| contains the current bytes received since the last call. This function will not be called if the UR_FLAG_NO_DOWNLOAD_DATA flag is set on the request.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Called on the IO thread when the browser needs credentials from the user. |IsProxy| indicates whether the host is a proxy server. |Host| contains the hostname and |Port| contains the port number. Return true (1) to continue the request and call CfxAuthCallback.Continue() when the authentication information is available. Return false (0) to cancel the request. This function will only be called for requests initiated from the browser process.

See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.

Structure that should be implemented to handle V8 accessor calls. Accessor identifiers are registered by calling CfxV8Value.SetValue(). The functions of this structure will be called on the thread associated with the V8 accessor.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle retrieval the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. If retrieval succeeds set |Retval| to the return value. If retrieval fails set |Exception| to the exception that will be thrown. Return true (1) if accessor retrieval was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle assignment of the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. |Value| is the new value being assigned to the accessor. If assignment fails set |Exception| to the exception that will be thrown. Return true (1) if accessor assignment was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

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 CfxV8Context.GetTaskRunner() function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the current (top) context object in the V8 context stack.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the entered (bottom) context object in the V8 context stack.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if V8 is currently inside a context.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the task runner associated with this context. V8 handles can only be accessed from the thread on which they are created. This function can be called on any render process thread.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the underlying handle is valid and it can be accessed on the current thread. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the browser for this context. This function will return an NULL reference for WebWorker contexts.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the frame for this context. This function will return an NULL reference for WebWorker contexts.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the global object for this context. The context must be entered before calling this function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Enter this context. A context must be explicitly entered before creating a V8 Object, Array, Function or Date asynchronously. exit() must be called the same number of times as enter() before releasing this context. V8 objects belong to the context in which they are created. Returns true (1) if the scope was entered successfully.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Exit this context. Call this function only after calling enter(). Returns true (1) if the scope was exited successfully.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if this object is pointing to the same handle as |that| object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Execute a string of JavaScript code in this V8 context. The |scriptUrl| parameter is the URL where the script in question can be found, if any. The |startLine| parameter is the base line number to use for error reporting. On success |retval| will be set to the return value, if any, and the function will return true (1). On failure |exception| will be set to the exception, if any, and the function will return false (0).

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Structure representing a V8 exception. The functions of this structure may be called on any render process thread.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the exception message.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the line of source code that the exception occurred within.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the resource name for the script from where the function causing the error originates.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the 1-based number of the line where the error occurred or 0 if the line number is unknown.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the index within the script of the first character where the error occurred.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the index within the script of the last character where the error occurred.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the index within the line of the first character where the error occurred.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the index within the line of the last character where the error occurred.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

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.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle execution of the function identified by |Name|. |Object| is the receiver ('this' object) of the function. |Arguments| is the list of arguments passed to the function. If execution succeeds set |Retval| to the function return value. If execution fails set |Exception| to the exception that will be thrown. Return true (1) if execution was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

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 CfxString) 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.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle retrieval of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. If the property has an associated accessor, it will be called only if you don't set |Retval|. Return true (1) if interceptor retrieval was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle retrieval of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor retrieval was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle assignment of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. This setter will always be called, even when the property has an associated accessor. Return true (1) if interceptor assignment was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle assignment of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor assignment was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

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 CfxV8Context.GetTaskRunner() function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the underlying handle is valid and it can be accessed on the current thread. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the name of the resource script that contains the function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the name of the resource script that contains the function or the sourceURL value if the script name is undefined and its source ends with a "//@ sourceURL=..." string.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the name of the function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the 1-based line number for the function call or 0 if unknown.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the 1-based column offset on the line for the function call or 0 if unknown.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the function was compiled using eval().

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the function was called as a constructor via "new".

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

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 CfxV8Context.GetTaskRunner() function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the stack trace for the currently active context. |frameLimit| is the maximum number of frames that will be captured.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the underlying handle is valid and it can be accessed on the current thread. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the number of stack frames.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the stack frame at the specified 0-based index.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

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 CfxV8Context.GetTaskRunner() function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfxV8Value object of type undefined.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfxV8Value object of type null.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfxV8Value object of type bool.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfxV8Value object of type int.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfxV8Value object of type unsigned int.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfxV8Value object of type double.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfxV8Value object of type Date. This function should only be called from within the scope of a CfxRenderProcessHandler, CfxV8Handler or CfxV8Accessor callback, or in combination with calling enter() and exit() on a stored CfxV8Context reference.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfxV8Value object of type string.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfxV8Value object of type object with optional accessor and/or interceptor. This function should only be called from within the scope of a CfxRenderProcessHandler, CfxV8Handler or CfxV8Accessor callback, or in combination with calling enter() and exit() on a stored CfxV8Context reference.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfxV8Value 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 CfxRenderProcessHandler, CfxV8Handler or CfxV8Accessor callback, or in combination with calling enter() and exit() on a stored CfxV8Context reference.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfxV8Value object of type function. This function should only be called from within the scope of a CfxRenderProcessHandler, CfxV8Handler or CfxV8Accessor callback, or in combination with calling enter() and exit() on a stored CfxV8Context reference.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the underlying handle is valid and it can be accessed on the current thread. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is undefined.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is null.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is bool.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is int.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is unsigned int.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is double.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is Date.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is string.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is array.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Return a bool value.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Return an int value.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Return an unsigned int value.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Return a double value.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Return a Date value.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Return a string value.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if this is a user created object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the last function call resulted in an exception. This attribute exists only in the scope of the current CEF value object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the exception resulting from the last function call. This attribute exists only in the scope of the current CEF value object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the user data, if any, assigned to this object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the amount of externally allocated memory registered for the object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the number of elements in the array.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the function name.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the function handler or NULL if not a CEF-created function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if this object is pointing to the same handle as |that| object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Clears the last exception and returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if this object will re-throw future exceptions. This attribute exists only in the scope of the current CEF value object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Set whether this object will re-throw future exceptions. By default exceptions are not re-thrown. If a exception is re-thrown the current context should not be accessed again until after the exception has been caught and not re-thrown. Returns true (1) on success. This attribute exists only in the scope of the current CEF value object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the object has a value with the specified identifier.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the object has a value with the specified identifier.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Deletes the value with the specified identifier and returns true (1) on success. Returns false (0) if this function is called incorrectly or an exception is thrown. For read-only and don't-delete values this function will return true (1) even though deletion failed.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Deletes the value with the specified identifier and returns true (1) on success. Returns false (0) if this function is called incorrectly, deletion fails or an exception is thrown. For read-only and don't-delete values this function will return true (1) even though deletion failed.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the value with the specified identifier on success. Returns NULL if this function is called incorrectly or an exception is thrown.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the value with the specified identifier on success. Returns NULL if this function is called incorrectly or an exception is thrown.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Associates a value with the specified identifier and returns true (1) on success. Returns false (0) if this function is called incorrectly or an exception is thrown. For read-only values this function will return true (1) even though assignment failed.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Associates a value with the specified identifier and returns true (1) on success. Returns false (0) if this function is called incorrectly or an exception is thrown. For read-only values this function will return true (1) even though assignment failed.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Registers an identifier and returns true (1) on success. Access to the identifier will be forwarded to the CfxV8Accessor instance passed to CfxV8Value.CfxV8ValueCreateObject(). Returns false (0) if this function is called incorrectly or an exception is thrown. For read-only values this function will return true (1) even though assignment failed.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Read the keys for the object's values into the specified vector. Integer- based keys will also be returned as strings.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Sets the user data for this object and returns true (1) on success. Returns false (0) if this function is called incorrectly. This function can only be called on user created objects.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Adjusts the amount of registered external memory for the object. Used to give V8 an indication of the amount of externally allocated memory that is kept alive by JavaScript objects. V8 uses this information to decide when to perform global garbage collection. Each CfxV8Value tracks the amount of external memory associated with it and automatically decreases the global total by the appropriate amount on its destruction. |changeInBytes| specifies the number of bytes to adjust by. This function returns the number of bytes associated with the object after the adjustment. This function can only be called on user created objects.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Execute the function using the current V8 context. This function should only be called from within the scope of a CfxV8Handler or CfxV8Accessor callback, or in combination with calling enter() and exit() on a stored CfxV8Context reference. |object| is the receiver ('this' object) of the function. If |object| is NULL the current context's global object will be used. |arguments| is the list of arguments that will be passed to the function. Returns the function return value on success. Returns NULL if this function is called incorrectly or an exception is thrown.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Execute the function using the specified V8 context. |object| is the receiver ('this' object) of the function. If |object| is NULL the specified context's global object will be used. |arguments| is the list of arguments that will be passed to the function. Returns the function return value on success. Returns NULL if this function is called incorrectly or an exception is thrown.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfxV8Value object of type object with accessor. This function should only be called from within the scope of a CfxRenderProcessHandler, CfxV8Handler or CfxV8Accessor callback, or in combination with calling enter() and exit() on a stored CfxV8Context reference.

Create a new CfxV8Value object of type object with interceptor. This function should only be called from within the scope of a CfxRenderProcessHandler, CfxV8Handler or CfxV8Accessor callback, or in combination with calling enter() and exit() on a stored CfxV8Context reference.

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.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Creates a new object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if the underlying data is valid. This will always be true (1) for simple types. For complex types (binary, dictionary and list) the underlying data may become invalid if owned by another object (e.g. list or dictionary) and that other object is then modified or destroyed. This value object can be re-used by calling Set*() even if the underlying data is invalid.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if the underlying data is owned by another object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if the underlying data is read-only. Some APIs may expose read-only objects.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value type.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value as type bool.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value as type int.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value as type double.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value as type string.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value as type binary. The returned reference may become invalid if the value is owned by another object or if ownership is transferred to another object in the future. To maintain a reference to the value after assigning ownership to a dictionary or list pass this object to the set_value() function instead of passing the returned reference to set_binary().

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value as type dictionary. The returned reference may become invalid if the value is owned by another object or if ownership is transferred to another object in the future. To maintain a reference to the value after assigning ownership to a dictionary or list pass this object to the set_value() function instead of passing the returned reference to set_dictionary().

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value as type list. The returned reference may become invalid if the value is owned by another object or if ownership is transferred to another object in the future. To maintain a reference to the value after assigning ownership to a dictionary or list pass this object to the set_value() function instead of passing the returned reference to set_list().

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have the same underlying data. If true (1) modifications to this object will also affect |that| object and vice-versa.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have an equivalent underlying value but are not necessarily the same object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns a copy of this object. The underlying data will also be copied.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type null. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type bool. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type int. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type double. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type string. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type binary. Returns true (1) if the value was set successfully. This object keeps a reference to |value| and ownership of the underlying data remains unchanged.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type dict. Returns true (1) if the value was set successfully. This object keeps a reference to |value| and ownership of the underlying data remains unchanged.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type list. Returns true (1) if the value was set successfully. This object keeps a reference to |value| and ownership of the underlying data remains unchanged.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

WaitableEvent is a thread synchronization tool that allows one thread to wait for another thread to finish some work. This is equivalent to using a Lock+ConditionVariable to protect a simple boolean value. However, using WaitableEvent in conjunction with a Lock to wait for a more complex state change (e.g., for an item to be added to a queue) is not recommended. In that case consider using a ConditionVariable instead of a WaitableEvent. It is safe to create and/or signal a WaitableEvent from any thread. Blocking on a WaitableEvent by calling the *wait() functions is not allowed on the browser process UI or IO threads.

See also the original CEF documentation in cef/include/capi/cef_waitable_event_capi.h.

Create a new waitable event. If |automaticReset| is true (1) then the event state is automatically reset to un-signaled after a single waiting thread has been released; otherwise, the state remains signaled until reset() is called manually. If |initiallySignaled| is true (1) then the event will start in the signaled state.

See also the original CEF documentation in cef/include/capi/cef_waitable_event_capi.h.

Returns true (1) if the event is in the signaled state, else false (0). If the event was created with |automaticReset| set to true (1) then calling this function will also cause a reset.

See also the original CEF documentation in cef/include/capi/cef_waitable_event_capi.h.

Put the event in the un-signaled state.

See also the original CEF documentation in cef/include/capi/cef_waitable_event_capi.h.

Put the event in the signaled state. This causes any thread blocked on Wait to be woken up.

See also the original CEF documentation in cef/include/capi/cef_waitable_event_capi.h.

Wait indefinitely for the event to be signaled. This function will not return until after the call to signal() has completed. This function cannot be called on the browser process UI or IO threads.

See also the original CEF documentation in cef/include/capi/cef_waitable_event_capi.h.

Wait up to |maxMs| milliseconds for the event to be signaled. Returns true (1) if the event was signaled. A return value of false (0) does not necessarily mean that |maxMs| was exceeded. This function will not return until after the call to signal() has completed. This function cannot be called on the browser process UI or IO threads.

See also the original CEF documentation in cef/include/capi/cef_waitable_event_capi.h.

Information about a specific web plugin.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Returns the plugin name (i.e. Flash).

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Returns the plugin file path (DLL/bundle/library).

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Returns the version of the plugin (may be OS-specific).

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Returns a description of the plugin from the version information.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Structure to implement for visiting web plugin information. The functions of this structure will be called on the browser process UI thread.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Method that will be called once for each plugin. |Count| is the 0-based index for the current plugin. |Total| is the total number of plugins. Return false (0) to stop visiting plugins. This function may never be called if no plugins are found.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Structure to implement for receiving unstable plugin information. The functions of this structure will be called on the browser process IO thread.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Method that will be called for the requested plugin. |Unstable| will be true (1) if the plugin has reached the crash count threshold of 3 times in 120 seconds.

See also the original CEF documentation in cef/include/capi/cef_web_plugin_capi.h.

Class representing window information.

See also the original CEF documentation in cef/include/internal/cef_types_linux.h.

Pointer for the parent window.

See also the original CEF documentation in cef/include/internal/cef_types_linux.h.

Set to true (1) to create the browser using windowless (off-screen) rendering. No window will be created for the browser and all rendering will occur via the CfxRenderHandler interface. The |parentWindow| value will be used to identify monitor info and to act as the parent window for dialogs, context menus, etc. If |parentWindow| is not provided then the main screen monitor will be used and some functionality that requires a parent window may not function correctly. In order to create windowless browsers the CfxSettings.WindowlessRenderingEnabled value must be set to true. Transparent painting is enabled by default but can be disabled by setting CfxBrowserSettings.BackgroundColor to an opaque value.

See also the original CEF documentation in cef/include/internal/cef_types_linux.h.

Pointer for the new browser window. Only used with windowed rendering.

See also the original CEF documentation in cef/include/internal/cef_types_linux.h.

Structure representing window information.

See also the original CEF documentation in cef/include/internal/cef_types_win.h.

Set to true (1) to create the browser using windowless (off-screen) rendering. No window will be created for the browser and all rendering will occur via the CfxRenderHandler interface. The |parentWindow| value will be used to identify monitor info and to act as the parent window for dialogs, context menus, etc. If |parentWindow| is not provided then the main screen monitor will be used and some functionality that requires a parent window may not function correctly. In order to create windowless browsers the CfxSettings.WindowlessRenderingEnabled value must be set to true. Transparent painting is enabled by default but can be disabled by setting CfxBrowserSettings.BackgroundColor to an opaque value.

See also the original CEF documentation in cef/include/internal/cef_types_win.h.

Handle for the new browser window. Only used with windowed rendering.

See also the original CEF documentation in cef/include/internal/cef_types_win.h.

Structure the client can implement to provide a custom stream writer. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Write raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Seek to the specified offset position. |Whence| may be any one of SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on failure.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return the current offset position.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Flush the stream.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return true (1) if this handler performs work like accessing the file system which may block. Used as a hint for determining the thread to access the handler from.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Structure representing a X.509 certificate.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Returns the subject of the X.509 certificate. For HTTPS server certificates this represents the web server. The common name of the subject should match the host name of the web server.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Returns the issuer of the X.509 certificate.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Returns the DER encoded serial number for the X.509 certificate. The value possibly includes a leading 00 byte.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Returns the date before which the X.509 certificate is invalid. CfxTime.GetTimeT() will return 0 if no date was specified.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Returns the date after which the X.509 certificate is invalid. CfxTime.GetTimeT() will return 0 if no date was specified.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Returns the DER encoded data for the X.509 certificate.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Returns the PEM encoded data for the X.509 certificate.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Returns the number of certificates in the issuer chain. If 0, the certificate is self-signed.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Returns the DER encoded data for the certificate issuer chain. If we failed to encode a certificate in the chain it is still present in the array but is an NULL string.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Returns the PEM encoded data for the certificate issuer chain. If we failed to encode a certificate in the chain it is still present in the array but is an NULL string.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Structure representing the issuer or subject field of an X.509 certificate.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Returns a name that can be used to represent the issuer. It tries in this order: Common Name (CN), Organization Name (O) and Organizational Unit Name (OU) and returns the first non-NULL one found.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Returns the common name.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Returns the locality name.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Returns the state or province name.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Returns the country name.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Retrieve the list of street addresses.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Retrieve the list of organization names.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Retrieve the list of organization unit names.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Retrieve the list of domain components.

See also the original CEF documentation in cef/include/capi/cef_x509_certificate_capi.h.

Structure that supports the reading of XML data via the libxml streaming API. The functions of this structure should only be called on the thread that creates the object.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Create a new CfxXmlReader object. The returned object's functions can only be called from the thread that created the object.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns true (1) if an error has been reported by the XML parser.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the node type.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the node depth. Depth starts at 0 for the root node.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the local name. See http://www.w3.org/TR/REC-xml-names/#NT- LocalPart for additional details.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the namespace prefix. See http://www.w3.org/TR/REC-xml-names/ for additional details.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the qualified name, equal to (Prefix:)LocalName. See http://www.w3.org/TR/REC-xml-names/#ns-qualnames for additional details.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the URI defining the namespace associated with the node. See http://www.w3.org/TR/REC-xml-names/ for additional details.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the base URI of the node. See http://www.w3.org/TR/xmlbase/ for additional details.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the xml:lang scope within which the node resides. See http://www.w3.org/TR/REC-xml/#sec-lang-tag for additional details.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns true (1) if the node represents an NULL element. <a/> is considered NULL but <a></a> is not.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns true (1) if the node has a text value.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the text value.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns true (1) if the node has attributes.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the number of attributes.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns an XML representation of the current node's children.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns an XML representation of the current node including its children.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the line number for the current node.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Moves the cursor to the next node in the document. This function must be called at least once to set the current cursor position. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Close the document. This should be called directly to ensure that cleanup occurs on the correct thread.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the error string.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the value of the attribute at the specified 0-based index.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the value of the attribute with the specified qualified name.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the value of the attribute with the specified local name and namespace URI.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Moves the cursor to the attribute at the specified 0-based index. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Moves the cursor to the attribute with the specified qualified name. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Moves the cursor to the attribute with the specified local name and namespace URI. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Moves the cursor to the first attribute in the current element. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Moves the cursor to the next attribute in the current element. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Moves the cursor back to the carrying element. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Structure that supports the reading of zip archives via the zlib unzip API. The functions of this structure should only be called on the thread that creates the object.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Create a new CfxZipReader object. The returned object's functions can only be called from the thread that created the object.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Returns the name of the file.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Returns the uncompressed size of the file.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Returns the last modified timestamp for the file.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Moves the cursor to the first file in the archive. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Moves the cursor to the next file in the archive. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Moves the cursor to the specified file in the archive. If |caseSensitive| is true (1) then the search will be case sensitive. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Closes the archive. This should be called directly to ensure that cleanup occurs on the correct thread.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Opens the file for reading of uncompressed data. A read password may optionally be specified.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Closes the file.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Read uncompressed file contents into the specified buffer. Returns < 0 if an error occurred, 0 if at the end of file, or the number of bytes read.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Returns the current offset in the uncompressed file contents.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Returns true (1) if at end of the file contents.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Read uncompressed file contents into the specified buffer. Returns 0 if at the end of file, or the number of bytes read. Throws an exception if an error occurred.

Implement this structure to provide handler implementations. Methods will be called by the process and/or thread indicated.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Provides an opportunity to view and/or modify command-line arguments before processing by CEF and Chromium. The |ProcessType| value will be NULL for the browser process. Do not keep a reference to the CfrCommandLine object passed to this function. The CfrSettings.CommandLineArgsDisabled value can be used to start with an NULL command-line object. Any values specified in CfrSettings that equate to command-line arguments will be set before this function is called. Be cautious when using this function to modify command-line arguments for non-browser processes as this may result in undefined behavior including crashes.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Provides an opportunity to register custom schemes. Do not keep a reference to the |Registrar| object. This function is called on the main thread for each process and the registered schemes should be the same across all processes.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Return the handler for resource bundle events. If CfrSettings.PackLoadingDisabled is true (1) a handler must be returned. If no handler is returned resources will be loaded from pack files. This function is called by the browser and render processes on multiple threads.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Return the handler for functionality specific to the render process. This function is called on the render process main thread.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Provides an opportunity to view and/or modify command-line arguments before processing by CEF and Chromium. The |ProcessType| value will be NULL for the browser process. Do not keep a reference to the CfrCommandLine object passed to this function. The CfrSettings.CommandLineArgsDisabled value can be used to start with an NULL command-line object. Any values specified in CfrSettings that equate to command-line arguments will be set before this function is called. Be cautious when using this function to modify command-line arguments for non-browser processes as this may result in undefined behavior including crashes.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Provides an opportunity to view and/or modify command-line arguments before processing by CEF and Chromium. The |ProcessType| value will be NULL for the browser process. Do not keep a reference to the CfrCommandLine object passed to this function. The CfrSettings.CommandLineArgsDisabled value can be used to start with an NULL command-line object. Any values specified in CfrSettings that equate to command-line arguments will be set before this function is called. Be cautious when using this function to modify command-line arguments for non-browser processes as this may result in undefined behavior including crashes.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Get the ProcessType parameter for the render process callback.

Get the CommandLine parameter for the render process callback.

Provides an opportunity to register custom schemes. Do not keep a reference to the |Registrar| object. This function is called on the main thread for each process and the registered schemes should be the same across all processes.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Provides an opportunity to register custom schemes. Do not keep a reference to the |Registrar| object. This function is called on the main thread for each process and the registered schemes should be the same across all processes.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Get the Registrar parameter for the render process callback.

Return the handler for resource bundle events. If CfrSettings.PackLoadingDisabled is true (1) a handler must be returned. If no handler is returned resources will be loaded from pack files. This function is called by the browser and render processes on multiple threads.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Return the handler for resource bundle events. If CfrSettings.PackLoadingDisabled is true (1) a handler must be returned. If no handler is returned resources will be loaded from pack files. This function is called by the browser and render processes on multiple threads.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the handler for functionality specific to the render process. This function is called on the render process main thread.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Return the handler for functionality specific to the render process. This function is called on the render process main thread.

See also the original CEF documentation in cef/include/capi/cef_app_capi.h.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Method executed for visiting the DOM. The document object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Method executed for visiting the DOM. The document object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Get the Document parameter for the render process callback.

Called when the loading state has changed. This callback will be executed twice -- once when loading is initiated either programmatically or by user action, and once when loading is terminated due to completion, cancellation of failure. It will be called before any calls to OnLoadStart and after all calls to OnLoadError and/or OnLoadEnd.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called when the loading state has changed. This callback will be executed twice -- once when loading is initiated either programmatically or by user action, and once when loading is terminated due to completion, cancellation of failure. It will be called before any calls to OnLoadStart and after all calls to OnLoadError and/or OnLoadEnd.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Get the Browser parameter for the render process callback.

Get the IsLoading parameter for the render process callback.

Get the CanGoBack parameter for the render process callback.

Get the CanGoForward parameter for the render process callback.

Called after a navigation has been committed and before the browser begins loading contents in the frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. |TransitionType| provides information about the source of the navigation and an accurate value is only available in the browser process. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will not be called for same page navigations (fragments, history state, etc.) or for navigations that fail or are canceled before commit. For notification of overall browser load status use OnLoadingStateChange instead.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called after a navigation has been committed and before the browser begins loading contents in the frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. |TransitionType| provides information about the source of the navigation and an accurate value is only available in the browser process. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will not be called for same page navigations (fragments, history state, etc.) or for navigations that fail or are canceled before commit. For notification of overall browser load status use OnLoadingStateChange instead.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Get the Browser parameter for the render process callback.

Get the Frame parameter for the render process callback.

Get the TransitionType parameter for the render process callback.

Called when the browser is done loading a frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will not be called for same page navigations (fragments, history state, etc.) or for navigations that fail or are canceled before commit. For notification of overall browser load status use OnLoadingStateChange instead.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called when the browser is done loading a frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will not be called for same page navigations (fragments, history state, etc.) or for navigations that fail or are canceled before commit. For notification of overall browser load status use OnLoadingStateChange instead.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Get the Browser parameter for the render process callback.

Get the Frame parameter for the render process callback.

Get the HttpStatusCode parameter for the render process callback.

Called when a navigation fails or is canceled. This function may be called by itself if before commit or in combination with OnLoadStart/OnLoadEnd if after commit. |ErrorCode| is the error code number, |ErrorText| is the error text and |FailedUrl| is the URL that failed to load. See net\base\net_error_list.h for complete descriptions of the error codes.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called when a navigation fails or is canceled. This function may be called by itself if before commit or in combination with OnLoadStart/OnLoadEnd if after commit. |ErrorCode| is the error code number, |ErrorText| is the error text and |FailedUrl| is the URL that failed to load. See net\base\net_error_list.h for complete descriptions of the error codes.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Get the Browser parameter for the render process callback.

Get the Frame parameter for the render process callback.

Get the ErrorCode parameter for the render process callback.

Get the ErrorText parameter for the render process callback.

Get the FailedUrl parameter for the render process callback.

Read raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Read raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Get the Ptr parameter for the render process callback.

Get the Size parameter for the render process callback.

Get the N parameter for the render process callback.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Seek to the specified offset position. |Whence| may be any one of SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on failure.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Seek to the specified offset position. |Whence| may be any one of SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on failure.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Get the Offset parameter for the render process callback.

Get the Whence parameter for the render process callback.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return the current offset position.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return the current offset position.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return non-zero if at end of file.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return non-zero if at end of file.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Return true (1) if this handler performs work like accessing the file system which may block. Used as a hint for determining the thread to access the handler from.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return true (1) if this handler performs work like accessing the file system which may block. Used as a hint for determining the thread to access the handler from.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called after the render process main thread has been created. |ExtraInfo| is a read-only value originating from CfrBrowserProcessHandler.OnRenderProcessThreadCreated(). Do not keep a reference to |ExtraInfo| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called after the render process main thread has been created. |ExtraInfo| is a read-only value originating from CfrBrowserProcessHandler.OnRenderProcessThreadCreated(). Do not keep a reference to |ExtraInfo| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the ExtraInfo parameter for the render process callback.

Called after a browser has been created. When browsing cross-origin a new browser will be created before the old browser with the same identifier is destroyed.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called after a browser has been created. When browsing cross-origin a new browser will be created before the old browser with the same identifier is destroyed.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the Browser parameter for the render process callback.

Called before a browser is destroyed.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called before a browser is destroyed.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the Browser parameter for the render process callback.

Return the handler for browser load status events.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Return the handler for browser load status events.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called before browser navigation. Return true (1) to cancel the navigation or false (0) to allow the navigation to proceed. The |Request| object cannot be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called before browser navigation. Return true (1) to cancel the navigation or false (0) to allow the navigation to proceed. The |Request| object cannot be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the Browser parameter for the render process callback.

Get the Frame parameter for the render process callback.

Get the Request parameter for the render process callback.

Get the NavigationType parameter for the render process callback.

Get the IsRedirect parameter for the render process callback.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called immediately after the V8 context for a frame has been created. To retrieve the JavaScript 'window' object use the CfrV8Context.GetGlobal() function. V8 handles can only be accessed from the thread on which they are created. A task runner for posting tasks on the associated thread can be retrieved via the CfrV8Context.GetTaskRunner() function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called immediately after the V8 context for a frame has been created. To retrieve the JavaScript 'window' object use the CfrV8Context.GetGlobal() function. V8 handles can only be accessed from the thread on which they are created. A task runner for posting tasks on the associated thread can be retrieved via the CfrV8Context.GetTaskRunner() function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the Browser parameter for the render process callback.

Get the Frame parameter for the render process callback.

Get the Context parameter for the render process callback.

Called immediately before the V8 context for a frame is released. No references to the context should be kept after this function is called.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called immediately before the V8 context for a frame is released. No references to the context should be kept after this function is called.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the Browser parameter for the render process callback.

Get the Frame parameter for the render process callback.

Get the Context parameter for the render process callback.

Called for global uncaught exceptions in a frame. Execution of this callback is disabled by default. To enable set CfrSettings.UncaughtExceptionStackSize > 0.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called for global uncaught exceptions in a frame. Execution of this callback is disabled by default. To enable set CfrSettings.UncaughtExceptionStackSize > 0.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the Browser parameter for the render process callback.

Get the Frame parameter for the render process callback.

Get the Context parameter for the render process callback.

Get the Exception parameter for the render process callback.

Get the StackTrace parameter for the render process callback.

Called when a new node in the the browser gets focus. The |Node| value may be NULL if no specific node has gained focus. The node object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called when a new node in the the browser gets focus. The |Node| value may be NULL if no specific node has gained focus. The node object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the Browser parameter for the render process callback.

Get the Frame parameter for the render process callback.

Get the Node parameter for the render process callback.

Called when a new message is received from a different process. Return true (1) if the message was handled or false (0) otherwise. Do not keep a reference to or attempt to access the message outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called when a new message is received from a different process. Return true (1) if the message was handled or false (0) otherwise. Do not keep a reference to or attempt to access the message outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Get the Browser parameter for the render process callback.

Get the SourceProcess parameter for the render process callback.

Get the Message parameter for the render process callback.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called to retrieve a localized translation for the specified |StringId|. To provide the translation set |String| to the translation string and return true (1). To use the default translation return false (0). Include cef_pack_strings.h for a listing of valid string ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Called to retrieve a localized translation for the specified |StringId|. To provide the translation set |String| to the translation string and return true (1). To use the default translation return false (0). Include cef_pack_strings.h for a listing of valid string ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Get the StringId parameter for the render process callback.

Set the String out parameter for the render process callback.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called to retrieve data for the specified scale independent |ResourceId|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Called to retrieve data for the specified scale independent |ResourceId|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Get the ResourceId parameter for the render process callback.

Set the Data out parameter for the render process callback.

Set the DataSize out parameter for the render process callback.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Called to retrieve data for the specified |ResourceId| nearest the scale factor |ScaleFactor|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Called to retrieve data for the specified |ResourceId| nearest the scale factor |ScaleFactor|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Get the ResourceId parameter for the render process callback.

Get the ScaleFactor parameter for the render process callback.

Set the Data out parameter for the render process callback.

Set the DataSize out parameter for the render process callback.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Method that will be executed.

See also the original CEF documentation in cef/include/capi/cef_string_visitor_capi.h.

Method that will be executed.

See also the original CEF documentation in cef/include/capi/cef_string_visitor_capi.h.

Get the String parameter for the render process callback.

Handle retrieval the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. If retrieval succeeds set |Retval| to the return value. If retrieval fails set |Exception| to the exception that will be thrown. Return true (1) if accessor retrieval was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle retrieval the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. If retrieval succeeds set |Retval| to the return value. If retrieval fails set |Exception| to the exception that will be thrown. Return true (1) if accessor retrieval was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Get the Name parameter for the render process callback.

Get the Object parameter for the render process callback.

Set the Retval out parameter for the render process callback.

Set the Exception out parameter for the render process callback.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Handle assignment of the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. |Value| is the new value being assigned to the accessor. If assignment fails set |Exception| to the exception that will be thrown. Return true (1) if accessor assignment was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle assignment of the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. |Value| is the new value being assigned to the accessor. If assignment fails set |Exception| to the exception that will be thrown. Return true (1) if accessor assignment was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Get the Name parameter for the render process callback.

Get the Object parameter for the render process callback.

Get the Value parameter for the render process callback.

Set the Exception out parameter for the render process callback.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Handle execution of the function identified by |Name|. |Object| is the receiver ('this' object) of the function. |Arguments| is the list of arguments passed to the function. If execution succeeds set |Retval| to the function return value. If execution fails set |Exception| to the exception that will be thrown. Return true (1) if execution was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle execution of the function identified by |Name|. |Object| is the receiver ('this' object) of the function. |Arguments| is the list of arguments passed to the function. If execution succeeds set |Retval| to the function return value. If execution fails set |Exception| to the exception that will be thrown. Return true (1) if execution was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Get the Name parameter for the render process callback.

Get the Object parameter for the render process callback.

Get the Arguments parameter for the render process callback.

Set the Exception out parameter for the render process callback.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Handle retrieval of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. If the property has an associated accessor, it will be called only if you don't set |Retval|. Return true (1) if interceptor retrieval was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle retrieval of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. If the property has an associated accessor, it will be called only if you don't set |Retval|. Return true (1) if interceptor retrieval was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Get the Name parameter for the render process callback.

Get the Object parameter for the render process callback.

Set the Retval out parameter for the render process callback.

Set the Exception out parameter for the render process callback.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Handle retrieval of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor retrieval was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle retrieval of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor retrieval was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Get the Index parameter for the render process callback.

Get the Object parameter for the render process callback.

Set the Retval out parameter for the render process callback.

Set the Exception out parameter for the render process callback.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Handle assignment of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. This setter will always be called, even when the property has an associated accessor. Return true (1) if interceptor assignment was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle assignment of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. This setter will always be called, even when the property has an associated accessor. Return true (1) if interceptor assignment was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Get the Name parameter for the render process callback.

Get the Object parameter for the render process callback.

Get the Value parameter for the render process callback.

Set the Exception out parameter for the render process callback.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Handle assignment of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor assignment was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle assignment of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor assignment was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Get the Index parameter for the render process callback.

Get the Object parameter for the render process callback.

Get the Value parameter for the render process callback.

Set the Exception out parameter for the render process callback.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Write raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Write raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Get the Ptr parameter for the render process callback.

Get the Size parameter for the render process callback.

Get the N parameter for the render process callback.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Flush the stream.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Flush the stream.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Set the return value for the render process callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.

Structure representing a binary value. Can be used on any process and thread.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Creates a new object that is not owned by any other object. The specified |data| will be copied.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object is valid. This object may become invalid if the underlying data is owned by another object (e.g. list or dictionary) and that other object is then modified or destroyed. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object is currently owned by another object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the data size.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have the same underlying data.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have an equivalent underlying value but are not necessarily the same object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns a copy of this object. The data in this object will also be copied.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Read up to |bufferSize| number of bytes into |buffer|. Reading begins at the specified byte |dataOffset|. Returns the number of bytes read.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Creates a new object that is not owned by any other object. The specified |data| will be copied.

Structure used to represent a 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.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns true (1) if the browser can navigate backwards.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns true (1) if the browser can navigate forwards.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns true (1) if the browser is currently loading.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the globally unique identifier for this browser. This value is also used as the tabId for extension APIs.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns true (1) if the window is a popup window.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns true (1) if a document has been loaded in the browser.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the main (top-level) frame for the browser window.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the focused frame for the browser window.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the number of frames that currently exist.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the identifiers of all existing frames.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Navigate backwards.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Navigate forwards.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Reload the current page.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Reload the current page ignoring any cached data.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Stop loading the page.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns true (1) if this object is pointing to the same handle as |that| object.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the frame with the specified identifier, or NULL if not found.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the frame with the specified name, or NULL if not found.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Returns the names of all existing frames.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

Send a message to the specified |targetProcess|. Returns true (1) if the message was sent successfully.

See also the original CEF documentation in cef/include/capi/cef_browser_capi.h.

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 are considered case-insensitive. This structure can be used before cef_initialize() is called.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Create a new CfrCommandLine instance.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns the singleton global CfrCommandLine object. The returned object will be read-only.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns true (1) if this object is valid. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns true (1) if the values of this object are read-only. Some APIs may expose read-only objects.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Constructs and returns the represented command line string. Use this function cautiously because quoting behavior is unclear.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Get the program part of the command line string (the first item). Set the program part of the command line string (the first item).

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns true (1) if the command line has switches.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

True if there are remaining command line arguments.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns a writable copy of this object.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Initialize the command line with the specified |argc| and |argv| values. The first argument must be the name of the program. This function is only supported on non-Windows platforms.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Initialize the command line with the string returned by calling GetCommandLineW(). This function is only supported on Windows.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Reset the command-line switches and arguments but leave the program component unchanged.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Retrieve the original command line string as a vector of strings. The argv array: { program, [(--|-|/)switch[=value]]*, [--], [argument]* }

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns true (1) if the command line contains the given switch.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns the value associated with the given switch. If the switch has no value or isn't present this function returns the NULL string.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Returns the map of switch names and values. If a switch has no value an NULL string is returned.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Add a switch to the end of the command line. If the switch has no value pass an NULL value string.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Add a switch with the specified value to the end of the command line.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Get the remaining command line arguments.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Add an argument to the end of the command line.

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Insert a command before the current command. Common for debuggers, like "valgrind" or "gdb --args".

See also the original CEF documentation in cef/include/capi/cef_command_line_capi.h.

Structure representing a dictionary value. Can be used on any process and thread.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Creates a new object that is not owned by any other object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object is valid. This object may become invalid if the underlying data is owned by another object (e.g. list or dictionary) and that other object is then modified or destroyed. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object is currently owned by another object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if the values of this object are read-only. Some APIs may expose read-only objects.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the number of values.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have the same underlying data. If true (1) modifications to this object will also affect |that| object and vice-versa.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have an equivalent underlying value but are not necessarily the same object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns a writable copy of this object. If |excludeNullChildren| is true (1) any NULL dictionaries or lists will be excluded from the copy.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Removes all values. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if the current dictionary has a value for the given key.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Reads all keys for this dictionary into the specified vector.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Removes the value at the specified key. Returns true (1) is the value was removed successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value type for the specified key.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key. For simple types the returned value will copy existing data and modifications to the value will not modify this object. For complex types (binary, dictionary and list) the returned value will reference existing data and modifications to the value will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key as type bool.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key as type int.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key as type double.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key as type string.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key as type binary. The returned value will reference existing data.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key as type dictionary. The returned value will reference existing data and modifications to the value will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified key as type list. The returned value will reference existing data and modifications to the value will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key. Returns true (1) if the value was set successfully. If |value| represents simple data then the underlying data will be copied and modifications to |value| will not modify this object. If |value| represents complex data (binary, dictionary or list) then the underlying data will be referenced and modifications to |value| will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type null. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type bool. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type int. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type double. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type string. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type binary. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type dict. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified key as type list. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Structure used to represent a DOM document. The functions of this structure should only be called on the render process main thread thread.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the document type.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the root document node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the BODY node of an HTML document.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the HEAD node of an HTML document.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the title of an HTML document.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the node that currently has keyboard focus.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if a portion of the document is selected.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the selection offset within the start node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the selection offset within the end node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the contents of this selection as markup.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the contents of this selection as text.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the base URL for the document.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the document element with the specified ID value.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns a complete URL based on the document base URL and the specified partial URL.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Structure used to represent a DOM node. The functions of this structure should only be called on the render process main thread.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the type for this node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this is a text node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this is an element node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this is an editable node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this is a form control element node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the type of this form control element node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the name of this node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the value of this node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the contents of this node as markup.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the document associated with this node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the parent node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the previous sibling node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the next sibling node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this node has child nodes.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Return the first child node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the last child node.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the tag name of this element.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this element has attributes.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the inner text of the element.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the bounds of the element.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this object is pointing to the same handle as |that| object.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Set the value of this node. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns true (1) if this element has an attribute named |attrName|.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns the element attribute named |attrName|.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Returns a map of all element attributes.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Set the value for the element attribute named |attrName|. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Structure to implement for visiting the DOM. The functions of this structure will be called on the render process main thread.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

Method executed for visiting the DOM. The document object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.

See also the original CEF documentation in cef/include/capi/cef_dom_capi.h.

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.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

True if this object is currently attached to a valid frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Returns true (1) if this is the main (top-level) frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Returns true (1) if this is the focused frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Returns the name for this frame. If the frame has an assigned name (for example, set via the iframe "name" attribute) then that value will be returned. Otherwise a unique name will be constructed based on the frame parent hierarchy. The main (top-level) frame will always have an NULL name value.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Returns the globally unique identifier for this frame or < 0 if the underlying frame does not yet exist.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Returns the parent of this frame or NULL if this is the main (top-level) frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Returns the URL currently loaded in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Returns the browser that this frame belongs to.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Get the V8 context associated with the frame. This function can only be called from the render process.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute undo in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute redo in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute cut in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute copy in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute paste in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute delete in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute select all in this frame.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Retrieve this frame's HTML source as a string sent to the specified visitor.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Retrieve this frame's display text as a string sent to the specified visitor.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Load the request represented by the |request| object.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Load the specified |url|.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Load the contents of |stringVal| with the specified dummy |url|. |url| should have a standard scheme (for example, http scheme) or behaviors like link clicks and web security restrictions may not behave as expected.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Execute a string of JavaScript code in this frame. The |scriptUrl| parameter is the URL where the script in question can be found, if any. The renderer may request this URL to show the developer the source of the error. The |startLine| parameter is the base line number to use for error reporting.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Visit the DOM document. This function can only be called from the render process.

See also the original CEF documentation in cef/include/capi/cef_frame_capi.h.

Structure representing a list value. Can be used on any process and thread.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Creates a new object that is not owned by any other object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object is valid. This object may become invalid if the underlying data is owned by another object (e.g. list or dictionary) and that other object is then modified or destroyed. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object is currently owned by another object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if the values of this object are read-only. Some APIs may expose read-only objects.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the number of values.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have the same underlying data. If true (1) modifications to this object will also affect |that| object and vice-versa.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have an equivalent underlying value but are not necessarily the same object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns a writable copy of this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the number of values. If the number of values is expanded all new value slots will default to type null. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Removes all values. Returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Removes the value at the specified index.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value type at the specified index.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index. For simple types the returned value will copy existing data and modifications to the value will not modify this object. For complex types (binary, dictionary and list) the returned value will reference existing data and modifications to the value will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index as type bool.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index as type int.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index as type double.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index as type string.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index as type binary. The returned value will reference existing data.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index as type dictionary. The returned value will reference existing data and modifications to the value will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the value at the specified index as type list. The returned value will reference existing data and modifications to the value will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index. Returns true (1) if the value was set successfully. If |value| represents simple data then the underlying data will be copied and modifications to |value| will not modify this object. If |value| represents complex data (binary, dictionary or list) then the underlying data will be referenced and modifications to |value| will modify this object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type null. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type bool. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type int. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type double. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type string. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type binary. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type dict. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the value at the specified index as type list. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

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

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called when the loading state has changed. This callback will be executed twice -- once when loading is initiated either programmatically or by user action, and once when loading is terminated due to completion, cancellation of failure. It will be called before any calls to OnLoadStart and after all calls to OnLoadError and/or OnLoadEnd.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called after a navigation has been committed and before the browser begins loading contents in the frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. |TransitionType| provides information about the source of the navigation and an accurate value is only available in the browser process. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will not be called for same page navigations (fragments, history state, etc.) or for navigations that fail or are canceled before commit. For notification of overall browser load status use OnLoadingStateChange instead.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called when the browser is done loading a frame. The |Frame| value will never be NULL -- call the is_main() function to check if this frame is the main frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This function will not be called for same page navigations (fragments, history state, etc.) or for navigations that fail or are canceled before commit. For notification of overall browser load status use OnLoadingStateChange instead.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Called when a navigation fails or is canceled. This function may be called by itself if before commit or in combination with OnLoadStart/OnLoadEnd if after commit. |ErrorCode| is the error code number, |ErrorText| is the error text and |FailedUrl| is the URL that failed to load. See net\base\net_error_list.h for complete descriptions of the error codes.

See also the original CEF documentation in cef/include/capi/cef_load_handler_capi.h.

Structure used to represent post data for a web request. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Create a new CfrPostData object.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Returns true (1) if this object is read-only.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Returns true (1) if the underlying POST data includes elements that are not represented by this CfrPostData object (for example, multi-part file upload data). Modifying CfrPostData objects with excluded elements may result in the request failing.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Returns the number of existing post data elements.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Retrieve the post data elements.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Remove the specified post data element. Returns true (1) if the removal succeeds.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Add the specified post data element. Returns true (1) if the add succeeds.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Remove all existing post data elements.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Structure used to represent a single element in the request post data. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Create a new CfrPostDataElement object.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Returns true (1) if this object is read-only.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Return the type of this post data element.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Return the file name.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Return the number of bytes.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Remove all contents from the post data element.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

The post data element will represent a file.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

The post data element will represent bytes. The bytes passed in will be copied.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Read up to |size| bytes into |bytes| and return the number of bytes actually read.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Structure representing a message. Can be used on any process and thread.

See also the original CEF documentation in cef/include/capi/cef_process_message_capi.h.

Create a new CfrProcessMessage object with the specified name.

See also the original CEF documentation in cef/include/capi/cef_process_message_capi.h.

Returns true (1) if this object is valid. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_process_message_capi.h.

Returns true (1) if the values of this object are read-only. Some APIs may expose read-only objects.

See also the original CEF documentation in cef/include/capi/cef_process_message_capi.h.

Returns the message name.

See also the original CEF documentation in cef/include/capi/cef_process_message_capi.h.

Returns the list of arguments.

See also the original CEF documentation in cef/include/capi/cef_process_message_capi.h.

Returns a writable copy of this object.

See also the original CEF documentation in cef/include/capi/cef_process_message_capi.h.

Structure the client can implement to provide a custom stream reader. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Read raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Seek to the specified offset position. |Whence| may be any one of SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on failure.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return the current offset position.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return non-zero if at end of file.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return true (1) if this handler performs work like accessing the file system which may block. Used as a hint for determining the thread to access the handler from.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Structure representing a rectangle.

See also the original CEF documentation in cef/include/internal/cef_types.h.

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.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called after the render process main thread has been created. |ExtraInfo| is a read-only value originating from CfrBrowserProcessHandler.OnRenderProcessThreadCreated(). Do not keep a reference to |ExtraInfo| outside of this function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called after WebKit has been initialized.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called after a browser has been created. When browsing cross-origin a new browser will be created before the old browser with the same identifier is destroyed.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called before a browser is destroyed.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Return the handler for browser load status events.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called before browser navigation. Return true (1) to cancel the navigation or false (0) to allow the navigation to proceed. The |Request| object cannot be modified in this callback.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called immediately after the V8 context for a frame has been created. To retrieve the JavaScript 'window' object use the CfrV8Context.GetGlobal() function. V8 handles can only be accessed from the thread on which they are created. A task runner for posting tasks on the associated thread can be retrieved via the CfrV8Context.GetTaskRunner() function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called immediately before the V8 context for a frame is released. No references to the context should be kept after this function is called.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called for global uncaught exceptions in a frame. Execution of this callback is disabled by default. To enable set CfrSettings.UncaughtExceptionStackSize > 0.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called when a new node in the the browser gets focus. The |Node| value may be NULL if no specific node has gained focus. The node object passed to this function represents a snapshot of the DOM at the time this function is executed. DOM objects are only valid for the scope of this function. Do not keep references to or attempt to access any DOM objects outside the scope of this function.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Called when a new message is received from a different process. Return true (1) if the message was handled or false (0) otherwise. Do not keep a reference to or attempt to access the message outside of this callback.

See also the original CEF documentation in cef/include/capi/cef_render_process_handler_capi.h.

Structure used to represent a web request. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Create a new CfrRequest object.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Returns true (1) if this object is read-only.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the fully qualified URL. Set the fully qualified URL.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the request function type. The value will default to POST if post data is provided and GET otherwise. Set the request function type.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the referrer URL.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the referrer policy.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the post data. Set the post data.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the flags used in combination with CfrUrlRequest. See CfrUrlRequestFlags for supported values. Set the flags used in combination with CfrUrlRequest. See CfrUrlRequestFlags for supported values.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Set the URL to the first party for cookies used in combination with CfrUrlRequest. Get the URL to the first party for cookies used in combination with CfrUrlRequest.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the resource type for this request. Only available in the browser process.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the transition type for this request. Only available in the browser process and only applies to requests that represent a main frame or sub- frame navigation.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Returns the globally unique identifier for this request or 0 if not specified. Can be used by CfrRequestHandler implementations in the browser process to track a single request across multiple callbacks.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Set the referrer URL and policy. If non-NULL the referrer URL must be fully qualified with an HTTP or HTTPS scheme component. Any username, password or ref component will be removed.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Get the header values. Will not include the Referer value if any.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Set the header values. If a Referer value exists in the header map it will be removed and ignored.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Set all values at one time.

See also the original CEF documentation in cef/include/capi/cef_request_capi.h.

Structure used for retrieving resources from the resource bundle (*.pak) files loaded by CEF during startup or via the CfrResourceBundleHandler returned from CfrApp.GetResourceBundleHandler. See CfrSettings for additional options related to resource bundle loading. The functions of this structure may be called on any thread unless otherwise indicated.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_capi.h.

Returns the global resource bundle instance.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_capi.h.

Returns the localized string for the specified |stringId| or an NULL string if the value is not found. Include cef_pack_strings.h for a listing of valid string ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_capi.h.

Retrieves the contents of the specified scale independent |resourceId|. If the value is found then |data| and |dataSize| will be populated and this function will return true (1). If the value is not found then this function will return false (0). The returned |data| pointer will remain resident in memory and should not be freed. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_capi.h.

Retrieves the contents of the specified |resourceId| nearest the scale factor |scaleFactor|. Use a |scaleFactor| value of SCALE_FACTOR_NONE for scale independent resources or call GetDataResource instead. If the value is found then |data| and |dataSize| will be populated and this function will return true (1). If the value is not found then this function will return false (0). The returned |data| pointer will remain resident in memory and should not be freed. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_capi.h.

Structure used to implement a custom resource bundle structure. See CfrSettings for additional options related to resource bundle loading. The functions of this structure may be called on multiple threads.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Called to retrieve a localized translation for the specified |StringId|. To provide the translation set |String| to the translation string and return true (1). To use the default translation return false (0). Include cef_pack_strings.h for a listing of valid string ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Called to retrieve data for the specified scale independent |ResourceId|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Called to retrieve data for the specified |ResourceId| nearest the scale factor |ScaleFactor|. To provide the resource data set |Data| and |DataSize| to the data pointer and size respectively and return true (1). To use the default resource data return false (0). The resource data will not be copied and must remain resident in memory. Include cef_pack_resources.h for a listing of valid resource ID values.

See also the original CEF documentation in cef/include/capi/cef_resource_bundle_handler_capi.h.

Structure used to represent a web response. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Create a new CfrResponse object.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Returns true (1) if this object is read-only.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Get the response error code. Returns ERR_NONE if there was no error. Set the response error code. This can be used by custom scheme handlers to return errors during initial request processing.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Get the response status code. Set the response status code.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Get the response status text. Set the response status text.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Get the response mime type. Set the response mime type.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Get the value for the specified response header field.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Get all response header fields.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Set all response header fields.

See also the original CEF documentation in cef/include/capi/cef_response_capi.h.

Collection of global static CEF functions acessible in the render process. A thread must be in a remote context in order to access these function.

Crash reporting is configured using an INI-style config file named "crash_reporter.cfg". On Windows and Linux this file must be placed next to the main application executable. On macOS this file must be placed in the top-level app bundle Resources directory (e.g. "<appname>.app/Contents/Resources"). File contents are as follows: # Comments start with a hash character and must be on their own line. [Config] ProductName=<Value of the "prod" crash key; defaults to "cef"> ProductVersion=<Value of the "ver" crash key; defaults to the CEF version> AppName=<Windows only; App-specific folder name component for storing crash information; default to "CEF"> ExternalHandler=<Windows only; Name of the external handler exe to use instead of re-launching the main exe; default to empty> BrowserCrashForwardingEnabled=<macOS only; True if browser process crashes should be forwarded to the system crash reporter; default to false> ServerURL=<crash server URL; default to empty> RateLimitEnabled=<True if uploads should be rate limited; default to true> MaxUploadsPerDay=<Max uploads per 24 hours, used if rate limit is enabled; default to 5> MaxDatabaseSizeInMb=<Total crash report disk usage greater than this value will cause older reports to be deleted; default to 20> MaxDatabaseAgeInDays=<Crash reports older than this value will be deleted; default to 5> [CrashKeys] my_key1=<small|medium|large> my_key2=<small|medium|large> Config section: If "ProductName" and/or "ProductVersion" are set then the specified values will be included in the crash dump metadata. On macOS if these values are set to NULL then they will be retrieved from the Info.plist file using the "CFBundleName" and "CFBundleShortVersionString" keys respectively. If "AppName" is set on Windows then crash report information (metrics, database and dumps) will be stored locally on disk under the "C:\Users\[CurrentUser]\AppData\Local\[AppName]\User Data" folder. On other platforms the CfrSettings.UserDataPath value will be used. If "ExternalHandler" is set on Windows then the specified exe will be launched as the crashpad-handler instead of re-launching the main process exe. The value can be an absolute path or a path relative to the main exe directory. On Linux the CfrSettings.BrowserSubprocessPath value will be used. On macOS the existing subprocess app bundle will be used. If "BrowserCrashForwardingEnabled" is set to true (1) on macOS then browser process crashes will be forwarded to the system crash reporter. This results in the crash UI dialog being displayed to the user and crash reports being logged under "~/Library/Logs/DiagnosticReports". Forwarding of crash reports from non-browser processes and Debug builds is always disabled. If "ServerURL" is set then crashes will be uploaded as a multi-part POST request to the specified URL. Otherwise, reports will only be stored locally on disk. If "RateLimitEnabled" is set to true (1) then crash report uploads will be rate limited as follows: 1. If "MaxUploadsPerDay" is set to a positive value then at most the specified number of crashes will be uploaded in each 24 hour period. 2. If crash upload fails due to a network or server error then an incremental backoff delay up to a maximum of 24 hours will be applied for retries. 3. If a backoff delay is applied and "MaxUploadsPerDay" is > 1 then the "MaxUploadsPerDay" value will be reduced to 1 until the client is restarted. This helps to avoid an upload flood when the network or server error is resolved. Rate limiting is not supported on Linux. If "MaxDatabaseSizeInMb" is set to a positive value then crash report storage on disk will be limited to that size in megabytes. For example, on Windows each dump is about 600KB so a "MaxDatabaseSizeInMb" value of 20 equates to about 34 crash reports stored on disk. Not supported on Linux. If "MaxDatabaseAgeInDays" is set to a positive value then crash reports older than the specified age in days will be deleted. Not supported on Linux. CrashKeys section: Any number of crash keys can be specified for use by the application. Crash key values will be truncated based on the specified size (small = 63 bytes, medium = 252 bytes, large = 1008 bytes). The value of crash keys can be set from any thread or process using the CfrSetCrashKeyValue function. These key/value pairs will be sent to the crash server along with the crash dump file. Medium and large values will be chunked for submission. For example, if your key is named "mykey" then the value will be broken into ordered chunks and submitted using keys named "mykey-1", "mykey-2", etc.

See also the original CEF documentation in cef/include/capi/cef_crash_util_capi.h.

Creates a directory and all parent directories if they don't already exist. Returns true (1) on successful creation or if the directory already exists. The directory is only readable by the current user. Calling this function on the browser process UI or IO threads is not allowed.

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

Creates a new directory. On Windows if |prefix| is provided the new directory name is in the format of "prefixyyyy". Returns true (1) on success and sets |newTempPath| to the full path of the directory that was created. The directory is only readable by the current user. Calling this function on the browser process UI or IO threads is not allowed.

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

Creates a directory within another directory. Extra characters will be appended to |prefix| to ensure that the new directory does not have the same name as an existing directory. Returns true (1) on success and sets |newDir| to the full path of the directory that was created. The directory is only readable by the current user. Calling this function on the browser process UI or IO threads is not allowed.

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

Returns true (1) if called on the specified thread. Equivalent to using CfrTaskRunner.GetForThread(threadId).BelongsToCurrentThread().

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Deletes the given path whether it's a file or a directory. If |path| is a directory all contents will be deleted. If |recursive| is true (1) any sub- directories and their contents will also be deleted (equivalent to executing "rm -rf", so use with caution). On POSIX environments if |path| is a symbolic link then only the symlink will be deleted. Returns true (1) on successful deletion or if |path| does not exist. Calling this function on the browser process UI or IO threads is not allowed.

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

Returns true (1) if the given path exists and is a directory. Calling this function on the browser process UI or IO threads is not allowed.

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

This is a convenience function for formatting a URL in a concise and human- friendly way to help users make security-related decisions (or in other circumstances when people need to distinguish sites, origins, or otherwise- simplified URLs from each other). Internationalized domain names (IDN) may be presented in Unicode if the conversion is considered safe. The returned value will (a) omit the path for standard schemes, excepting file and filesystem, and (b) omit the port if it is the default for the scheme. Do not use this for URLs which will be parsed or sent to other applications.

See also the original CEF documentation in cef/include/capi/cef_parser_capi.h.

Get the temporary directory provided by the system. WARNING: In general, you should use the temp directory variants below instead of this function. Those variants will ensure that the proper permissions are set so that other users on the system can't edit them while they're open (which could lead to security issues).

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

Returns true (1) if the certificate status has any error, major or minor.

See also the original CEF documentation in cef/include/capi/cef_ssl_info_capi.h.

Returns true (1) if the certificate status represents only minor errors (e.g. failure to verify certificate revocation).

See also the original CEF documentation in cef/include/capi/cef_ssl_info_capi.h.

Loads the existing "Certificate Revocation Lists" file that is managed by Google Chrome. This file can generally be found in Chrome's User Data directory (e.g. "C:\Users\[User]\AppData\Local\Google\Chrome\User Data\" on Windows) and is updated periodically by Chrome's component updater service. Must be called in the browser process after the context has been initialized. See https://dev.chromium.org/Home/chromium-security/crlsets for background.

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

Post a task for delayed execution on the specified thread. Equivalent to using CfrTaskRunner.GetForThread(threadId).PostDelayedTask(task, delay_ms).

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Post a task for execution on the specified thread. Equivalent to using CfrTaskRunner.GetForThread(threadId).PostTask(task).

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

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. Example JavaScript extension code: <pre> // create the 'example' global object if it doesn't already exist. if (!example) example = {}; // create the 'example.test' global object if it doesn't already exist. if (!example.test) example.test = {}; (function() { // Define the function 'example.test.myfunction'. example.test.myfunction = function() { // Call CfrV8Handler.Execute() with the function name 'MyFunction' // and no arguments. native function MyFunction(); return MyFunction(); }; // Define the getter function for parameter 'example.test.myparam'. example.test.__defineGetter__('myparam', function() { // Call CfrV8Handler.Execute() with the function name 'GetMyParam' // and no arguments. native function GetMyParam(); return GetMyParam(); }); // Define the setter function for parameter 'example.test.myparam'. example.test.__defineSetter__('myparam', function(b) { // Call CfrV8Handler.Execute() with the function name 'SetMyParam' // and a single argument. native function SetMyParam(); if(b) SetMyParam(b); }); // Extension definitions can also contain normal JavaScript variables // and functions. var myint = 0; example.test.increment = function() { myint += 1; return myint; }; })(); </pre> Example usage in the page: <pre> // Call the function. example.test.myfunction(); // Set the parameter. example.test.myparam = value; // Get the parameter. value = example.test.myparam; // Call another function. example.test.increment(); </pre>

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Sets or clears a specific key-value pair from the crash metadata.

See also the original CEF documentation in cef/include/capi/cef_crash_util_capi.h.

Writes the contents of |srcDir| into a zip archive at |destFile|. If |includeHiddenFiles| is true (1) files starting with "." will be included. Returns true (1) on success. Calling this function on the browser process UI or IO threads is not allowed.

See also the original CEF documentation in cef/include/capi/cef_file_util_capi.h.

This function should be called from the render process startup callback provided to CfxRuntime.Initialize() in the browser process. It will call into the render process passing in the provided |application| object and block until the render process exits. The |application| object will receive CEF framework callbacks from within the render process.

Provides access to the remote process unmanaged memory.

Call Marshal.AllocHGlobal in the target process. A thread must be in a remote context in order to access this function.

Call Marshal.FreeHGlobal in the target process.

Call Marshal.Copy in the target process.

Call Marshal.Copy in the target process.

Call Marshal.Copy in the target process.

Call Marshal.PtrToStringUni in the target process.

Structure that manages custom scheme registrations.

See also the original CEF documentation in cef/include/capi/cef_scheme_capi.h.

Register a custom scheme. This function should not be called for the built- in HTTP, HTTPS, FILE, FTP, ABOUT and DATA schemes. If |isStandard| is true (1) the scheme will be treated as a standard scheme. Standard schemes are subject to URL canonicalization and parsing rules as defined in the Common Internet Scheme Syntax RFC 1738 Section 3.1 available at http://www.ietf.org/rfc/rfc1738.txt In particular, the syntax for standard scheme URLs must be of the form: <pre> [scheme]://[username]:[password]@[host]:[port]/[url-path] </pre> Standard scheme URLs must have a host component that is a fully qualified domain name as defined in Section 3.5 of RFC 1034 [13] and Section 2.1 of RFC 1123. These URLs will be canonicalized to "scheme://host/path" in the simplest case and "scheme://username:password@host:port/path" in the most explicit case. For example, "scheme:host/path" and "scheme:///host/path" will both be canonicalized to "scheme://host/path". The origin of a standard scheme URL is the combination of scheme, host and port (i.e., "scheme://host:port" in the most explicit case). For non-standard scheme URLs only the "scheme:" component is parsed and canonicalized. The remainder of the URL will be passed to the handler as- is. For example, "scheme:///some%20text" will remain the same. Non-standard scheme URLs cannot be used as a target for form submission. If |isLocal| is true (1) the scheme will be treated with the same security rules as those applied to "file" URLs. Normal pages cannot link to or access local URLs. Also, by default, local URLs can only perform XMLHttpRequest calls to the same URL (origin + path) that originated the request. To allow XMLHttpRequest calls from a local URL to other URLs with the same origin set the CfrSettings.FileAccessFromFileUrlsAllowed value to true (1). To allow XMLHttpRequest calls from a local URL to all origins set the CfrSettings.UniversalAccessFromFileUrlsAllowed value to true (1). If |isDisplayIsolated| is true (1) the scheme can only be displayed from other content hosted with the same scheme. For example, pages in other origins cannot create iframes or hyperlinks to URLs with the scheme. For schemes that must be accessible from other schemes set this value to false (0), set |isCorsEnabled| to true (1), and use CORS "Access-Control-Allow- Origin" headers to further restrict access. If |isSecure| is true (1) the scheme will be treated with the same security rules as those applied to "https" URLs. For example, loading this scheme from other secure schemes will not trigger mixed content warnings. If |isCorsEnabled| is true (1) the scheme can be sent CORS requests. This value should be true (1) in most cases where |isStandard| is true (1). If |isCspBypassing| is true (1) the scheme can bypass Content-Security- Policy (CSP) checks. This value should be false (0) in most cases where |isStandard| is true (1). This function may be called on any thread. It should only be called once per unique |schemeName| value. If |schemeName| is already registered or if an error occurs this function will return false (0).

See also the original CEF documentation in cef/include/capi/cef_scheme_capi.h.

Structure used to read data from a stream. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Create a new CfrStreamReader object from a file.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Create a new CfrStreamReader object from data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Create a new CfrStreamReader object from a custom handler.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Read raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Seek to the specified offset position. |whence| may be any one of SEEK_CUR, SEEK_END or SEEK_SET. Returns zero on success and non-zero on failure.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return the current offset position.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return non-zero if at end of file.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Returns true (1) if this reader performs work like accessing the file system which may block. Used as a hint for determining the thread to access the reader from.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Structure used to write data to a stream. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Create a new CfrStreamWriter object for a file.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Create a new CfrStreamWriter object for a custom handler.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Write raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Seek to the specified offset position. |whence| may be any one of SEEK_CUR, SEEK_END or SEEK_SET. Returns zero on success and non-zero on failure.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return the current offset position.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Flush the stream.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Returns true (1) if this writer performs work like accessing the file system which may block. Used as a hint for determining the thread to access the writer from.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Implement this structure to receive string values asynchronously.

See also the original CEF documentation in cef/include/capi/cef_string_visitor_capi.h.

Method that will be executed.

See also the original CEF documentation in cef/include/capi/cef_string_visitor_capi.h.

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.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Method that will be executed on the target thread.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Structure that asynchronously executes tasks on the associated thread. It is safe to call the functions of this structure on any thread. CEF maintains multiple internal threads that are used for handling different types of tasks in different processes. The CfrThreadId definitions in cef_types.h list the common CEF threads. Task runners are also available for other CEF threads as appropriate (for example, V8 WebWorker threads).

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

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.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Returns the task runner for the specified CEF thread.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Returns true (1) if this object is pointing to the same task runner as |that| object.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Returns true (1) if this task runner belongs to the current thread.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Returns true (1) if this task runner is for the specified CEF thread.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Post a task for execution on the thread associated with this task runner. Execution will occur asynchronously.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

Post a task for delayed execution on the thread associated with this task runner. Execution will occur asynchronously. Delayed tasks are not supported on V8 WebWorker threads and will be executed without the specified delay.

See also the original CEF documentation in cef/include/capi/cef_task_capi.h.

A simple thread abstraction that establishes a message loop on a new thread. The consumer uses CfrTaskRunner to execute code on the thread's message loop. The thread is terminated when the CfrThread object is destroyed or stop() is called. All pending tasks queued on the thread's message loop will run to completion before the thread is terminated. cef_thread_create() can be called on any valid CEF thread in either the browser or render process. This structure should only be used for tasks that require a dedicated thread. In most cases you can post tasks to an existing CEF thread instead of creating a new one; see cef_task.h for details.

See also the original CEF documentation in cef/include/capi/cef_thread_capi.h.

Create and start a new thread. This function does not block waiting for the thread to run initialization. |displayName| is the name that will be used to identify the thread. |priority| is the thread execution priority. |messageLoopType| indicates the set of asynchronous events that the thread can process. If |stoppable| is true (1) the thread will stopped and joined on destruction or when stop() is called; otherwise, the the thread cannot be stopped and will be leaked on shutdown. On Windows the |comInitMode| value specifies how COM will be initialized for the thread. If |comInitMode| is set to COM_INIT_MODE_STA then |messageLoopType| must be set to ML_TYPE_UI.

See also the original CEF documentation in cef/include/capi/cef_thread_capi.h.

Returns the CfrTaskRunner that will execute code on this thread's message loop. This function is safe to call from any thread.

See also the original CEF documentation in cef/include/capi/cef_thread_capi.h.

Returns the platform thread ID. It will return the same value after stop() is called. This function is safe to call from any thread.

See also the original CEF documentation in cef/include/capi/cef_thread_capi.h.

Returns true (1) if the thread is currently running. This function must be called from the same thread that called cef_thread_create().

See also the original CEF documentation in cef/include/capi/cef_thread_capi.h.

Stop and join the thread. This function must be called from the same thread that called cef_thread_create(). Do not call this function if cef_thread_create() was called with a |stoppable| value of false (0).

See also the original CEF documentation in cef/include/capi/cef_thread_capi.h.

Time information. Values should always be in UTC.

See also the original CEF documentation in cef/include/internal/cef_time.h.

Structure that should be implemented to handle V8 accessor calls. Accessor identifiers are registered by calling CfrV8Value.SetValue(). The functions of this structure will be called on the thread associated with the V8 accessor.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle retrieval the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. If retrieval succeeds set |Retval| to the return value. If retrieval fails set |Exception| to the exception that will be thrown. Return true (1) if accessor retrieval was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle assignment of the accessor value identified by |Name|. |Object| is the receiver ('this' object) of the accessor. |Value| is the new value being assigned to the accessor. If assignment fails set |Exception| to the exception that will be thrown. Return true (1) if accessor assignment was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

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 CfrV8Context.GetTaskRunner() function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the current (top) context object in the V8 context stack.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the entered (bottom) context object in the V8 context stack.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if V8 is currently inside a context.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the task runner associated with this context. V8 handles can only be accessed from the thread on which they are created. This function can be called on any render process thread.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the underlying handle is valid and it can be accessed on the current thread. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the browser for this context. This function will return an NULL reference for WebWorker contexts.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the frame for this context. This function will return an NULL reference for WebWorker contexts.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the global object for this context. The context must be entered before calling this function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Enter this context. A context must be explicitly entered before creating a V8 Object, Array, Function or Date asynchronously. exit() must be called the same number of times as enter() before releasing this context. V8 objects belong to the context in which they are created. Returns true (1) if the scope was entered successfully.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Exit this context. Call this function only after calling enter(). Returns true (1) if the scope was exited successfully.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if this object is pointing to the same handle as |that| object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Execute a string of JavaScript code in this V8 context. The |scriptUrl| parameter is the URL where the script in question can be found, if any. The |startLine| parameter is the base line number to use for error reporting. On success |retval| will be set to the return value, if any, and the function will return true (1). On failure |exception| will be set to the exception, if any, and the function will return false (0).

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Structure representing a V8 exception. The functions of this structure may be called on any render process thread.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the exception message.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the line of source code that the exception occurred within.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the resource name for the script from where the function causing the error originates.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the 1-based number of the line where the error occurred or 0 if the line number is unknown.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the index within the script of the first character where the error occurred.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the index within the script of the last character where the error occurred.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the index within the line of the first character where the error occurred.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the index within the line of the last character where the error occurred.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

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.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle execution of the function identified by |Name|. |Object| is the receiver ('this' object) of the function. |Arguments| is the list of arguments passed to the function. If execution succeeds set |Retval| to the function return value. If execution fails set |Exception| to the exception that will be thrown. Return true (1) if execution was handled.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

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 CfrString) 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.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle retrieval of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. If the property has an associated accessor, it will be called only if you don't set |Retval|. Return true (1) if interceptor retrieval was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle retrieval of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. If retrieval succeeds, set |Retval| to the return value. If the requested value does not exist, don't set either |Retval| or |Exception|. If retrieval fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor retrieval was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle assignment of the interceptor value identified by |Name|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. This setter will always be called, even when the property has an associated accessor. Return true (1) if interceptor assignment was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Handle assignment of the interceptor value identified by |Index|. |Object| is the receiver ('this' object) of the interceptor. |Value| is the new value being assigned to the interceptor. If assignment fails, set |Exception| to the exception that will be thrown. Return true (1) if interceptor assignment was handled, false (0) otherwise.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

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 CfrV8Context.GetTaskRunner() function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the underlying handle is valid and it can be accessed on the current thread. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the name of the resource script that contains the function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the name of the resource script that contains the function or the sourceURL value if the script name is undefined and its source ends with a "//@ sourceURL=..." string.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the name of the function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the 1-based line number for the function call or 0 if unknown.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the 1-based column offset on the line for the function call or 0 if unknown.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the function was compiled using eval().

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the function was called as a constructor via "new".

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

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 CfrV8Context.GetTaskRunner() function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the stack trace for the currently active context. |frameLimit| is the maximum number of frames that will be captured.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the underlying handle is valid and it can be accessed on the current thread. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the number of stack frames.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the stack frame at the specified 0-based index.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

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 CfrV8Context.GetTaskRunner() function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfrV8Value object of type undefined.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfrV8Value object of type null.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfrV8Value object of type bool.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfrV8Value object of type int.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfrV8Value object of type unsigned int.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfrV8Value object of type double.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfrV8Value object of type Date. This function should only be called from within the scope of a CfrRenderProcessHandler, CfrV8Handler or CfrV8Accessor callback, or in combination with calling enter() and exit() on a stored CfrV8Context reference.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfrV8Value object of type string.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfrV8Value object of type object with optional accessor and/or interceptor. This function should only be called from within the scope of a CfrRenderProcessHandler, CfrV8Handler or CfrV8Accessor callback, or in combination with calling enter() and exit() on a stored CfrV8Context reference.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfrV8Value 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 CfrRenderProcessHandler, CfrV8Handler or CfrV8Accessor callback, or in combination with calling enter() and exit() on a stored CfrV8Context reference.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfrV8Value object of type function. This function should only be called from within the scope of a CfrRenderProcessHandler, CfrV8Handler or CfrV8Accessor callback, or in combination with calling enter() and exit() on a stored CfrV8Context reference.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the underlying handle is valid and it can be accessed on the current thread. Do not call any other functions if this function returns false (0).

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is undefined.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is null.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is bool.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is int.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is unsigned int.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is double.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is Date.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is string.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is array.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

True if the value type is function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Return a bool value.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Return an int value.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Return an unsigned int value.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Return a double value.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Return a Date value.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Return a string value.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if this is a user created object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the last function call resulted in an exception. This attribute exists only in the scope of the current CEF value object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the exception resulting from the last function call. This attribute exists only in the scope of the current CEF value object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the user data, if any, assigned to this object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the amount of externally allocated memory registered for the object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the number of elements in the array.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the function name.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the function handler or NULL if not a CEF-created function.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if this object is pointing to the same handle as |that| object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Clears the last exception and returns true (1) on success.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if this object will re-throw future exceptions. This attribute exists only in the scope of the current CEF value object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Set whether this object will re-throw future exceptions. By default exceptions are not re-thrown. If a exception is re-thrown the current context should not be accessed again until after the exception has been caught and not re-thrown. Returns true (1) on success. This attribute exists only in the scope of the current CEF value object.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the object has a value with the specified identifier.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns true (1) if the object has a value with the specified identifier.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Deletes the value with the specified identifier and returns true (1) on success. Returns false (0) if this function is called incorrectly or an exception is thrown. For read-only and don't-delete values this function will return true (1) even though deletion failed.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Deletes the value with the specified identifier and returns true (1) on success. Returns false (0) if this function is called incorrectly, deletion fails or an exception is thrown. For read-only and don't-delete values this function will return true (1) even though deletion failed.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the value with the specified identifier on success. Returns NULL if this function is called incorrectly or an exception is thrown.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Returns the value with the specified identifier on success. Returns NULL if this function is called incorrectly or an exception is thrown.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Associates a value with the specified identifier and returns true (1) on success. Returns false (0) if this function is called incorrectly or an exception is thrown. For read-only values this function will return true (1) even though assignment failed.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Associates a value with the specified identifier and returns true (1) on success. Returns false (0) if this function is called incorrectly or an exception is thrown. For read-only values this function will return true (1) even though assignment failed.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Registers an identifier and returns true (1) on success. Access to the identifier will be forwarded to the CfrV8Accessor instance passed to CfrV8Value.CfrV8ValueCreateObject(). Returns false (0) if this function is called incorrectly or an exception is thrown. For read-only values this function will return true (1) even though assignment failed.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Read the keys for the object's values into the specified vector. Integer- based keys will also be returned as strings.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Sets the user data for this object and returns true (1) on success. Returns false (0) if this function is called incorrectly. This function can only be called on user created objects.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Adjusts the amount of registered external memory for the object. Used to give V8 an indication of the amount of externally allocated memory that is kept alive by JavaScript objects. V8 uses this information to decide when to perform global garbage collection. Each CfrV8Value tracks the amount of external memory associated with it and automatically decreases the global total by the appropriate amount on its destruction. |changeInBytes| specifies the number of bytes to adjust by. This function returns the number of bytes associated with the object after the adjustment. This function can only be called on user created objects.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Execute the function using the current V8 context. This function should only be called from within the scope of a CfrV8Handler or CfrV8Accessor callback, or in combination with calling enter() and exit() on a stored CfrV8Context reference. |object| is the receiver ('this' object) of the function. If |object| is NULL the current context's global object will be used. |arguments| is the list of arguments that will be passed to the function. Returns the function return value on success. Returns NULL if this function is called incorrectly or an exception is thrown.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Execute the function using the specified V8 context. |object| is the receiver ('this' object) of the function. If |object| is NULL the specified context's global object will be used. |arguments| is the list of arguments that will be passed to the function. Returns the function return value on success. Returns NULL if this function is called incorrectly or an exception is thrown.

See also the original CEF documentation in cef/include/capi/cef_v8_capi.h.

Create a new CfrV8Value object of type object with accessor. This function should only be called from within the scope of a CfrRenderProcessHandler, CfrV8Handler or CfrV8Accessor callback, or in combination with calling enter() and exit() on a stored CfrV8Context reference.

Create a new CfrV8Value object of type object with interceptor. This function should only be called from within the scope of a CfrRenderProcessHandler, CfrV8Handler or CfrV8Accessor callback, or in combination with calling enter() and exit() on a stored CfrV8Context reference.

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.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Creates a new object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if the underlying data is valid. This will always be true (1) for simple types. For complex types (binary, dictionary and list) the underlying data may become invalid if owned by another object (e.g. list or dictionary) and that other object is then modified or destroyed. This value object can be re-used by calling Set*() even if the underlying data is invalid.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if the underlying data is owned by another object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if the underlying data is read-only. Some APIs may expose read-only objects.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value type.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value as type bool.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value as type int.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value as type double.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value as type string.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value as type binary. The returned reference may become invalid if the value is owned by another object or if ownership is transferred to another object in the future. To maintain a reference to the value after assigning ownership to a dictionary or list pass this object to the set_value() function instead of passing the returned reference to set_binary().

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value as type dictionary. The returned reference may become invalid if the value is owned by another object or if ownership is transferred to another object in the future. To maintain a reference to the value after assigning ownership to a dictionary or list pass this object to the set_value() function instead of passing the returned reference to set_dictionary().

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns the underlying value as type list. The returned reference may become invalid if the value is owned by another object or if ownership is transferred to another object in the future. To maintain a reference to the value after assigning ownership to a dictionary or list pass this object to the set_value() function instead of passing the returned reference to set_list().

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have the same underlying data. If true (1) modifications to this object will also affect |that| object and vice-versa.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns true (1) if this object and |that| object have an equivalent underlying value but are not necessarily the same object.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Returns a copy of this object. The underlying data will also be copied.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type null. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type bool. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type int. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type double. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type string. Returns true (1) if the value was set successfully.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type binary. Returns true (1) if the value was set successfully. This object keeps a reference to |value| and ownership of the underlying data remains unchanged.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type dict. Returns true (1) if the value was set successfully. This object keeps a reference to |value| and ownership of the underlying data remains unchanged.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

Sets the underlying value as type list. Returns true (1) if the value was set successfully. This object keeps a reference to |value| and ownership of the underlying data remains unchanged.

See also the original CEF documentation in cef/include/capi/cef_values_capi.h.

WaitableEvent is a thread synchronization tool that allows one thread to wait for another thread to finish some work. This is equivalent to using a Lock+ConditionVariable to protect a simple boolean value. However, using WaitableEvent in conjunction with a Lock to wait for a more complex state change (e.g., for an item to be added to a queue) is not recommended. In that case consider using a ConditionVariable instead of a WaitableEvent. It is safe to create and/or signal a WaitableEvent from any thread. Blocking on a WaitableEvent by calling the *wait() functions is not allowed on the browser process UI or IO threads.

See also the original CEF documentation in cef/include/capi/cef_waitable_event_capi.h.

Create a new waitable event. If |automaticReset| is true (1) then the event state is automatically reset to un-signaled after a single waiting thread has been released; otherwise, the state remains signaled until reset() is called manually. If |initiallySignaled| is true (1) then the event will start in the signaled state.

See also the original CEF documentation in cef/include/capi/cef_waitable_event_capi.h.

Returns true (1) if the event is in the signaled state, else false (0). If the event was created with |automaticReset| set to true (1) then calling this function will also cause a reset.

See also the original CEF documentation in cef/include/capi/cef_waitable_event_capi.h.

Put the event in the un-signaled state.

See also the original CEF documentation in cef/include/capi/cef_waitable_event_capi.h.

Put the event in the signaled state. This causes any thread blocked on Wait to be woken up.

See also the original CEF documentation in cef/include/capi/cef_waitable_event_capi.h.

Wait indefinitely for the event to be signaled. This function will not return until after the call to signal() has completed. This function cannot be called on the browser process UI or IO threads.

See also the original CEF documentation in cef/include/capi/cef_waitable_event_capi.h.

Wait up to |maxMs| milliseconds for the event to be signaled. Returns true (1) if the event was signaled. A return value of false (0) does not necessarily mean that |maxMs| was exceeded. This function will not return until after the call to signal() has completed. This function cannot be called on the browser process UI or IO threads.

See also the original CEF documentation in cef/include/capi/cef_waitable_event_capi.h.

Structure the client can implement to provide a custom stream writer. The functions of this structure may be called on any thread.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Write raw binary data.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Seek to the specified offset position. |Whence| may be any one of SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on failure.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return the current offset position.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Flush the stream.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Return true (1) if this handler performs work like accessing the file system which may block. Used as a hint for determining the thread to access the handler from.

See also the original CEF documentation in cef/include/capi/cef_stream_capi.h.

Structure that supports the reading of XML data via the libxml streaming API. The functions of this structure should only be called on the thread that creates the object.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Create a new CfrXmlReader object. The returned object's functions can only be called from the thread that created the object.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns true (1) if an error has been reported by the XML parser.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the node type.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the node depth. Depth starts at 0 for the root node.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the local name. See http://www.w3.org/TR/REC-xml-names/#NT- LocalPart for additional details.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the namespace prefix. See http://www.w3.org/TR/REC-xml-names/ for additional details.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the qualified name, equal to (Prefix:)LocalName. See http://www.w3.org/TR/REC-xml-names/#ns-qualnames for additional details.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the URI defining the namespace associated with the node. See http://www.w3.org/TR/REC-xml-names/ for additional details.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the base URI of the node. See http://www.w3.org/TR/xmlbase/ for additional details.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the xml:lang scope within which the node resides. See http://www.w3.org/TR/REC-xml/#sec-lang-tag for additional details.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns true (1) if the node represents an NULL element. <a/> is considered NULL but <a></a> is not.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns true (1) if the node has a text value.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the text value.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns true (1) if the node has attributes.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the number of attributes.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns an XML representation of the current node's children.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns an XML representation of the current node including its children.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the line number for the current node.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Moves the cursor to the next node in the document. This function must be called at least once to set the current cursor position. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Close the document. This should be called directly to ensure that cleanup occurs on the correct thread.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the error string.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the value of the attribute at the specified 0-based index.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the value of the attribute with the specified qualified name.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Returns the value of the attribute with the specified local name and namespace URI.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Moves the cursor to the attribute at the specified 0-based index. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Moves the cursor to the attribute with the specified qualified name. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Moves the cursor to the attribute with the specified local name and namespace URI. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Moves the cursor to the first attribute in the current element. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Moves the cursor to the next attribute in the current element. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Moves the cursor back to the carrying element. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_xml_reader_capi.h.

Structure that supports the reading of zip archives via the zlib unzip API. The functions of this structure should only be called on the thread that creates the object.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Create a new CfrZipReader object. The returned object's functions can only be called from the thread that created the object.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Returns the name of the file.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Returns the uncompressed size of the file.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Returns the last modified timestamp for the file.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Moves the cursor to the first file in the archive. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Moves the cursor to the next file in the archive. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Moves the cursor to the specified file in the archive. If |caseSensitive| is true (1) then the search will be case sensitive. Returns true (1) if the cursor position was set successfully.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Closes the archive. This should be called directly to ensure that cleanup occurs on the correct thread.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Opens the file for reading of uncompressed data. A read password may optionally be specified.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Closes the file.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Read uncompressed file contents into the specified buffer. Returns < 0 if an error occurred, 0 if at the end of file, or the number of bytes read.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Returns the current offset in the uncompressed file contents.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Returns true (1) if at end of the file contents.

See also the original CEF documentation in cef/include/capi/cef_zip_reader_capi.h.

Base class for all remote wrapper classes for CEF library structs.

Base class for all remote wrapper classes for CEF client structs.

When true, all CEF callback events are disabled for this handler. Incoming callbacks will return default values to CEF.

Base class for all wrapper classes for scoped CEF library structs. Objects of this type will be disposed when they go out of scope.

Base class for all remote callback event args.

Base class for all remote wrapper classes for ref counted CEF structs.

Base class for all remote wrapper classes for CEF structs.

Creates a remote call context for the render process this object belongs to.

Address of the underlying native CEF object in the render process memory space.

Base class for all remote wrapper classes for CEF structs without refcount.

Prepares and executes the remote procedure in the remote process

Marshals a callback from a client in the render process to the browser process.

Marshals a callback from a client in the render process to the browser process.

Represents an IntPtr in the remote process.

Two remote pointers are equal if both are null or both are of the same value on the same connection.

index of the first valid byte in the buffer

index after the last valid byte in the buffer number of valid bytes = readBufferEnd - readBufferStart

number of valid bytes in the buffer

Remote connection in the render process. If null, then this is the browser process.

Base class for all wrapper classes for ref counted CEF structs.

Base class for all wrapper classes for scoped CEF library structs. Objects of this type will be disposed when they go out of scope.

Provides access to the underlying native cef struct. This is a scoped library struct derived from cef_base_scoped_t. It will be destroyed when the managed object goes out of scope.

Base class for all wrapper classes for CEF client callback or handler structs.

Provides access to the underlying native cef struct. This is a refcounted client struct derived from cef_base_ref_counted_t. Add a ref in order to keep it alive when this managed object go out of scope.

When true, all CEF callback events are disabled for this handler. Incoming callbacks will return default values to CEF.

32-bit ARGB color value, not premultiplied. The color components are always in a known order. Equivalent to the SkColor type.

Return an CfxColor with the specified value. A is the highest byte, b is the lowest.

Return an CfxColor with the specified byte component values.

Get the ARGB value of this CfxColor. A is the highest byte, b is the lowest.

Get the A value of this CfxColor.

Get the R value of this CfxColor.

Get the G value of this CfxColor.

Get the B value of this CfxColor.

Base class for all wrapper classes for CEF library structs.

Provides access to the underlying native cef struct. This is a refcounted library struct derived from cef_base_ref_counted_t. Add a ref in order to keep it alive when this managed object go out of scope.

Operating systems supported by CEF.

Windows (see CEF documentation for supported versions).

Linux. Not yet supported by ChromiumFX.

MacOSX. Not yet supported by ChromiumFX.

Supported architectures.

The x86 architecture (32-bit).

The x64 architecture (64-bit).

Provides methods and events for managing the remote callback interface.

Cancel the callback if this returns false.

Suspend all callbacks from the given process. If one or more callbacks from the given process are currently running, this function will block and wait until the last callback returns. After calling this function, all callbacks from the given process will be cancelled and return to the render process without executing any application defined event handlers, delivering default values for return value and out parameters. Calls to SuspendCallbacks/ResumeCallbacks can be nested. ResumeCallbacks must be called the same number of times as SuspendCallbacks in order to resume execution of callbacks from the given process.

Resume all callbacks from the given process. This function returns immedeately. Calls to SuspendCallbacks/ResumeCallbacks can be nested. ResumeCallbacks must be called at least the same number of times as SuspendCallbacks in order to resume execution of callbacks from the given process.

Enables access to static members and constructors of remote (Cfr*) classes. In the scope of a remote callback event, the executing thread is always in the context of the calling thread in the render process.

The process id of the remote process.

Within the scope of a render process callback, the managed thread id of the calling thread in the render process. Zero if the context is not in the scope of a render process callback.

Enter the context of a remote thread. Calls to Enter()/Exit() must be balanced. Use try/finally constructs to make sure that Exit() is called the same number of times as Enter().

Exit the context of a remote thread. Throws an exception if the calling thread is not currently in this remote thread context.

Returns the current context for the calling thread. Throws an exception if the calling thread is not currently in a remote call context.

True if the calling thread is currently in a remote call context, false otherwise.

Class representing window information.

See also the original CEF documentation in cef/include/internal/cef_types_win.h and linux/cef/include/internal/cef_types_linux.h.

Create the browser as a child window.

Create the browser as a disabled child window.

Create the browser as a popup window.

Create the browser using windowless (off-screen) rendering. No window will be created for the browser and all rendering will occur via the CfxRenderHandler interface. The |parent| value will be used to identify monitor info and to act as the parent window for dialogs, context menus, etc. If |parent| is not provided then the main screen monitor will be used and some functionality that requires a parent window may not function correctly. In order to create windowless browsers the CfxSettings.WindowlessRenderingEnabled value must be set to true. Transparent painting is enabled by default but can be disabled by setting CfxBrowserSettings.BackgroundColor to an opaque value.

Standard parameters required by CreateWindowEx()

See also the original CEF documentation in cef/include/internal/cef_types_win.h.

Set to true (1) to create the browser using windowless (off-screen) rendering. No window will be created for the browser and all rendering will occur via the CfxRenderHandler interface. The |parentWindow| value will be used to identify monitor info and to act as the parent window for dialogs, context menus, etc. If |parentWindow| is not provided then the main screen monitor will be used and some functionality that requires a parent window may not function correctly. In order to create windowless browsers the CfxSettings.WindowlessRenderingEnabled value must be set to true.

See also the original CEF documentation in cef/include/internal/cef_types_win.h and linux/cef/include/internal/cef_types_linux.h.

Handle for the new browser window. Only used with windowed rendering.

See also the original CEF documentation in cef/include/internal/cef_types_win.h and linux/cef/include/internal/cef_types_linux.h.

Dynamically loads a native library.

The library name without extension. The library handle or IntPtr.Zero if load fails.

Gets a pointer for a function in a dynamically loaded native library.

The library handle. The function name. A pointer to the function or IntPtr.Zero if the function fails.

Class for ChromiumFX related exceptions.

The exception that is thrown when an error in the remote layer occurs.

Base class for all wrapper classes for CEF structs.

Base class for all CEF framework callback event args.

Delegate for the main callback of the remote render process.

Base class for all wrapper classes for CEF structs without refcount.

Provides access to the underlying native cef struct. This object is not refcounted. The native cef struct will be destroyed when this object is disposed or finalized.

Window Styles. The following styles can be specified wherever a window style is required. After the control has been created, these styles cannot be modified, except as noted.

The window has a thin-line border.

The window has a title bar (includes the WS_BORDER style).

The window is a child window. A window with this style cannot have a menu bar. This style cannot be used with the WS_POPUP style.

Excludes the area occupied by child windows when drawing occurs within the parent window. This style is used when creating the parent window.

Clips child windows relative to each other; that is, when a particular child window receives a WM_PAINT message, the WS_CLIPSIBLINGS style clips all other overlapping child windows out of the region of the child window to be updated. If WS_CLIPSIBLINGS is not specified and child windows overlap, it is possible, when drawing within the client area of a child window, to draw within the client area of a neighboring child window.

The window is initially disabled. A disabled window cannot receive input from the user. To change this after a window has been created, use the EnableWindow function.

The window has a border of a style typically used with dialog boxes. A window with this style cannot have a title bar.

The window is the first control of a group of controls. The group consists of this first control and all controls defined after it, up to the next control with the WS_GROUP style. The first control in each group usually has the WS_TABSTOP style so that the user can move from group to group. The user can subsequently change the keyboard focus from one control in the group to the next control in the group by using the direction keys. You can turn this style on and off to change dialog box navigation. To change this style after a window has been created, use the SetWindowLong function.

The window has a horizontal scroll bar.

The window is initially maximized.

The window has a maximize button. Cannot be combined with the WS_EX_CONTEXTHELP style. The WS_SYSMENU style must also be specified.

The window is initially minimized.

The window has a minimize button. Cannot be combined with the WS_EX_CONTEXTHELP style. The WS_SYSMENU style must also be specified.

The window is an overlapped window. An overlapped window has a title bar and a border.

The window is an overlapped window.

The window is a pop-up window. This style cannot be used with the WS_CHILD style.

The window has a sizing border.

The window has a window menu on its title bar. The WS_CAPTION style must also be specified.

The window is a control that can receive the keyboard focus when the user presses the TAB key. Pressing the TAB key changes the keyboard focus to the next control with the WS_TABSTOP style. You can turn this style on and off to change dialog box navigation. To change this style after a window has been created, use the SetWindowLong function. For user-created windows and modeless dialogs to work with tab stops, alter the message loop to call the IsDialogMessage function.

The window is initially visible. This style can be turned on and off by using the ShowWindow or SetWindowPos function.

The window has a vertical scroll bar.