The OpenD Programming Language

cef_dictionary_value_t

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

version(cef && embedded_cef_bindings)
extern (C)
struct cef_dictionary_value_t {}

Members

Variables

base
cef_base_ref_counted_t base;

Base structure.

clear
int function(cef_dictionary_value_t* self) nothrow clear;

Removes all values. Returns true (1) on success.

copy
cef_dictionary_value_t* function(cef_dictionary_value_t* self, int exclude_empty_children) nothrow copy;

Returns a writable copy of this object. If |exclude_NULL_children| is true (1) any NULL dictionaries or lists will be excluded from the copy.

get_binary
cef_binary_value_t* function(cef_dictionary_value_t* self, const(cef_string_t)* key) nothrow get_binary;

Returns the value at the specified key as type binary. The returned value will reference existing data.

get_bool
int function(cef_dictionary_value_t* self, const(cef_string_t)* key) nothrow get_bool;

Returns the value at the specified key as type bool.

get_dictionary
cef_dictionary_value_t* function(cef_dictionary_value_t* self, const(cef_string_t)* key) nothrow get_dictionary;

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.

get_double
double function(cef_dictionary_value_t* self, const(cef_string_t)* key) nothrow get_double;

Returns the value at the specified key as type double.

get_int
int function(cef_dictionary_value_t* self, const(cef_string_t)* key) nothrow get_int;

Returns the value at the specified key as type int.

get_keys
int function(cef_dictionary_value_t* self, cef_string_list_t keys) nothrow get_keys;

Reads all keys for this dictionary into the specified vector.

get_list
cef_list_value_t* function(cef_dictionary_value_t* self, const(cef_string_t)* key) nothrow get_list;

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.

get_size
size_t function(cef_dictionary_value_t* self) nothrow get_size;

Returns the number of values.

get_string
cef_string_userfree_t function(cef_dictionary_value_t* self, const(cef_string_t)* key) nothrow get_string;

Returns the value at the specified key as type string.

get_type
cef_value_type_t function(cef_dictionary_value_t* self, const(cef_string_t)* key) nothrow get_type;

Returns the value type for the specified key.

get_value
cef_value_t* function(cef_dictionary_value_t* self, const(cef_string_t)* key) nothrow get_value;

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.

has_key
int function(cef_dictionary_value_t* self, const(cef_string_t)* key) nothrow has_key;

Returns true (1) if the current dictionary has a value for the given key.

is_equal
int function(cef_dictionary_value_t* self, cef_dictionary_value_t* that) nothrow is_equal;

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

is_owned
int function(cef_dictionary_value_t* self) nothrow is_owned;

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

is_read_only
int function(cef_dictionary_value_t* self) nothrow is_read_only;

Returns true (1) if the values of this object are read-only. Some APIs may expose read-only objects.

is_same
int function(cef_dictionary_value_t* self, cef_dictionary_value_t* that) nothrow is_same;

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.

is_valid
int function(cef_dictionary_value_t* self) nothrow is_valid;

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

remove
int function(cef_dictionary_value_t* self, const(cef_string_t)* key) nothrow remove;

Removes the value at the specified key. Returns true (1) is the value was removed successfully.

set_binary
int function(cef_dictionary_value_t* self, const(cef_string_t)* key, cef_binary_value_t* value) nothrow set_binary;

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.

set_bool
int function(cef_dictionary_value_t* self, const(cef_string_t)* key, int value) nothrow set_bool;

Sets the value at the specified key as type bool. Returns true (1) if the value was set successfully.

set_dictionary
int function(cef_dictionary_value_t* self, const(cef_string_t)* key, cef_dictionary_value_t* value) nothrow set_dictionary;

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.

set_double
int function(cef_dictionary_value_t* self, const(cef_string_t)* key, double value) nothrow set_double;

Sets the value at the specified key as type double. Returns true (1) if the value was set successfully.

set_int
int function(cef_dictionary_value_t* self, const(cef_string_t)* key, int value) nothrow set_int;

Sets the value at the specified key as type int. Returns true (1) if the value was set successfully.

set_list
int function(cef_dictionary_value_t* self, const(cef_string_t)* key, cef_list_value_t* value) nothrow set_list;

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.

set_null
int function(cef_dictionary_value_t* self, const(cef_string_t)* key) nothrow set_null;

Sets the value at the specified key as type null. Returns true (1) if the value was set successfully.

set_string
int function(cef_dictionary_value_t* self, const(cef_string_t)* key, const(cef_string_t)* value) nothrow set_string;

Sets the value at the specified key as type string. Returns true (1) if the value was set successfully.

set_value
int function(cef_dictionary_value_t* self, const(cef_string_t)* key, cef_value_t* value) nothrow set_value;

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.

Meta