Interface ICefListValue

Description
Hierarchy
Fields
Methods
Properties

Unit

uCEFInterfaces

Declaration

type ICefListValue = interface(ICefBaseRefCounted)

Description

Interface representing a list value. 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_list_value_t))

Hierarchy

Overview

Methods

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

Description

Methods

Public function IsValid: Boolean;

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

Attributes
GUID['{09174B9D-0CC6-4360-BBB0-3CC0117F70F6}']
Public function IsOwned: Boolean;

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

Public function IsReadOnly: Boolean;

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

Public function IsSame(const that: ICefListValue): 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: ICefListValue): 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: ICefListValue;

Returns a writable copy of this object.

Public function SetSize(size: NativeUInt): Boolean;

Sets the number of values. If the number of values is expanded all new value slots will default to type null. Returns true (1) on success.

Public function GetSize: NativeUInt;

Returns the number of values.

Public function Clear: Boolean;

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

Public function Remove(index: NativeUInt): Boolean;

Removes the value at the specified index.

Public function GetType(index: NativeUInt): TCefValueType;

Returns the value type at the specified index.

Public function GetValue(index: NativeUInt): ICefValue;

Returns the value at the specified index. 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.

Public function GetBool(index: NativeUInt): Boolean;

Returns the value at the specified index as type bool.

Public function GetInt(index: NativeUInt): Integer;

Returns the value at the specified index as type int.

Public function GetDouble(index: NativeUInt): Double;

Returns the value at the specified index as type double.

Public function GetString(index: NativeUInt): ustring;

Returns the value at the specified index as type string.

Public function GetBinary(index: NativeUInt): ICefBinaryValue;

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

Public function GetDictionary(index: NativeUInt): ICefDictionaryValue;

Returns the value at the specified index as type dictionary. The returned value will reference existing data and modifications to the value will modify this object.

Public function GetList(index: NativeUInt): ICefListValue;

Returns the value at the specified index as type list. The returned value will reference existing data and modifications to the value will modify this object.

Public function SetValue(index: NativeUInt; const value: ICefValue): Boolean;

Sets the value at the specified index. 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.

Public function SetNull(index: NativeUInt): Boolean;

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

Public function SetBool(index: NativeUInt; value: Boolean): Boolean;

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

Public function SetInt(index: NativeUInt; value: Integer): Boolean;

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

Public function SetDouble(index: NativeUInt; value: Double): Boolean;

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

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

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

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

Sets the value at the specified index 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.

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

Sets the value at the specified index 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.

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

Sets the value at the specified index 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.

Generated by PasDoc 0.16.0-snapshot.