MyGUI
3.2.0
|
#include <MyGUI_Gui.h>
Public Member Functions | |
Gui () | |
void | initialise (const std::string &_core="MyGUI_Core.xml") |
void | initialise (const std::string &_core, const std::string &_logFileName) |
void | shutdown () |
Widget * | createWidgetT (const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer, const std::string &_name="") |
Widget * | createWidgetT (const std::string &_type, const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_layer, const std::string &_name="") |
Widget * | createWidgetRealT (const std::string &_type, const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_layer, const std::string &_name="") |
Widget * | createWidgetRealT (const std::string &_type, const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_layer, const std::string &_name="") |
template<typename T > | |
T * | createWidget (const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer, const std::string &_name="") |
template<typename T > | |
T * | createWidget (const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_layer, const std::string &_name="") |
template<typename T > | |
T * | createWidgetReal (const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_layer, const std::string &_name="") |
template<typename T > | |
T * | createWidgetReal (const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_layer, const std::string &_name="") |
void | destroyWidget (Widget *_widget) |
void | destroyWidgets (const VectorWidgetPtr &_widgets) |
void | destroyWidgets (EnumeratorWidgetPtr &_widgets) |
Widget * | findWidgetT (const std::string &_name, bool _throw=true) |
Widget * | findWidgetT (const std::string &_name, const std::string &_prefix, bool _throw=true) |
template<typename T > | |
T * | findWidget (const std::string &_name, bool _throw=true) |
template<typename T > | |
T * | findWidget (const std::string &_name, const std::string &_prefix, bool _throw=true) |
void | destroyChildWidget (Widget *_widget) |
void | destroyAllChildWidget () |
EnumeratorWidgetPtr | getEnumerator () const |
void | frameEvent (float _time) |
void | _linkChildWidget (Widget *_widget) |
void | _unlinkChildWidget (Widget *_widget) |
Data Fields | |
EventHandle_FrameEventDelegate | eventFrameStart |
Friends | |
class | WidgetManager |
Definition at line 38 of file MyGUI_Gui.h.
MyGUI::Gui::Gui | ( | ) |
Definition at line 51 of file MyGUI_Gui.cpp.
void MyGUI::Gui::_linkChildWidget | ( | Widget * | _widget | ) |
Definition at line 289 of file MyGUI_Gui.cpp.
void MyGUI::Gui::_unlinkChildWidget | ( | Widget * | _widget | ) |
Definition at line 296 of file MyGUI_Gui.cpp.
T* MyGUI::Gui::createWidget | ( | const std::string & | _skin, |
const IntCoord & | _coord, | ||
Align | _align, | ||
const std::string & | _layer, | ||
const std::string & | _name = "" |
||
) | [inline] |
Same as Gui::createWidgetT but return T* instead of Widget*
Definition at line 84 of file MyGUI_Gui.h.
T* MyGUI::Gui::createWidget | ( | const std::string & | _skin, |
int | _left, | ||
int | _top, | ||
int | _width, | ||
int | _height, | ||
Align | _align, | ||
const std::string & | _layer, | ||
const std::string & | _name = "" |
||
) | [inline] |
Same as Gui::createWidgetT but return T* instead of Widget*
Definition at line 90 of file MyGUI_Gui.h.
T* MyGUI::Gui::createWidgetReal | ( | const std::string & | _skin, |
const FloatCoord & | _coord, | ||
Align | _align, | ||
const std::string & | _layer, | ||
const std::string & | _name = "" |
||
) | [inline] |
Same as Gui::createWidgetRealT but return T* instead of Widget*
Definition at line 96 of file MyGUI_Gui.h.
T* MyGUI::Gui::createWidgetReal | ( | const std::string & | _skin, |
float | _left, | ||
float | _top, | ||
float | _width, | ||
float | _height, | ||
Align | _align, | ||
const std::string & | _layer, | ||
const std::string & | _name = "" |
||
) | [inline] |
Same as Gui::createWidgetRealT but return T* instead of Widget*
Definition at line 102 of file MyGUI_Gui.h.
Widget * MyGUI::Gui::createWidgetRealT | ( | const std::string & | _type, |
const std::string & | _skin, | ||
const FloatCoord & | _coord, | ||
Align | _align, | ||
const std::string & | _layer, | ||
const std::string & | _name = "" |
||
) |
Create widget using coordinates relative to parent widget. see Gui::createWidgetT
Definition at line 313 of file MyGUI_Gui.cpp.
Widget * MyGUI::Gui::createWidgetRealT | ( | const std::string & | _type, |
const std::string & | _skin, | ||
float | _left, | ||
float | _top, | ||
float | _width, | ||
float | _height, | ||
Align | _align, | ||
const std::string & | _layer, | ||
const std::string & | _name = "" |
||
) |
Create widget using coordinates relative to parent. see Gui::createWidgetT
Definition at line 319 of file MyGUI_Gui.cpp.
Widget * MyGUI::Gui::createWidgetT | ( | const std::string & | _type, |
const std::string & | _skin, | ||
const IntCoord & | _coord, | ||
Align | _align, | ||
const std::string & | _layer, | ||
const std::string & | _name = "" |
||
) |
Create widget
_type | widget type |
_skin | widget skin |
_coord | int coordinates of widget (_left, _top, _width, _height) |
_align | widget align (possible values can be found in enum Align) |
_layer | layer where widget will be created (all layers usually defined in core_layer.xml file). |
_name | optional widget name (you can use it for finding widget by name later) |
Definition at line 303 of file MyGUI_Gui.cpp.
Widget * MyGUI::Gui::createWidgetT | ( | const std::string & | _type, |
const std::string & | _skin, | ||
int | _left, | ||
int | _top, | ||
int | _width, | ||
int | _height, | ||
Align | _align, | ||
const std::string & | _layer, | ||
const std::string & | _name = "" |
||
) |
Definition at line 308 of file MyGUI_Gui.cpp.
void MyGUI::Gui::destroyAllChildWidget | ( | ) |
Destroy all child widgets
Definition at line 335 of file MyGUI_Gui.cpp.
void MyGUI::Gui::destroyChildWidget | ( | Widget * | _widget | ) |
Destroy child widget or throw exception if this child widget not found
Definition at line 330 of file MyGUI_Gui.cpp.
void MyGUI::Gui::destroyWidget | ( | Widget * | _widget | ) |
Destroy any created widget
Definition at line 261 of file MyGUI_Gui.cpp.
void MyGUI::Gui::destroyWidgets | ( | const VectorWidgetPtr & | _widgets | ) |
Destroy vector of widgets
Definition at line 270 of file MyGUI_Gui.cpp.
void MyGUI::Gui::destroyWidgets | ( | EnumeratorWidgetPtr & | _widgets | ) |
Destroy Enumerator of widgets
Definition at line 276 of file MyGUI_Gui.cpp.
T* MyGUI::Gui::findWidget | ( | const std::string & | _name, |
bool | _throw = true |
||
) | [inline] |
Find widget by name and cast it to T type. If widget not found or T and found widget have different types exception will be thrown, or if the second parameter is false the nullptr pointer will be returned
Definition at line 130 of file MyGUI_Gui.h.
T* MyGUI::Gui::findWidget | ( | const std::string & | _name, |
const std::string & | _prefix, | ||
bool | _throw = true |
||
) | [inline] |
Find widget by name and prefix and cast it to T type If widget not found or T and found widget have different types cause exception, or if the second parameter is false the nullptr pointer will be returned
Definition at line 141 of file MyGUI_Gui.h.
Widget * MyGUI::Gui::findWidgetT | ( | const std::string & | _name, |
bool | _throw = true |
||
) |
Find widget by name If widget is not found the exception will be thrown, or if the second parameter is false the nullptr pointer will be returned
Definition at line 207 of file MyGUI_Gui.cpp.
Widget * MyGUI::Gui::findWidgetT | ( | const std::string & | _name, |
const std::string & | _prefix, | ||
bool | _throw = true |
||
) |
Find widget by name and prefix If widget is not found the exception will be thrown, or if the second parameter is false the nullptr pointer will be returned
Definition at line 325 of file MyGUI_Gui.cpp.
void MyGUI::Gui::frameEvent | ( | float | _time | ) |
Inject frame entered event (called be renderer, do not call it manually). This function is called every frame by renderer.
Definition at line 345 of file MyGUI_Gui.cpp.
EnumeratorWidgetPtr MyGUI::Gui::getEnumerator | ( | ) | const |
Get root widgets Enumerator
Definition at line 340 of file MyGUI_Gui.cpp.
void MyGUI::Gui::initialise | ( | const std::string & | _core = "MyGUI_Core.xml" | ) |
Initialise GUI and all GUI Managers
_core | name of core config file for MyGUI (contain main config files with skins, layers, fonts, etc.) |
_logFileName | Log file name |
Definition at line 72 of file MyGUI_Gui.cpp.
void MyGUI::Gui::initialise | ( | const std::string & | _core, |
const std::string & | _logFileName | ||
) |
Definition at line 138 of file MyGUI_Gui.cpp.
void MyGUI::Gui::shutdown | ( | ) |
Shutdown GUI and all GUI Managers
Definition at line 144 of file MyGUI_Gui.cpp.
friend class WidgetManager [friend] |
Definition at line 43 of file MyGUI_Gui.h.
Event : Multidelegate. GUI per frame call.
signature : void method(float _time)
_time | Time elapsed since last frame |
Definition at line 166 of file MyGUI_Gui.h.