Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

(default)
Class CefListValue

CefBaseRefCounted
   |
   +--CefListValue

   in cef_values.h

class CefListValue
extends CefBaseRefCounted

Class representing a list value. Can be used on any process and thread.


Method Summary
 virtual bool Clear()= 0
          Removes all values.
 virtual CefRefPtr< CefListValue > Copy()= 0
          Returns a writable copy of this object.
 static CefRefPtr< CefListValue > Create()
          Creates a new object that is not owned by any other object.
 virtual CefRefPtr< CefBinaryValue > GetBinary( size_t index )= 0
          Returns the value at the specified index as type binary.
 virtual bool GetBool( size_t index )= 0
          Returns the value at the specified index as type bool.
 virtual CefRefPtr< CefDictionaryValue > GetDictionary( size_t index )= 0
          Returns the value at the specified index as type dictionary.
 virtual double GetDouble( size_t index )= 0
          Returns the value at the specified index as type double.
 virtual int GetInt( size_t index )= 0
          Returns the value at the specified index as type int.
 virtual CefRefPtr< CefListValue > GetList( size_t index )= 0
          Returns the value at the specified index as type list.
 virtual size_t GetSize()= 0
          Returns the number of values.
 virtual CefString GetString( size_t index )= 0
          Returns the value at the specified index as type string.
 virtual CefValueType GetType( size_t index )= 0
          Returns the value type at the specified index.
 virtual CefRefPtr< CefValue > GetValue( size_t index )= 0
          Returns the value at the specified index.
 virtual bool IsEqual( CefRefPtr< CefListValue > that )= 0
          Returns true if this object and |that| object have an equivalent underlying value but are not necessarily the same object.
 virtual bool IsOwned()= 0
          Returns true if this object is currently owned by another object.
 virtual bool IsReadOnly()= 0
          Returns true if the values of this object are read-only.
 virtual bool IsSame( CefRefPtr< CefListValue > that )= 0
          Returns true if this object and |that| object have the same underlying data.
 virtual bool IsValid()= 0
          Returns true if this object is valid.
 virtual bool Remove( size_t index )= 0
          Removes the value at the specified index.
 virtual bool SetBinary( size_t index, CefRefPtr< CefBinaryValue > value )= 0
          Sets the value at the specified index as type binary.
 virtual bool SetBool( size_t index, bool value )= 0
          Sets the value at the specified index as type bool.
 virtual bool SetDictionary( size_t index, CefRefPtr< CefDictionaryValue > value )= 0
          Sets the value at the specified index as type dict.
 virtual bool SetDouble( size_t index, double value )= 0
          Sets the value at the specified index as type double.
 virtual bool SetInt( size_t index, int value )= 0
          Sets the value at the specified index as type int.
 virtual bool SetList( size_t index, CefRefPtr< CefListValue > value )= 0
          Sets the value at the specified index as type list.
 virtual bool SetNull( size_t index )= 0
          Sets the value at the specified index as type null.
 virtual bool SetSize( size_t size )= 0
          Sets the number of values.
 virtual bool SetString( size_t index, const CefString& value )= 0
          Sets the value at the specified index as type string.
 virtual bool SetValue( size_t index, CefRefPtr< CefValue > value )= 0
          Sets the value at the specified index.
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef, HasAtLeastOneRef
 

Method Detail

Clear

public virtual bool Clear()= 0;
Removes all values. Returns true on success.

Copy

public virtual CefRefPtr< CefListValue > Copy()= 0;
Returns a writable copy of this object.

Create

public static CefRefPtr< CefListValue > Create();
Creates a new object that is not owned by any other object.

GetBinary

public virtual CefRefPtr< CefBinaryValue > GetBinary( size_t index )= 0;
Returns the value at the specified index as type binary. The returned value will reference existing data.

GetBool

public virtual bool GetBool( size_t index )= 0;
Returns the value at the specified index as type bool.

GetDictionary

public virtual CefRefPtr< CefDictionaryValue > GetDictionary( size_t index )= 0;
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.

GetDouble

public virtual double GetDouble( size_t index )= 0;
Returns the value at the specified index as type double.

GetInt

public virtual int GetInt( size_t index )= 0;
Returns the value at the specified index as type int.

GetList

public virtual CefRefPtr< CefListValue > GetList( size_t index )= 0;
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.

GetSize

public virtual size_t GetSize()= 0;
Returns the number of values.

GetString

public virtual CefString GetString( size_t index )= 0;
Returns the value at the specified index as type string.

GetType

public virtual CefValueType GetType( size_t index )= 0;
Returns the value type at the specified index.

GetValue

public virtual CefRefPtr< CefValue > GetValue( size_t index )= 0;
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.

IsEqual

public virtual bool IsEqual( CefRefPtr< CefListValue > that )= 0;
Returns true if this object and |that| object have an equivalent underlying value but are not necessarily the same object.

IsOwned

public virtual bool IsOwned()= 0;
Returns true if this object is currently owned by another object.

IsReadOnly

public virtual bool IsReadOnly()= 0;
Returns true if the values of this object are read-only. Some APIs may expose read-only objects.

IsSame

public virtual bool IsSame( CefRefPtr< CefListValue > that )= 0;
Returns true if this object and |that| object have the same underlying data. If true modifications to this object will also affect |that| object and vice-versa.

IsValid

public virtual bool IsValid()= 0;
Returns true 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 methods if this method returns false.

Remove

public virtual bool Remove( size_t index )= 0;
Removes the value at the specified index.

SetBinary

public virtual bool SetBinary( size_t index, CefRefPtr< CefBinaryValue > value )= 0;
Sets the value at the specified index as type binary. Returns true 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.

SetBool

public virtual bool SetBool( size_t index, bool value )= 0;
Sets the value at the specified index as type bool. Returns true if the value was set successfully.

SetDictionary

public virtual bool SetDictionary( size_t index, CefRefPtr< CefDictionaryValue > value )= 0;
Sets the value at the specified index as type dict. Returns true 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.

SetDouble

public virtual bool SetDouble( size_t index, double value )= 0;
Sets the value at the specified index as type double. Returns true if the value was set successfully.

SetInt

public virtual bool SetInt( size_t index, int value )= 0;
Sets the value at the specified index as type int. Returns true if the value was set successfully.

SetList

public virtual bool SetList( size_t index, CefRefPtr< CefListValue > value )= 0;
Sets the value at the specified index as type list. Returns true 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.

SetNull

public virtual bool SetNull( size_t index )= 0;
Sets the value at the specified index as type null. Returns true if the value was set successfully.

SetSize

public virtual bool SetSize( size_t size )= 0;
Sets the number of values. If the number of values is expanded all new value slots will default to type null. Returns true on success.

SetString

public virtual bool SetString( size_t index, const CefString& value )= 0;
Sets the value at the specified index as type string. Returns true if the value was set successfully.

SetValue

public virtual bool SetValue( size_t index, CefRefPtr< CefValue > value )= 0;
Sets the value at the specified index. Returns true 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.

 Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

Chromium Embedded Framework (CEF) Copyright © 2016 Marshall A. Greenblatt