MyGUI::UserData Class Reference

#include <MyGUI_WidgetUserData.h>

Inheritance diagram for MyGUI::UserData:
Inheritance graph
[legend]

Public Member Functions

 UserData ()
virtual ~UserData ()
void setUserString (const std::string &_key, const std::string &_value)
const std::string & getUserString (const std::string &_key)
bool clearUserString (const std::string &_key)
bool isUserString (const std::string &_key)
void clearUserStrings ()
void setUserData (Any _data)
template<typename ValueType >
ValueType * getUserData (bool _throw=true)
void _setInternalData (Any _data)
template<typename ValueType >
ValueType * _getInternalData (bool _throw=true)
 __declspec (deprecated("use : template <typename ValueType> ValueType * UserData::getUserData(bool _throw)")) void *getUserData()

Detailed Description

UserData is parent of Widget class. Used to store any user data and strings inside widget

Definition at line 33 of file MyGUI_WidgetUserData.h.


Constructor & Destructor Documentation

MyGUI::UserData::UserData (  )  [inline]

Definition at line 36 of file MyGUI_WidgetUserData.h.

virtual MyGUI::UserData::~UserData (  )  [inline, virtual]

Definition at line 37 of file MyGUI_WidgetUserData.h.


Member Function Documentation

MyGUI::UserData::__declspec ( deprecated("use : template <typename ValueType> ValueType * UserData::getUserData(bool _throw)")   )  [inline]
Deprecated:
"use : template <typename ValueType> ValueType * UserData::getUserData(bool _throw)"

Definition at line 103 of file MyGUI_WidgetUserData.h.

template<typename ValueType >
ValueType* MyGUI::UserData::_getInternalData ( bool  _throw = true  )  [inline]

Definition at line 95 of file MyGUI_WidgetUserData.h.

void MyGUI::UserData::_setInternalData ( Any  _data  )  [inline]

Definition at line 92 of file MyGUI_WidgetUserData.h.

bool MyGUI::UserData::clearUserString ( const std::string &  _key  )  [inline]

Delete user string

Definition at line 58 of file MyGUI_WidgetUserData.h.

void MyGUI::UserData::clearUserStrings (  )  [inline]

Delete all user strings

Definition at line 76 of file MyGUI_WidgetUserData.h.

template<typename ValueType >
ValueType* MyGUI::UserData::getUserData ( bool  _throw = true  )  [inline]

Get user data and cast it to ValueType

Definition at line 86 of file MyGUI_WidgetUserData.h.

const std::string& MyGUI::UserData::getUserString ( const std::string &  _key  )  [inline]

Get user string or "" if not found

Definition at line 46 of file MyGUI_WidgetUserData.h.

bool MyGUI::UserData::isUserString ( const std::string &  _key  )  [inline]

Return true if user string with such key exist

Definition at line 70 of file MyGUI_WidgetUserData.h.

void MyGUI::UserData::setUserData ( Any  _data  )  [inline]

Set any user data to store inside widget

Definition at line 82 of file MyGUI_WidgetUserData.h.

void MyGUI::UserData::setUserString ( const std::string &  _key,
const std::string &  _value 
) [inline]

Set user string

Definition at line 40 of file MyGUI_WidgetUserData.h.


The documentation for this class was generated from the following file:

Generated on 3 Dec 2009 for MyGUI by  doxygen 1.6.1