CEF4Delphi/docs/html/uCEFPreferenceRegistrar.TCefPreferenceRegistrarRef.html
2024-02-24 12:01:31 +01:00

53 lines
3.8 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<title>cef4delphi: uCEFPreferenceRegistrar: Class TCefPreferenceRegistrarRef</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="TCefPreferenceRegistrarRef"></span><h1 class="cio">Class TCefPreferenceRegistrarRef</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section"><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></div><div class="one_section">Fields</div><div class="one_section"><a class="section" href="#PasDoc-Methods">Methods</a></div><div class="one_section">Properties</div></div>
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="uCEFPreferenceRegistrar.html">uCEFPreferenceRegistrar</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TCefPreferenceRegistrarRef = class(<a class="normal" href="uCEFBaseScopedWrapper.TCEFBaseScopedWrapperRef.html">TCEFBaseScopedWrapperRef</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Class that manages custom preference registrations. </p>
<p>
<p>&lt;see href=&quot;<a href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_preference_capi.h">https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_preference_capi.h</a>&quot;&gt;CEF source file: /include/capi/cef_preference_capi.h (cef_preference_registrar_t))</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="ancestor"><a class="normal" href="uCEFBaseScopedWrapper.TCEFBaseScopedWrapperRef.html">TCEFBaseScopedWrapperRef</a></li>
<li class="thisitem">TCefPreferenceRegistrarRef</li></ul><h2 class="overview">Overview</h2>
<span id="PasDoc-Methods"></span><h3 class="summary">Methods</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>function <strong><a href="uCEFPreferenceRegistrar.TCefPreferenceRegistrarRef.html#AddPreference-ustring-ICefValue-">AddPreference</a></strong>(const name: <a href="uCEFTypes.html#ustring">ustring</a>; const default_value: <a href="uCEFInterfaces.ICefValue.html">ICefValue</a>): Boolean;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</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="AddPreference-ustring-ICefValue-"></span><code>function <strong>AddPreference</strong>(const name: <a href="uCEFTypes.html#ustring">ustring</a>; const default_value: <a href="uCEFInterfaces.ICefValue.html">ICefValue</a>): Boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Register a preference with the specified |name| and |default_value|. To avoid conflicts with built-in preferences the |name| value should contain an application-specific prefix followed by a period (e.g. &quot;myapp.value&quot;). The contents of |default_value| will be copied. The data type for the preference will be inferred from |default_value|'s type and cannot be changed after registration. Returns true (1) on success. Returns false (0) if |name| is already registered or if |default_value| has an invalid type. This function must be called from within the scope of the ICefBrowserProcessHandler.OnRegisterCustomPreferences callback. </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>