MyGUI  3.2.1
Public Member Functions | Data Fields
MyGUI::LayoutManager Class Reference

#include <MyGUI_LayoutManager.h>

+ Inheritance diagram for MyGUI::LayoutManager:

Public Member Functions

 LayoutManager ()
 
void initialise ()
 
void shutdown ()
 
VectorWidgetPtr loadLayout (const std::string &_file, const std::string &_prefix="", Widget *_parent=0)
 
void unloadLayout (VectorWidgetPtr &_widgets)
 
ResourceLayoutgetByName (const std::string &_name, bool _throw=true) const
 
bool isExist (const std::string &_name) const
 
const std::string & getCurrentLayout () const
 
- Public Member Functions inherited from MyGUI::Singleton< LayoutManager >
 Singleton ()
 
virtual ~Singleton ()
 
- Public Member Functions inherited from MyGUI::MemberObsolete< LayoutManager >
VectorWidgetPtr load (const std::string &_file)
 

Data Fields

EventHandle_AddUserStringDelegate eventAddUserString
 

Additional Inherited Members

- Public Types inherited from MyGUI::Singleton< LayoutManager >
typedef Singleton< LayoutManagerBase
 
- Static Public Member Functions inherited from MyGUI::Singleton< LayoutManager >
static LayoutManagergetInstance ()
 
static LayoutManagergetInstancePtr ()
 
static const char * getClassTypeName ()
 

Detailed Description

Definition at line 22 of file MyGUI_LayoutManager.h.

Constructor & Destructor Documentation

MyGUI::LayoutManager::LayoutManager ( )

Definition at line 19 of file MyGUI_LayoutManager.cpp.

Member Function Documentation

ResourceLayout * MyGUI::LayoutManager::getByName ( const std::string &  _name,
bool  _throw = true 
) const

Get ResourceLayout by name

Definition at line 86 of file MyGUI_LayoutManager.cpp.

const std::string & MyGUI::LayoutManager::getCurrentLayout ( ) const

Definition at line 105 of file MyGUI_LayoutManager.cpp.

void MyGUI::LayoutManager::initialise ( )

Definition at line 25 of file MyGUI_LayoutManager.cpp.

bool MyGUI::LayoutManager::isExist ( const std::string &  _name) const

Check if skin with specified name exist

Definition at line 110 of file MyGUI_LayoutManager.cpp.

VectorWidgetPtr MyGUI::LayoutManager::loadLayout ( const std::string &  _file,
const std::string &  _prefix = "",
Widget _parent = 0 
)

Load layout file

Parameters
_filename of layout
_prefixwill be added to all loaded widgets names
_parentwidget to load on
Returns
Return vector of pointers of loaded root widgets (root == without parents)

Definition at line 59 of file MyGUI_LayoutManager.cpp.

void MyGUI::LayoutManager::shutdown ( )

Definition at line 39 of file MyGUI_LayoutManager.cpp.

void MyGUI::LayoutManager::unloadLayout ( VectorWidgetPtr _widgets)

Unload layout (actually deletes vector of widgets returned by loadLayout)

Definition at line 81 of file MyGUI_LayoutManager.cpp.

Field Documentation

EventHandle_AddUserStringDelegate MyGUI::LayoutManager::eventAddUserString

Event : Multidelegate. UserString was added from layout.
signature : void method(MyGUI::Widget* _widget, const std::string& _key, const std::string& _value)

Parameters
_widgetWidget that got new UserString.
_keyUserString key.
_keyUserString value.
Note
Happens only when UserString was loaded from layout, but not when it was added in code.

Definition at line 56 of file MyGUI_LayoutManager.h.


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