Pepper_56_C++_interfaces
Pepper_56_C++_interfaces
 All Classes Namespaces Files Functions Typedefs Enumerations Macros Groups
Public Member Functions | List of all members
pp::VarDictionary Class Reference
Inheritance diagram for pp::VarDictionary:
pp::Var

Public Member Functions

 VarDictionary ()
 Constructs a new dictionary var.
 
 VarDictionary (const Var &var)
 
 VarDictionary (const PP_Var &var)
 
 VarDictionary (const VarDictionary &other)
 Copy constructor.
 
VarDictionary & operator= (const VarDictionary &other)
 Assignment operator.
 
virtual Var & operator= (const Var &other)
 
Var Get (const Var &key) const
 
bool Set (const Var &key, const Var &value)
 
void Delete (const Var &key)
 
bool HasKey (const Var &key) const
 
VarArray GetKeys () const
 
- Public Member Functions inherited from pp::Var
 Var ()
 
 Var (Null)
 A constructor used to create a Var of type Null.
 
 Var (bool b)
 
 Var (int32_t i)
 
 Var (double d)
 
 Var (const char *utf8_str)
 A constructor used to create a UTF-8 character Var.
 
 Var (const std::string &utf8_str)
 A constructor used to create a UTF-8 character Var.
 
 Var (const pp::Resource &resource)
 A constructor used to create a resource Var.
 
 Var (PassRef, const PP_Var &var)
 
 Var (const PP_Var &var)
 A constructor that increments the reference count.
 
 Var (DontManage, const PP_Var &var)
 
 Var (const Var &other)
 A constructor for copying a Var.
 
virtual ~Var ()
 Destructor.
 
bool operator== (const Var &other) const
 
bool is_undefined () const
 
bool is_null () const
 
bool is_bool () const
 
bool is_string () const
 
bool is_object () const
 
bool is_array () const
 
bool is_dictionary () const
 
bool is_resource () const
 
bool is_int () const
 
bool is_double () const
 
bool is_number () const
 
bool is_array_buffer () const
 This function determines if this Var is an ArrayBuffer.
 
bool AsBool () const
 
int32_t AsInt () const
 
double AsDouble () const
 
std::string AsString () const
 
pp::Resource AsResource () const
 
const PP_Var & pp_var () const
 
PP_Var Detach ()
 
std::string DebugString () const
 

Additional Inherited Members

- Protected Attributes inherited from pp::Var
PP_Var var_
 
bool is_managed_
 

Constructor & Destructor Documentation

pp::VarDictionary::VarDictionary ( const Var &  var)
explicit

Constructs a VarDictionary given a var for which is_dictionary() is true. This will refer to the same dictionary var, but allow you to access methods specific to dictionary.

Parameters
[in]varA dictionary var.
pp::VarDictionary::VarDictionary ( const PP_Var &  var)
explicit

Constructs a VarDictionary given a PP_Var of type PP_VARTYPE_DICTIONARY.

Parameters
[in]varA PP_Var of type PP_VARTYPE_DICTIONARY.

Member Function Documentation

void pp::VarDictionary::Delete ( const Var &  key)

Deletes the specified key and its associated value, if the key exists.

Parameters
[in]keyA string var.
Var pp::VarDictionary::Get ( const Var &  key) const

Gets the value associated with the specified key.

Parameters
[in]keyA string var.
Returns
The value that is associated with key. If key is not a string var, or it doesn't exist in the dictionary, an undefined var is returned.
VarArray pp::VarDictionary::GetKeys ( ) const

Gets all the keys in the dictionary.

Returns
An array var which contains all the keys of the dictionary. The elements are string vars. Returns an empty array var if failed.
bool pp::VarDictionary::HasKey ( const Var &  key) const

Checks whether a key exists.

Parameters
[in]keyA string var.
Returns
A bool indicating whether the key exists.
virtual Var& pp::VarDictionary::operator= ( const Var &  other)
virtual

The Var assignment operator is overridden here so that we can check for assigning a non-dictionary var to a VarDictionary.

Parameters
[in]otherThe dictionary var to be assigned.
Returns
The resulting VarDictionary (as a Var&).

Reimplemented from pp::Var.

bool pp::VarDictionary::Set ( const Var &  key,
const Var &  value 
)

Sets the value associated with the specified key.

Parameters
[in]keyA string var. If this key hasn't existed in the dictionary, it is added and associated with value; otherwise, the previous value is replaced with value.
[in]valueThe value to set.
Returns
A bool indicating whether the operation succeeds.
The documentation for this class was generated from the following file: