mirror of
https://github.com/salvadordf/CEF4Delphi.git
synced 2024-11-15 15:55:56 +01:00
496 lines
35 KiB
HTML
496 lines
35 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>cef4delphi: uCEFTypes: Record TCefSettings</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="generator" content="PasDoc 0.16.0-snapshot">
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8">
|
|
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
|
|
</head>
|
|
<body>
|
|
<span id="TCefSettings"></span><h1 class="cio">Record TCefSettings</h1>
|
|
<div class="sections">
|
|
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section">Hierarchy</div><div class="one_section"><a class="section" href="#PasDoc-Fields">Fields</a></div><div class="one_section">Methods</div><div class="one_section">Properties</div></div>
|
|
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
|
|
<p class="unitlink">
|
|
<a href="uCEFTypes.html">uCEFTypes</a></p>
|
|
<h2 class="declaration">Declaration</h2>
|
|
<p class="declaration">
|
|
<code>type TCefSettings = record</code></p>
|
|
<h2 class="description">Description</h2>
|
|
<p>
|
|
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. </p>
|
|
<p>
|
|
|
|
|
|
<p><see href="<a href="https://bitbucket.org/chromiumembedded/cef/src/master/include/internal/cef_types.h">https://bitbucket.org/chromiumembedded/cef/src/master/include/internal/cef_types.h</a>">CEF source file: /include/internal/cef_types.h (cef_settings_t))</p>
|
|
<h2 class="overview">Overview</h2>
|
|
<span id="PasDoc-Fields"></span><h3 class="summary">Fields</h3>
|
|
<table class="summary wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#size">size</a></strong>: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#no_sandbox">no_sandbox</a></strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#browser_subprocess_path">browser_subprocess_path</a></strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#framework_dir_path">framework_dir_path</a></strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#main_bundle_path">main_bundle_path</a></strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#chrome_runtime">chrome_runtime</a></strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#multi_threaded_message_loop">multi_threaded_message_loop</a></strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#external_message_pump">external_message_pump</a></strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#windowless_rendering_enabled">windowless_rendering_enabled</a></strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#command_line_args_disabled">command_line_args_disabled</a></strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#cache_path">cache_path</a></strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#root_cache_path">root_cache_path</a></strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#persist_session_cookies">persist_session_cookies</a></strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#persist_user_preferences">persist_user_preferences</a></strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#user_agent">user_agent</a></strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#user_agent_product">user_agent_product</a></strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#locale">locale</a></strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#log_file">log_file</a></strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#log_severity">log_severity</a></strong>: <a href="uCEFTypes.html#TCefLogSeverity">TCefLogSeverity</a>;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#log_items">log_items</a></strong>: <a href="uCEFTypes.html#TCefLogItems">TCefLogItems</a>;</code></td>
|
|
</tr>
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#javascript_flags">javascript_flags</a></strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#resources_dir_path">resources_dir_path</a></strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#locales_dir_path">locales_dir_path</a></strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#pack_loading_disabled">pack_loading_disabled</a></strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#remote_debugging_port">remote_debugging_port</a></strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#uncaught_exception_stack_size">uncaught_exception_stack_size</a></strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#background_color">background_color</a></strong>: <a href="uCEFTypes.html#TCefColor">TCefColor</a>;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#accept_language_list">accept_language_list</a></strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#cookieable_schemes_list">cookieable_schemes_list</a></strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#cookieable_schemes_exclude_defaults">cookieable_schemes_exclude_defaults</a></strong>: integer;</code></td>
|
|
</tr>
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#chrome_policy_id">chrome_policy_id</a></strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr class="list2">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><code><strong><a href="uCEFTypes.TCefSettings.html#chrome_app_icon_id">chrome_app_icon_id</a></strong>: Integer;</code></td>
|
|
</tr>
|
|
</table>
|
|
<h2 class="description">Description</h2>
|
|
<h3 class="detail">Fields</h3>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="size"></span><code><strong>size</strong>: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
Size of this structure. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="no_sandbox"></span><code><strong>no_sandbox</strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
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. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="browser_subprocess_path"></span><code><strong>browser_subprocess_path</strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
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 CefExecuteProcess() for details. If this value is non-empty then it must be an absolute path. Also configurable using the "browser-subprocess-path" command-line switch. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="framework_dir_path"></span><code><strong>framework_dir_path</strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
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. If this value is non-empty then it must be an absolute path. Also configurable using the "framework-dir-path" command-line switch. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="main_bundle_path"></span><code><strong>main_bundle_path</strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
The path to the main bundle on macOS. If this value is empty then it defaults to the top-level app bundle. If this value is non-empty then it must be an absolute path. Also configurable using the "main-bundle-path" command-line switch. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="chrome_runtime"></span><code><strong>chrome_runtime</strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
Set to true (1) to enable use of the Chrome runtime in CEF. This feature is considered experimental and is not recommended for most users at this time. See issue #2969 for details. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="multi_threaded_message_loop"></span><code><strong>multi_threaded_message_loop</strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
Set to true (1) to have the browser process message loop run in a separate thread. If false (0) then the CefDoMessageLoopWork() function must be called from your application message loop. This option is only supported on Windows and Linux. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="external_message_pump"></span><code><strong>external_message_pump</strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
Set to true (1) to control browser process main (UI) thread message pump scheduling via the ICefBrowserProcessHandler.OnScheduleMessagePumpWork() callback. This option is recommended for use in combination with the CefDoMessageLoopWork() function in cases where the CEF message loop must be integrated into an existing application message loop (see additional comments and warnings on CefDoMessageLoopWork). Enabling this option is not recommended for most users; leave this option disabled and use either the CefRunMessageLoop() function or multi_threaded_message_loop if possible. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="windowless_rendering_enabled"></span><code><strong>windowless_rendering_enabled</strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
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. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="command_line_args_disabled"></span><code><strong>command_line_args_disabled</strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
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 ICefApp.OnBeforeCommandLineProcessing() method. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="cache_path"></span><code><strong>cache_path</strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
The directory where data for the global browser cache will be stored on disk. If this value is non-empty then it must be an absolute path that is either equal to or a child directory of CefSettings.root_cache_path. If this value is empty then browsers will be created in "incognito mode" where in-memory caches are used for storage and no profile-specific data is persisted to disk (installation-specific data will still be persisted in root_cache_path). HTML5 databases such as localStorage will only persist across sessions if a cache path is specified. Can be overridden for individual ICefRequestContext instances via the ICefRequestContextSettings.cache_path value. When using the Chrome runtime any child directory value will be ignored and the "default" profile (also a child directory) will be used instead. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="root_cache_path"></span><code><strong>root_cache_path</strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
|
|
|
|
<p>The root directory for installation-specific data and the parent directory for profile-specific data. All TCefSettings.cache_path and ICefRequestContextSettings.cache_path values must have this parent directory in common. If this value is empty and TCefSettings.cache_path is non-empty then it will default to the TCefSettings.cache_path value. Any non-empty value must be an absolute path. If both values are empty then the default platform-specific directory will be used ("~/.config/cef_user_data" directory on Linux, "~/Library/Application Support/CEF/User Data" directory on MacOS, "AppData\Local\CEF\User Data" directory under the user profile directory on Windows). Use of the default directory is not recommended in production applications (see below).
|
|
|
|
<p>Multiple application instances writing to the same root_cache_path directory could result in data corruption. A process singleton lock based on the root_cache_path value is therefore used to protect against this. This singleton behavior applies to all CEF-based applications using version 120 or newer. You should customize root_cache_path for your application and implement ICefBrowserProcessHandler.OnAlreadyRunningAppRelaunch, which will then be called on any app relaunch with the same root_cache_path value.
|
|
|
|
<p>Failure to set the root_cache_path value correctly may result in startup crashes or other unexpected behaviors (for example, the sandbox blocking read/write access to certain files).
|
|
|
|
<p></p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="persist_session_cookies"></span><code><strong>persist_session_cookies</strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
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 |cache_path| value must also be specified to enable this feature. Also configurable using the "persist-session-cookies" command-line switch. Can be overridden for individual CefRequestContext instances via the TCefRequestContextSettings.persist_session_cookies value. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="persist_user_preferences"></span><code><strong>persist_user_preferences</strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
To persist user preferences as a JSON file in the cache path directory set this value to true (1). A |cache_path| value must also be specified to enable this feature. Also configurable using the "persist-user-preferences" command-line switch. Can be overridden for individual CefRequestContext instances via the TCefRequestContextSettings.persist_user_preferences value. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="user_agent"></span><code><strong>user_agent</strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
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. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="user_agent_product"></span><code><strong>user_agent_product</strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
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 "user-agent-product" command-line switch. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="locale"></span><code><strong>locale</strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
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. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="log_file"></span><code><strong>log_file</strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
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 MacOS 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. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="log_severity"></span><code><strong>log_severity</strong>: <a href="uCEFTypes.html#TCefLogSeverity">TCefLogSeverity</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
The log severity. Only messages of this severity level or higher will be logged. When set to DISABLE no messages will be written to the log file, but FATAL messages will still be output to stderr. Also configurable using the "log-severity" command-line switch with a value of "verbose", "info", "warning", "error", "fatal" or "disable". </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="log_items"></span><code><strong>log_items</strong>: <a href="uCEFTypes.html#TCefLogItems">TCefLogItems</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
The log items prepended to each log line. If not set the default log items will be used. Also configurable using the "log-items" command-line switch with a value of "none" for no log items, or a comma-delimited list of values "pid", "tid", "timestamp" or "tickcount" for custom log items. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="javascript_flags"></span><code><strong>javascript_flags</strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
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. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="resources_dir_path"></span><code><strong>resources_dir_path</strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
The fully qualified path for the resources directory. If this value is empty the *.pak files must be located in the module directory on Windows/Linux or the app bundle Resources directory on MacOS. If this value is non-empty then it must be an absolute path. Also configurable using the "resources-dir-path" command-line switch. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="locales_dir_path"></span><code><strong>locales_dir_path</strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
The fully qualified path for the locales directory. If this value is empty the locales directory must be located in the module directory. If this value is non-empty then it must be an absolute path. This value is ignored on MacOS where pack files are always loaded from the app bundle Resources directory. Also configurable using the "locales-dir-path" command-line switch. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="pack_loading_disabled"></span><code><strong>pack_loading_disabled</strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
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 ICefApp.GetResourceBundleHandler() if loading of pack files is disabled. Also configurable using the "disable-pack-loading" command- line switch. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="remote_debugging_port"></span><code><strong>remote_debugging_port</strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
Set to a value between 1024 and 65535 to enable remote debugging on the specified port. Also configurable using the "remote-debugging-port" command-line switch. Specifying 0 via the command-line switch will result in the selection of an ephemeral port and the port number will be printed as part of the WebSocket endpoint URL to stderr. If a cache directory path is provided the port will also be written to the <cache-dir>/DevToolsActivePort file. Remote debugging can be accessed by loading the <a href="chrome://inspect">chrome://inspect</a> page in Google Chrome. Port numbers 9222 and 9229 are discoverable by default. Other port numbers may need to be configured via "Discover network targets" on the Devices tab. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="uncaught_exception_stack_size"></span><code><strong>uncaught_exception_stack_size</strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
The number of stack trace frames to capture for uncaught exceptions. Specify a positive value to enable the ICefRenderProcessHandler.OnUncaughtException() callback. Specify 0 (default value) and OnUncaughtException() will not be called. Also configurable using the "uncaught-exception-stack-size" command-line switch. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="background_color"></span><code><strong>background_color</strong>: <a href="uCEFTypes.html#TCefColor">TCefColor</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
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. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="accept_language_list"></span><code><strong>accept_language_list</strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
Comma delimited ordered list of language codes without any whitespace that will be used in the "Accept-Language" HTTP request header and "navigator.language" JS attribute. Can be overridden for individual ICefRequestContext instances via the TCefRequestContextSettingsCefRequestContextSettings.accept_language_list value. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="cookieable_schemes_list"></span><code><strong>cookieable_schemes_list</strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
Comma delimited list of schemes supported by the associated ICefCookieManager. If |cookieable_schemes_exclude_defaults| is false (0) the default schemes ("http", "https", "ws" and "wss") will also be supported. Not specifying a |cookieable_schemes_list| value and setting |cookieable_schemes_exclude_defaults| to true (1) will disable all loading and saving of cookies. These settings will only impact the global ICefRequestContext. Individual ICefRequestContext instances can be configured via the TCefRequestContextSettings.cookieable_schemes_list and TCefRequestContextSettings.cookieable_schemes_exclude_defaults values. </p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="cookieable_schemes_exclude_defaults"></span><code><strong>cookieable_schemes_exclude_defaults</strong>: integer;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p class="nodescription">This item has no description.</p></td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="chrome_policy_id"></span><code><strong>chrome_policy_id</strong>: <a href="uCEFTypes.html#TCefString">TCefString</a>;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
|
|
|
|
<p>Specify an ID to enable Chrome policy management via Platform and OS-user policies. On Windows, this is a registry key like "SOFTWARE\\Policies\\Google\\Chrome". On MacOS, this is a bundle ID like "com.google.Chrome". On Linux, this is an absolute directory path like "/etc/opt/chrome/policies". Only supported with the Chrome runtime. See <a href="https://support.google.com/chrome/a/answer/9037717">https://support.google.com/chrome/a/answer/9037717</a> for details.
|
|
|
|
<p>Chrome Browser Cloud Management integration, when enabled via the "enable-chrome-browser-cloud-management" command-line flag, will also use the specified ID. See <a href="https://support.google.com/chrome/a/answer/9116814">https://support.google.com/chrome/a/answer/9116814</a> for details.
|
|
|
|
<p></p>
|
|
</td></tr>
|
|
</table>
|
|
<table class="detail wide_list">
|
|
<tr class="list">
|
|
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
|
|
<td class="itemcode"><span id="chrome_app_icon_id"></span><code><strong>chrome_app_icon_id</strong>: Integer;</code></td>
|
|
</tr>
|
|
<tr><td colspan="2">
|
|
<p>
|
|
Specify an ID for an ICON resource that can be loaded from the main executable and used when creating default Chrome windows such as DevTools and Task Manager. If unspecified the default Chromium ICON (IDR_MAINFRAME [101]) will be loaded from libcef.dll. Only supported with the Chrome runtime on Windows. </p>
|
|
</td></tr>
|
|
</table>
|
|
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0-snapshot</a>. </em>
|
|
</span>
|
|
</body></html>
|