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 CefValue

CefBaseRefCounted
   |
   +--CefValue

   in cef_values.h

class CefValue
extends CefBaseRefCounted

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


Method Summary
 virtual CefRefPtr< CefValue > Copy()= 0
          Returns a copy of this object.
 static CefRefPtr< CefValue > Create()
          Creates a new object.
 virtual CefRefPtr< CefBinaryValue > GetBinary()= 0
          Returns the underlying value as type binary.
 virtual bool GetBool()= 0
          Returns the underlying value as type bool.
 virtual CefRefPtr< CefDictionaryValue > GetDictionary()= 0
          Returns the underlying value as type dictionary.
 virtual double GetDouble()= 0
          Returns the underlying value as type double.
 virtual int GetInt()= 0
          Returns the underlying value as type int.
 virtual CefRefPtr< CefListValue > GetList()= 0
          Returns the underlying value as type list.
 virtual CefString GetString()= 0
          Returns the underlying value as type string.
 virtual CefValueType GetType()= 0
          Returns the underlying value type.
 virtual bool IsEqual( CefRefPtr< CefValue > 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 the underlying data is owned by another object.
 virtual bool IsReadOnly()= 0
          Returns true if the underlying data is read-only.
 virtual bool IsSame( CefRefPtr< CefValue > that )= 0
          Returns true if this object and |that| object have the same underlying data.
 virtual bool IsValid()= 0
          Returns true if the underlying data is valid.
 virtual bool SetBinary( CefRefPtr< CefBinaryValue > value )= 0
          Sets the underlying value as type binary.
 virtual bool SetBool( bool value )= 0
          Sets the underlying value as type bool.
 virtual bool SetDictionary( CefRefPtr< CefDictionaryValue > value )= 0
          Sets the underlying value as type dict.
 virtual bool SetDouble( double value )= 0
          Sets the underlying value as type double.
 virtual bool SetInt( int value )= 0
          Sets the underlying value as type int.
 virtual bool SetList( CefRefPtr< CefListValue > value )= 0
          Sets the underlying value as type list.
 virtual bool SetNull()= 0
          Sets the underlying value as type null.
 virtual bool SetString( const CefString& value )= 0
          Sets the underlying value as type string.
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef, HasAtLeastOneRef
 

Method Detail

Copy

public virtual CefRefPtr< CefValue > Copy()= 0;
Returns a copy of this object. The underlying data will also be copied.

Create

public static CefRefPtr< CefValue > Create();
Creates a new object.

GetBinary

public virtual CefRefPtr< CefBinaryValue > GetBinary()= 0;
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 SetValue() method instead of passing the returned reference to SetBinary().

GetBool

public virtual bool GetBool()= 0;
Returns the underlying value as type bool.

GetDictionary

public virtual CefRefPtr< CefDictionaryValue > GetDictionary()= 0;
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 SetValue() method instead of passing the returned reference to SetDictionary().

GetDouble

public virtual double GetDouble()= 0;
Returns the underlying value as type double.

GetInt

public virtual int GetInt()= 0;
Returns the underlying value as type int.

GetList

public virtual CefRefPtr< CefListValue > GetList()= 0;
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 SetValue() method instead of passing the returned reference to SetList().

GetString

public virtual CefString GetString()= 0;
Returns the underlying value as type string.

GetType

public virtual CefValueType GetType()= 0;
Returns the underlying value type.

IsEqual

public virtual bool IsEqual( CefRefPtr< CefValue > 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 the underlying data is owned by another object.

IsReadOnly

public virtual bool IsReadOnly()= 0;
Returns true if the underlying data is read-only. Some APIs may expose read-only objects.

IsSame

public virtual bool IsSame( CefRefPtr< CefValue > 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 the underlying data is valid. This will always be true 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.

SetBinary

public virtual bool SetBinary( CefRefPtr< CefBinaryValue > value )= 0;
Sets the underlying value as type binary. Returns true if the value was set successfully. This object keeps a reference to |value| and ownership of the underlying data remains unchanged.

SetBool

public virtual bool SetBool( bool value )= 0;
Sets the underlying value as type bool. Returns true if the value was set successfully.

SetDictionary

public virtual bool SetDictionary( CefRefPtr< CefDictionaryValue > value )= 0;
Sets the underlying value as type dict. Returns true if the value was set successfully. This object keeps a reference to |value| and ownership of the underlying data remains unchanged.

SetDouble

public virtual bool SetDouble( double value )= 0;
Sets the underlying value as type double. Returns true if the value was set successfully.

SetInt

public virtual bool SetInt( int value )= 0;
Sets the underlying value as type int. Returns true if the value was set successfully.

SetList

public virtual bool SetList( CefRefPtr< CefListValue > value )= 0;
Sets the underlying value as type list. Returns true if the value was set successfully. This object keeps a reference to |value| and ownership of the underlying data remains unchanged.

SetNull

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

SetString

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

 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