cef_preference_manager_t

Type Alias cef_preference_manager_t 

Source
pub type cef_preference_manager_t = _cef_preference_manager_t;
Expand description

Manage access to preferences. Many built-in preferences are registered by Chromium. Custom preferences can be registered in cef_browser_process_handler_t::OnRegisterCustomPreferences.

NOTE: This struct is allocated DLL-side.

Aliased Type§

#[repr(C)]
pub struct cef_preference_manager_t { pub base: _cef_base_ref_counted_t, pub has_preference: Option<unsafe extern "C" fn(*mut _cef_preference_manager_t, *const _cef_string_utf16_t) -> i32>, pub get_preference: Option<unsafe extern "C" fn(*mut _cef_preference_manager_t, *const _cef_string_utf16_t) -> *mut _cef_value_t>, pub get_all_preferences: Option<unsafe extern "C" fn(*mut _cef_preference_manager_t, i32) -> *mut _cef_dictionary_value_t>, pub can_set_preference: Option<unsafe extern "C" fn(*mut _cef_preference_manager_t, *const _cef_string_utf16_t) -> i32>, pub set_preference: Option<unsafe extern "C" fn(*mut _cef_preference_manager_t, *const _cef_string_utf16_t, *mut _cef_value_t, *mut _cef_string_utf16_t) -> i32>, pub add_preference_observer: Option<unsafe extern "C" fn(*mut _cef_preference_manager_t, *const _cef_string_utf16_t, *mut _cef_preference_observer_t) -> *mut _cef_registration_t>, }

Fields§

§base: _cef_base_ref_counted_t

Base structure.

§has_preference: Option<unsafe extern "C" fn(*mut _cef_preference_manager_t, *const _cef_string_utf16_t) -> i32>

Returns true (1) if a preference with the specified |name| exists. This function must be called on the browser process UI thread.

§get_preference: Option<unsafe extern "C" fn(*mut _cef_preference_manager_t, *const _cef_string_utf16_t) -> *mut _cef_value_t>

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.

§get_all_preferences: Option<unsafe extern "C" fn(*mut _cef_preference_manager_t, i32) -> *mut _cef_dictionary_value_t>

Returns all preferences as a dictionary. If |include_defaults| 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.

§can_set_preference: Option<unsafe extern "C" fn(*mut _cef_preference_manager_t, *const _cef_string_utf16_t) -> i32>

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.

§set_preference: Option<unsafe extern "C" fn(*mut _cef_preference_manager_t, *const _cef_string_utf16_t, *mut _cef_value_t, *mut _cef_string_utf16_t) -> i32>

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.

§add_preference_observer: Option<unsafe extern "C" fn(*mut _cef_preference_manager_t, *const _cef_string_utf16_t, *mut _cef_preference_observer_t) -> *mut _cef_registration_t>

Add an observer for preference changes. |name| is the name of the preference to observe. If |name| is NULL then all preferences will be observed. Observing all preferences has performance consequences and is not recommended outside of testing scenarios. The observer will remain registered until the returned Registration object is destroyed. This function must be called on the browser process UI thread.