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 CefDictionaryValue

CefBaseRefCounted
   |
   +--CefDictionaryValue

   in cef_values.h

class CefDictionaryValue
extends CefBaseRefCounted

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


Inner Classes, Typedefs, and Enums
typedef CefDictionaryValue::KeyList
          
 
Method Summary
 virtual bool Clear()= 0
          Removes all values.
 virtual CefRefPtr< CefDictionaryValue > Copy( bool exclude_empty_children )= 0
          Returns a writable copy of this object.
 static CefRefPtr< CefDictionaryValue > Create()
          Creates a new object that is not owned by any other object.
 virtual CefRefPtr< CefBinaryValue > GetBinary( const CefString& key )= 0
          Returns the value at the specified key as type binary.
 virtual bool GetBool( const CefString& key )= 0
          Returns the value at the specified key as type bool.
 virtual CefRefPtr< CefDictionaryValue > GetDictionary( const CefString& key )= 0
          Returns the value at the specified key as type dictionary.
 virtual double GetDouble( const CefString& key )= 0
          Returns the value at the specified key as type double.
 virtual int GetInt( const CefString& key )= 0
          Returns the value at the specified key as type int.
 virtual bool GetKeys( CefDictionaryValue::KeyList& keys )= 0
          Reads all keys for this dictionary into the specified vector.
 virtual CefRefPtr< CefListValue > GetList( const CefString& key )= 0
          Returns the value at the specified key as type list.
 virtual size_t GetSize()= 0
          Returns the number of values.
 virtual CefString GetString( const CefString& key )= 0
          Returns the value at the specified key as type string.
 virtual CefValueType GetType( const CefString& key )= 0
          Returns the value type for the specified key.
 virtual CefRefPtr< CefValue > GetValue( const CefString& key )= 0
          Returns the value at the specified key.
 virtual bool HasKey( const CefString& key )= 0
          Returns true if the current dictionary has a value for the given key.
 virtual bool IsEqual( CefRefPtr< CefDictionaryValue > 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< CefDictionaryValue > 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( const CefString& key )= 0
          Removes the value at the specified key.
 virtual bool SetBinary( const CefString& key, CefRefPtr< CefBinaryValue > value )= 0
          Sets the value at the specified key as type binary.
 virtual bool SetBool( const CefString& key, bool value )= 0
          Sets the value at the specified key as type bool.
 virtual bool SetDictionary( const CefString& key, CefRefPtr< CefDictionaryValue > value )= 0
          Sets the value at the specified key as type dict.
 virtual bool SetDouble( const CefString& key, double value )= 0
          Sets the value at the specified key as type double.
 virtual bool SetInt( const CefString& key, int value )= 0
          Sets the value at the specified key as type int.
 virtual bool SetList( const CefString& key, CefRefPtr< CefListValue > value )= 0
          Sets the value at the specified key as type list.
 virtual bool SetNull( const CefString& key )= 0
          Sets the value at the specified key as type null.
 virtual bool SetString( const CefString& key, const CefString& value )= 0
          Sets the value at the specified key as type string.
 virtual bool SetValue( const CefString& key, CefRefPtr< CefValue > value )= 0
          Sets the value at the specified key.
   
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< CefDictionaryValue > Copy( bool exclude_empty_children )= 0;
Returns a writable copy of this object. If |exclude_empty_children| is true any empty dictionaries or lists will be excluded from the copy.

Create

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

GetBinary

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

GetBool

public virtual bool GetBool( const CefString& key )= 0;
Returns the value at the specified key as type bool.

GetDictionary

public virtual CefRefPtr< CefDictionaryValue > GetDictionary( const CefString& key )= 0;
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.

GetDouble

public virtual double GetDouble( const CefString& key )= 0;
Returns the value at the specified key as type double.

GetInt

public virtual int GetInt( const CefString& key )= 0;
Returns the value at the specified key as type int.

GetKeys

public virtual bool GetKeys( CefDictionaryValue::KeyList& keys )= 0;
Reads all keys for this dictionary into the specified vector.

GetList

public virtual CefRefPtr< CefListValue > GetList( const CefString& key )= 0;
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.

GetSize

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

GetString

public virtual CefString GetString( const CefString& key )= 0;
Returns the value at the specified key as type string.

GetType

public virtual CefValueType GetType( const CefString& key )= 0;
Returns the value type for the specified key.

GetValue

public virtual CefRefPtr< CefValue > GetValue( const CefString& key )= 0;
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.

HasKey

public virtual bool HasKey( const CefString& key )= 0;
Returns true if the current dictionary has a value for the given key.

IsEqual

public virtual bool IsEqual( CefRefPtr< CefDictionaryValue > 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< CefDictionaryValue > 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( const CefString& key )= 0;
Removes the value at the specified key. Returns true is the value was removed successfully.

SetBinary

public virtual bool SetBinary( const CefString& key, CefRefPtr< CefBinaryValue > value )= 0;
Sets the value at the specified key 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( const CefString& key, bool value )= 0;
Sets the value at the specified key as type bool. Returns true if the value was set successfully.

SetDictionary

public virtual bool SetDictionary( const CefString& key, CefRefPtr< CefDictionaryValue > value )= 0;
Sets the value at the specified key 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( const CefString& key, double value )= 0;
Sets the value at the specified key as type double. Returns true if the value was set successfully.

SetInt

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

SetList

public virtual bool SetList( const CefString& key, CefRefPtr< CefListValue > value )= 0;
Sets the value at the specified key 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( const CefString& key )= 0;
Sets the value at the specified key as type null. Returns true if the value was set successfully.

SetString

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

SetValue

public virtual bool SetValue( const CefString& key, CefRefPtr< CefValue > value )= 0;
Sets the value at the specified key. 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