kcef/dev.datlag.kcef/KCEFBuilder/Settings

Settings

data class Settings @JvmOverloads constructor(var cachePath: String? = null, var backgroundColor: CefSettings.ColorType? = null, var browserSubProcessPath: String? = null, var commandLineArgsDisabled: Boolean = false, var cookieableSchemesExcludeDefaults: Boolean = false, var cookieableSchemesList: String? = null, var javascriptFlags: String? = null, var locale: String? = null, var localesDirPath: String? = null, var logFile: String? = null, var logSeverity: KCEFBuilder.Settings.LogSeverity = LogSeverity.Default, var packLoadingDisabled: Boolean = false, var persistSessionCookies: Boolean = false, var remoteDebuggingPort: Int = 0, var resourcesDirPath: String? = null, var uncaughtExceptionStackSize: Int = 0, var userAgent: String? = null, var userAgentProduct: String? = null, var windowlessRenderingEnabled: Boolean = false, var noSandbox: Boolean = scopeCatching { JCefAppConfig.getInstance().cefSettings.no_sandbox }.getOrNull() ?: CefSettings().no_sandbox)(source)

Constructors

Settings

@JvmOverloads

constructor(cachePath: String? = null, backgroundColor: CefSettings.ColorType? = null, browserSubProcessPath: String? = null, commandLineArgsDisabled: Boolean = false, cookieableSchemesExcludeDefaults: Boolean = false, cookieableSchemesList: String? = null, javascriptFlags: String? = null, locale: String? = null, localesDirPath: String? = null, logFile: String? = null, logSeverity: KCEFBuilder.Settings.LogSeverity = LogSeverity.Default, packLoadingDisabled: Boolean = false, persistSessionCookies: Boolean = false, remoteDebuggingPort: Int = 0, resourcesDirPath: String? = null, uncaughtExceptionStackSize: Int = 0, userAgent: String? = null, userAgentProduct: String? = null, windowlessRenderingEnabled: Boolean = false, noSandbox: Boolean = scopeCatching { JCefAppConfig.getInstance().cefSettings.no_sandbox }.getOrNull() ?: CefSettings().no_sandbox)

Types

Companion

object Companion

LogSeverity

sealed interface LogSeverity

Log severity levels.

Properties

backgroundColor

var backgroundColor: CefSettings.ColorType?

Opaque background color used for accelerated content. By default the background color will be white. Only the RGB compontents of the specified value will be used. The alpha component must greater than 0 to enable use of the background color but will be otherwise ignored.

browserSubProcessPath

var browserSubProcessPath: String?

The path to a separate executable that will be launched for sub-processes. By default the browser process executable is used. See the comments on CefExecuteProcess() for details. Also configurable using the "browser-subprocess-path" command-line switch.

cachePath

var cachePath: String?

The location where cache data will be stored on disk. If empty an in-memory cache will be used for some features and a temporary disk cache for others. HTML5 databases such as localStorage will only persist across sessions if a cache path is specified.

commandLineArgsDisabled

var commandLineArgsDisabled: Boolean

Set to true 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 CefApp::OnBeforeCommandLineProcessing() method.

cookieableSchemesExcludeDefaults

var cookieableSchemesExcludeDefaults: Boolean

cookieableSchemesList

var cookieableSchemesList: String?

javascriptFlags

var javascriptFlags: String?

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.

locale

var locale: String?

The locale string that will be passed to Blink. 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.

localesDirPath

var localesDirPath: String?

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.

logFile

var logFile: String?

The directory and file name to use for the debug log. If empty, the default name of "debug.log" will be used and the file will be written to the application directory. Also configurable using the "log-file" command-line switch.

logSeverity

var logSeverity: KCEFBuilder.Settings.LogSeverity

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".

noSandbox

var noSandbox: Boolean

packLoadingDisabled

var packLoadingDisabled: Boolean

Set to true to disable loading of pack files for resources and locales. A resource bundle handler must be provided for the browser and render processes via CefApp::GetResourceBundleHandler() if loading of pack files is disabled. Also configurable using the "disable-pack-loading" command- line switch.

persistSessionCookies

var persistSessionCookies: Boolean

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. 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.

remoteDebuggingPort

var remoteDebuggingPort: Int

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.

resourcesDirPath

var resourcesDirPath: String?

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.

uncaughtExceptionStackSize

var uncaughtExceptionStackSize: Int

The number of stack trace frames to capture for uncaught exceptions. Specify a positive value to enable the CefV8ContextHandler:: OnUncaughtException() callback. Specify 0 (default value) and OnUncaughtException() will not be called. Also configurable using the "uncaught-exception-stack-size" command-line switch.

userAgent

var userAgent: String?

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.

userAgentProduct

var userAgentProduct: String?

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.

windowlessRenderingEnabled

var windowlessRenderingEnabled: Boolean

Set to true 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.

Functions

logSeverity

fun logSeverity(severity: CefSettings.LogSeverity): KCEFBuilder.Settings