wxVariant

Implements methods from the following classes

• wxObject

Methods

• wxVariant
  Constructs a variant from a string.
• Append
  Appends a value to the list.
• Clear
  Makes the variant null by deleting the internal data and set the name to wxEmptyString.
• ClearList
  Deletes the contents of the list.
• Convert
  Retrieves and converts the value of this variant to the type that value is.
• Delete
  Deletes the zero-based item from the list.
• GetArrayString
  Returns the string array value.
• GetBool
  Returns the boolean value.
• GetCount
  Returns the number of elements in the list.
• GetData
  Returns a pointer to the internal variant data.
• GetDateTime
  Returns the date value.
• GetDouble
  Returns the floating point value.
• GetLong
  Returns the integer value.
• GetName
  Returns a constant reference to the variant name.
• GetString
  Gets the string value.
• GetType
  Returns the value type as a string.
• GetVoidPtr
  Gets the void pointer value.
• GetWxObjectPtr
  Gets the wxObject pointer value.
• Insert
  Inserts a value at the front of the list.
• IsNull
  Returns true if there is no data associated with this variant, false if there is data.
• IsType
  Returns true if type matches the type of the variant, false otherwise.
• IsValueKindOf
  Returns true if the data is derived from the class described by type, false otherwise.
• MakeNull
  Makes the variant null by deleting the internal data.
• MakeString
  Makes a string representation of the variant value (for any type).
• Member
  Returns true if value matches an element in the list.
• NullList
  Makes an empty list.
• SetData
  Sets the internal variant data, deleting the existing data if there is any.

Static Methods

wxVariant

wxVariant ( string $value, string $name=wxEmptyString )

Constructs a variant from a string.
wxVariant ( integer $value, string $name=wxEmptyString )

Constructs a variant from a long.
wxVariant ( bool $value, string $name=wxEmptyString )

Constructs a variant from a bool.
wxVariant ( float $value, string $name=wxEmptyString )

Constructs a variant from a double.
wxVariant ( , string $name=wxEmptyString )

Constructs a variant from a void pointer.
wxVariant ( wxObject &$value, string $name=wxEmptyString )

Constructs a variant from a pointer to an wxObject derived class.
wxVariant ( timestamp $val, string $name=wxEmptyString )

Constructs a variant from a wxDateTime.
wxVariant ( array $val, string $name=wxEmptyString )

Constructs a variant from a wxArrayString.
wxVariant ( wxVariant $variant )

Constructs a variant from another variant by increasing the reference count.

Append

Append ( wxVariant $value )

Appends a value to the list.

Clear

Clear ( )

Makes the variant null by deleting the internal data and set the name to wxEmptyString.

ClearList

ClearList ( )

Deletes the contents of the list.

Convert

bool Convert ( integer &$value )

Retrieves and converts the value of this variant to the type that value is.
bool Convert ( bool &$value )

Retrieves and converts the value of this variant to the type that value is.
bool Convert ( float &$value )

Retrieves and converts the value of this variant to the type that value is.
bool Convert ( timestamp &$value )

Retrieves and converts the value of this variant to the type that value is.
bool Convert ( string &$value )

Retrieves and converts the value of this variant to the type that value is.

Delete

bool Delete ( integer $item )

Deletes the zero-based item from the list.

GetArrayString

array GetArrayString ( )

Returns the string array value.

GetBool

bool GetBool ( )

Returns the boolean value.

GetCount

integer GetCount ( )

Returns the number of elements in the list.

GetData

wxVariantData& GetData ( )

Returns a pointer to the internal variant data.

GetDateTime

timestamp GetDateTime ( )

Returns the date value.

GetDouble

float GetDouble ( )

Returns the floating point value.

GetLong

integer GetLong ( )

Returns the integer value.

GetName

string GetName ( )

Returns a constant reference to the variant name.

GetString

string GetString ( )

Gets the string value.

GetType

string GetType ( )

Returns the value type as a string.

GetVoidPtr

GetVoidPtr ( )

Gets the void pointer value.

GetWxObjectPtr

wxObject& GetWxObjectPtr ( )

Gets the wxObject pointer value.

Insert

Insert ( wxVariant $value )

Inserts a value at the front of the list.

IsNull

bool IsNull ( )

Returns true if there is no data associated with this variant, false if there is data.

IsType

bool IsType ( string $type )

Returns true if type matches the type of the variant, false otherwise.

IsValueKindOf

bool IsValueKindOf ( wxClassInfo $type )

Returns true if the data is derived from the class described by type, false otherwise.

MakeNull

MakeNull ( )

Makes the variant null by deleting the internal data.

MakeString

string MakeString ( )

Makes a string representation of the variant value (for any type).

Member

bool Member ( wxVariant $value )

Returns true if value matches an element in the list.

NullList

NullList ( )

Makes an empty list.

SetData

SetData ( wxVariantData &$data )

Sets the internal variant data, deleting the existing data if there is any.