Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members

FXEX::FXVariant Class Reference

Variant objects can (... More...

#include <FXVariant.h>

Inheritance diagram for FXEX::FXVariant::

FXEX::FXBaseObject FXObject List of all members.

Public Methods

 FXVariant (FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const FXVariant &v, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const bool &v, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const FXuchar &v, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const FXchar &v, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const FXushort &v, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const FXshort &v, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const FXuint &v, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const FXint &v, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const FXulong &v, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const FXlong &v, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const FXfloat &v, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const FXdouble &v, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const FXCharset &c, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const FXString &s, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const FXWString &s, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (FXObject *o, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (void *p, FXObject *tgt=NULL, FXSelector sel=0)
 FXVariant (const void *p, unsigned long size, FXObject *tgt=NULL, FXSelector sel=0)
unsigned long getSize () const
virtual void clear ()
void setType (FXint type)
FXint getType () const
FXbool isUnassigned () const
FXbool isNull () const
FXbool isBool () const
FXbool isFXuchar () const
FXbool isFXchar () const
FXbool isFXushort () const
FXbool isFXshort () const
FXbool isFXuint () const
FXbool isFXint () const
FXbool isFXfloat () const
FXbool isFXdouble () const
FXbool isFXCharset () const
FXbool isFXString () const
FXbool isFXWString () const
FXbool isFXObject () const
FXbool isPointer () const
FXbool isRaw () const
FXVariant & operator= (const FXVariant &v)
FXVariant & operator= (const bool &v)
FXVariant & operator= (const FXuchar &v)
FXVariant & operator= (const FXchar &v)
FXVariant & operator= (const FXushort &v)
FXVariant & operator= (const FXshort &v)
FXVariant & operator= (const FXuint &v)
FXVariant & operator= (const FXint &v)
FXVariant & operator= (const FXulong &v)
FXVariant & operator= (const FXlong &v)
FXVariant & operator= (const FXfloat &v)
FXVariant & operator= (const FXdouble &v)
FXVariant & operator= (const FXCharset &c)
FXVariant & operator= (const FXString &s)
FXVariant & operator= (const FXWString &s)
FXVariant & operator= (FXObject *o)
FXVariant & operator= (void *p)
void setData (const void *p, unsigned long size)
virtual bool asBool () const
virtual FXuchar asFXuchar () const
virtual FXchar asFXchar () const
virtual FXushort asFXushort () const
virtual FXshort asFXshort () const
virtual FXuint asFXuint () const
virtual FXint asFXint () const
virtual FXulong asFXulong () const
virtual FXlong asFXlong () const
virtual FXfloat asFXfloat () const
virtual FXdouble asFXdouble () const
virtual FXCharset asFXCharset () const
virtual FXString asFXString () const
virtual FXWString asFXWString () const
virtual FXObjectasFXObject () const
virtual void * asPointer () const
virtual void * asRaw () const
virtual FXuval asAddress () const
 operator bool () const
 operator FXuchar () const
 operator FXchar () const
 operator FXushort () const
 operator FXshort () const
 operator FXuint () const
 operator FXint () const
 operator FXulong () const
 operator FXlong () const
 operator FXfloat () const
 operator FXdouble () const
 operator FXCharset () const
 operator FXString () const
 operator FXWString () const
 operator FXObject * () const
 operator void * () const
FXVariant & toBool ()
FXVariant & toFXuchar ()
FXVariant & toFXchar ()
FXVariant & toFXushort ()
FXVariant & toFXshort ()
FXVariant & toFXuint ()
FXVariant & toFXint ()
FXVariant & toFXulong ()
FXVariant & toFXlong ()
FXVariant & toFXfloat ()
FXVariant & toFXdouble ()
FXVariant & toFXCharset ()
FXVariant & toFXString ()
FXVariant & toFXWString ()
FXVariant & toFXObject ()
FXVariant & toPointer ()
FXVariant & toRaw ()
FXVariant & convertTo (FXint type)
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXVariant ()

Friends

FXbool operator== (const FXVariant &v1, const FXVariant &v2)
FXbool operator!= (const FXVariant &v1, const FXVariant &v2)

Detailed Description

Variant objects can (...

its aim is to ...) be assignable to any data type. They accept ID_GET/SET events so at to make connecting to widgets/datatargets easier. FIXME: add support for FXWString

Note: we only provide a single pair of operator==/operator!= for the FXVariant type since you can always use the getType() and 'asXXXXX()' methods to get the type you want.

Definition at line 40 of file FXVariant.h.


Constructor & Destructor Documentation

FXEX::FXVariant::FXVariant FXObject * tgt = NULL,
FXSelector sel = 0
 

constructors for all the known types takes a deep copy of data type (where possible).

FXEX::FXVariant::FXVariant const FXVariant & v,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant const bool & v,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant const FXuchar & v,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant const FXchar & v,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant const FXushort & v,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant const FXshort & v,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant const FXuint & v,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant const FXint & v,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant const FXulong & v,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant const FXlong & v,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant const FXfloat & v,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant const FXdouble & v,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant const FXCharset & c,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant const FXString & s,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant const FXWString & s,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant FXObject * o,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant void * p,
FXObject * tgt = NULL,
FXSelector sel = 0
 

FXEX::FXVariant::FXVariant const void * p,
unsigned long size,
FXObject * tgt = NULL,
FXSelector sel = 0
 

virtual FXEX::FXVariant::~FXVariant [virtual]
 

destructor (& cleanup).


Member Function Documentation

unsigned long FXEX::FXVariant::getSize const
 

Return the number of bytes needed to store hold the data for the current type this will often be the natural size of the data type.

virtual void FXEX::FXVariant::clear [virtual]
 

clears/resets the contents of the variant.

void FXEX::FXVariant::setType FXint type
 

set the date type, to a specific type.

FXint FXEX::FXVariant::getType const [inline]
 

return data type.

Definition at line 107 of file FXVariant.h.

FXbool FXEX::FXVariant::isUnassigned const [inline]
 

test data type.

Definition at line 110 of file FXVariant.h.

FXbool FXEX::FXVariant::isNull const [inline]
 

Definition at line 111 of file FXVariant.h.

FXbool FXEX::FXVariant::isBool const [inline]
 

Definition at line 112 of file FXVariant.h.

FXbool FXEX::FXVariant::isFXuchar const [inline]
 

Definition at line 113 of file FXVariant.h.

FXbool FXEX::FXVariant::isFXchar const [inline]
 

Definition at line 114 of file FXVariant.h.

FXbool FXEX::FXVariant::isFXushort const [inline]
 

Definition at line 115 of file FXVariant.h.

FXbool FXEX::FXVariant::isFXshort const [inline]
 

Definition at line 116 of file FXVariant.h.

FXbool FXEX::FXVariant::isFXuint const [inline]
 

Definition at line 117 of file FXVariant.h.

FXbool FXEX::FXVariant::isFXint const [inline]
 

Definition at line 118 of file FXVariant.h.

FXbool FXEX::FXVariant::isFXfloat const [inline]
 

Definition at line 119 of file FXVariant.h.

FXbool FXEX::FXVariant::isFXdouble const [inline]
 

Definition at line 120 of file FXVariant.h.

FXbool FXEX::FXVariant::isFXCharset const [inline]
 

Definition at line 121 of file FXVariant.h.

FXbool FXEX::FXVariant::isFXString const [inline]
 

Definition at line 122 of file FXVariant.h.

FXbool FXEX::FXVariant::isFXWString const [inline]
 

Definition at line 123 of file FXVariant.h.

FXbool FXEX::FXVariant::isFXObject const [inline]
 

Definition at line 124 of file FXVariant.h.

FXbool FXEX::FXVariant::isPointer const [inline]
 

Definition at line 125 of file FXVariant.h.

FXbool FXEX::FXVariant::isRaw const [inline]
 

Definition at line 126 of file FXVariant.h.

FXVariant& FXEX::FXVariant::operator= const FXVariant & v
 

assignment operators.

FXVariant& FXEX::FXVariant::operator= const bool & v
 

FXVariant& FXEX::FXVariant::operator= const FXuchar & v
 

FXVariant& FXEX::FXVariant::operator= const FXchar & v
 

FXVariant& FXEX::FXVariant::operator= const FXushort & v
 

FXVariant& FXEX::FXVariant::operator= const FXshort & v
 

FXVariant& FXEX::FXVariant::operator= const FXuint & v
 

FXVariant& FXEX::FXVariant::operator= const FXint & v
 

FXVariant& FXEX::FXVariant::operator= const FXulong & v
 

FXVariant& FXEX::FXVariant::operator= const FXlong & v
 

FXVariant& FXEX::FXVariant::operator= const FXfloat & v
 

FXVariant& FXEX::FXVariant::operator= const FXdouble & v
 

FXVariant& FXEX::FXVariant::operator= const FXCharset & c
 

FXVariant& FXEX::FXVariant::operator= const FXString & s
 

FXVariant& FXEX::FXVariant::operator= const FXWString & s
 

FXVariant& FXEX::FXVariant::operator= FXObject * o
 

FXVariant& FXEX::FXVariant::operator= void * p
 

void FXEX::FXVariant::setData const void * p,
unsigned long size
 

copy raw data, of specified length.

virtual bool FXEX::FXVariant::asBool const [virtual]
 

Try and convert the data to something useful; returns the result Note: you may or may not get something useful out of this.

Referenced by toPointer().

virtual FXuchar FXEX::FXVariant::asFXuchar const [virtual]
 

virtual FXchar FXEX::FXVariant::asFXchar const [virtual]
 

virtual FXushort FXEX::FXVariant::asFXushort const [virtual]
 

virtual FXshort FXEX::FXVariant::asFXshort const [virtual]
 

virtual FXuint FXEX::FXVariant::asFXuint const [virtual]
 

virtual FXint FXEX::FXVariant::asFXint const [virtual]
 

virtual FXulong FXEX::FXVariant::asFXulong const [virtual]
 

virtual FXlong FXEX::FXVariant::asFXlong const [virtual]
 

virtual FXfloat FXEX::FXVariant::asFXfloat const [virtual]
 

virtual FXdouble FXEX::FXVariant::asFXdouble const [virtual]
 

virtual FXCharset FXEX::FXVariant::asFXCharset const [virtual]
 

virtual FXString FXEX::FXVariant::asFXString const [virtual]
 

virtual FXWString FXEX::FXVariant::asFXWString const [virtual]
 

virtual FXObject* FXEX::FXVariant::asFXObject const [virtual]
 

virtual void* FXEX::FXVariant::asPointer const [virtual]
 

virtual void* FXEX::FXVariant::asRaw const [virtual]
 

virtual FXuval FXEX::FXVariant::asAddress const [virtual]
 

FXEX::FXVariant::operator bool const [inline]
 

return operator() (eg: as used in 'if' conditions) FIXME: Should we throw an error if the required type is not the internal type, rather than trying to convert it to that type?

Definition at line 178 of file FXVariant.h.

FXEX::FXVariant::operator FXuchar const [inline]
 

Definition at line 179 of file FXVariant.h.

FXEX::FXVariant::operator FXchar const [inline]
 

Definition at line 180 of file FXVariant.h.

FXEX::FXVariant::operator FXushort const [inline]
 

Definition at line 181 of file FXVariant.h.

FXEX::FXVariant::operator FXshort const [inline]
 

Definition at line 182 of file FXVariant.h.

FXEX::FXVariant::operator FXuint const [inline]
 

Definition at line 183 of file FXVariant.h.

FXEX::FXVariant::operator FXint const [inline]
 

Definition at line 184 of file FXVariant.h.

FXEX::FXVariant::operator FXulong const [inline]
 

Definition at line 185 of file FXVariant.h.

FXEX::FXVariant::operator FXlong const [inline]
 

Definition at line 186 of file FXVariant.h.

FXEX::FXVariant::operator FXfloat const [inline]
 

Definition at line 187 of file FXVariant.h.

FXEX::FXVariant::operator FXdouble const [inline]
 

Definition at line 188 of file FXVariant.h.

FXEX::FXVariant::operator FXCharset const [inline]
 

Definition at line 189 of file FXVariant.h.

FXEX::FXVariant::operator FXString const [inline]
 

Definition at line 190 of file FXVariant.h.

FXEX::FXVariant::operator FXWString const [inline]
 

Definition at line 191 of file FXVariant.h.

FXEX::FXVariant::operator FXObject * const [inline]
 

Definition at line 192 of file FXVariant.h.

FXEX::FXVariant::operator void * const [inline]
 

Definition at line 193 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toBool [inline]
 

convert internal representation to different type, if possible note: this may result in loss of data.

Definition at line 199 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toFXuchar [inline]
 

Definition at line 200 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toFXchar [inline]
 

Definition at line 201 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toFXushort [inline]
 

Definition at line 202 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toFXshort [inline]
 

Definition at line 203 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toFXuint [inline]
 

Definition at line 204 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toFXint [inline]
 

Definition at line 205 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toFXulong [inline]
 

Definition at line 206 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toFXlong [inline]
 

Definition at line 207 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toFXfloat [inline]
 

Definition at line 208 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toFXdouble [inline]
 

Definition at line 209 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toFXCharset [inline]
 

Definition at line 210 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toFXString [inline]
 

Definition at line 211 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toFXWString [inline]
 

Definition at line 212 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toFXObject [inline]
 

Definition at line 213 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toPointer [inline]
 

Definition at line 214 of file FXVariant.h.

FXVariant& FXEX::FXVariant::toRaw
 

FXVariant& FXEX::FXVariant::convertTo FXint type
 

convert to a specific type.

virtual void FXEX::FXVariant::save FXStream & store const [virtual]
 

save to stream.

Reimplemented from FXEX::FXBaseObject.

virtual void FXEX::FXVariant::load FXStream & store [virtual]
 

load from stream.

Reimplemented from FXEX::FXBaseObject.


Friends And Related Function Documentation

FXbool operator== const FXVariant & v1,
const FXVariant & v2
[friend]
 

equality...

FXbool operator!= const FXVariant & v1,
const FXVariant & v2
[friend]
 

in-equality...