Interface ICefValue

Description
Hierarchy
Fields
Methods
Properties

Unit

uCEFInterfaces

Declaration

type ICefValue = interface(ICefBaseRefCounted)

Description

Interface that wraps other data value types. Complex types (binary, dictionary and list) will be referenced but not owned by this object. Can be used on any process and thread.

UNKNOWN

<see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_values_capi.h">CEF source file: /include/capi/cef_values_capi.h (cef_value_t))

Hierarchy

Overview

Methods

Public function IsValid: Boolean;
Public function IsOwned: Boolean;
Public function IsReadOnly: Boolean;
Public function IsSame(const that: ICefValue): Boolean;
Public function IsEqual(const that: ICefValue): Boolean;
Public function Copy: ICefValue;
Public function GetType: TCefValueType;
Public function GetBool: Boolean;
Public function GetInt: Integer;
Public function GetDouble: Double;
Public function GetString: ustring;
Public function GetBinary: ICefBinaryValue;
Public function GetDictionary: ICefDictionaryValue;
Public function GetList: ICefListValue;
Public function SetNull: Boolean;
Public function SetBool(value: boolean): Boolean;
Public function SetInt(value: Integer): Boolean;
Public function SetDouble(value: Double): Boolean;
Public function SetString(const value: ustring): Boolean;
Public function SetBinary(const value: ICefBinaryValue): Boolean;
Public function SetDictionary(const value: ICefDictionaryValue): Boolean;
Public function SetList(const value: ICefListValue): Boolean;

Description

Methods

Public function IsValid: Boolean;

Returns true (1) if the underlying data is valid. This will always be true (1) for simple types. For complex types (binary, dictionary and list) the underlying data may become invalid if owned by another object (e.g. list or dictionary) and that other object is then modified or destroyed. This value object can be re-used by calling Set*() even if the underlying data is invalid.

Attributes
GUID['{66F9F439-B12B-4EC3-A945-91AE4EF4D4BA}']
Public function IsOwned: Boolean;

Returns true (1) if the underlying data is owned by another object.

Public function IsReadOnly: Boolean;

Returns true (1) if the underlying data is read-only. Some APIs may expose read-only objects.

Public function IsSame(const that: ICefValue): Boolean;

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.

Public function IsEqual(const that: ICefValue): Boolean;

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

Public function Copy: ICefValue;

Returns a copy of this object. The underlying data will also be copied.

Public function GetType: TCefValueType;

Returns the underlying value type.

Public function GetBool: Boolean;

Returns the underlying value as type bool.

Public function GetInt: Integer;

Returns the underlying value as type int.

Public function GetDouble: Double;

Returns the underlying value as type double.

Public function GetString: ustring;

Returns the underlying value as type string.

Public function GetBinary: ICefBinaryValue;

Returns the underlying value as type binary. The returned reference may become invalid if the value is owned by another object or if ownership is transferred to another object in the future. To maintain a reference to the value after assigning ownership to a dictionary or list pass this object to the set_value() function instead of passing the returned reference to set_binary().

Public function GetDictionary: ICefDictionaryValue;

Returns the underlying value as type dictionary. The returned reference may become invalid if the value is owned by another object or if ownership is transferred to another object in the future. To maintain a reference to the value after assigning ownership to a dictionary or list pass this object to the set_value() function instead of passing the returned reference to set_dictionary().

Public function GetList: ICefListValue;

Returns the underlying value as type list. The returned reference may become invalid if the value is owned by another object or if ownership is transferred to another object in the future. To maintain a reference to the value after assigning ownership to a dictionary or list pass this object to the set_value() function instead of passing the returned reference to set_list().

Public function SetNull: Boolean;

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

Public function SetBool(value: boolean): Boolean;

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

Public function SetInt(value: Integer): Boolean;

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

Public function SetDouble(value: Double): Boolean;

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

Public function SetString(const value: ustring): Boolean;

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

Public function SetBinary(const value: ICefBinaryValue): Boolean;

Sets the underlying value as type binary. Returns true (1) if the value was set successfully. This object keeps a reference to |value| and ownership of the underlying data remains unchanged.

Public function SetDictionary(const value: ICefDictionaryValue): Boolean;

Sets the underlying value as type dict. Returns true (1) if the value was set successfully. This object keeps a reference to |value| and ownership of the underlying data remains unchanged.

Public function SetList(const value: ICefListValue): Boolean;

Sets the underlying value as type list. Returns true (1) if the value was set successfully. This object keeps a reference to |value| and ownership of the underlying data remains unchanged.

Generated by PasDoc 0.16.0-snapshot.