MyGUI  3.2.0
Data Structures | Public Types | Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Friends
MyGUI::TabControl Class Reference

#include <MyGUI_TabControl.h>

+ Inheritance diagram for MyGUI::TabControl:

Data Structures

struct  TabItemInfo

Public Types

typedef RTTIBase Base
typedef TabControl RTTIBase
typedef std::vector< TabItemInfoVectorTabItemInfo

Public Member Functions

virtual const std::string & getTypeName () const
virtual bool isType (const std::type_info &_type) const
template<typename Type >
bool isType () const
 TabControl ()
virtual void setPosition (const IntPoint &_value)
virtual void setSize (const IntSize &_value)
virtual void setCoord (const IntCoord &_value)
void setPosition (int _left, int _top)
void setSize (int _width, int _height)
void setCoord (int _left, int _top, int _width, int _height)
size_t getItemCount () const
 Get number of items.
TabIteminsertItemAt (size_t _index, const UString &_name, Any _data=Any::Null)
 Insert an item into a array at a specified position.
TabIteminsertItem (TabItem *_to, const UString &_name, Any _data=Any::Null)
 Insert an item into a array.
TabItemaddItem (const UString &_name, Any _data=Any::Null)
 Add an item to the end of a array.
void removeItemAt (size_t _index)
 Remove item at a specified position.
void removeItem (TabItem *_item)
 Remove item.
void removeAllItems ()
 Remove all items.
TabItemgetItemAt (size_t _index)
 Get item from specified position.
size_t getItemIndex (TabItem *_item)
 Get item index.
size_t findItemIndex (TabItem *_item)
 Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found.
size_t findItemIndexWith (const UString &_name)
 Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found.
TabItemfindItemWith (const UString &_name)
 Search item, returns the item of the first occurrence in array or nullptr if item not found.
void swapItems (size_t _index1, size_t _index2)
size_t getIndexSelected () const
 Get index of selected item (ITEM_NONE if none selected)
TabItemgetItemSelected ()
 Get selected item (nullptr if none selected)
void setIndexSelected (size_t _index)
 Select specified _index.
void setItemSelected (TabItem *_item)
 Select item.
void setItemDataAt (size_t _index, Any _data)
 Replace an item data at a specified position.
void setItemData (TabItem *_item, Any _data)
 Replace an item data.
void clearItemDataAt (size_t _index)
 Clear an item data at a specified position.
void clearItemData (TabItem *_item)
 Clear an item data.
template<typename ValueType >
ValueType * getItemDataAt (size_t _index, bool _throw=true)
 Get item data from specified position.
template<typename ValueType >
ValueType * getItemData (TabItem *_item, bool _throw=true)
 Get item data.
void setItemNameAt (size_t _index, const UString &_name)
 Replace an item name at a specified position.
void setItemName (TabItem *_item, const UString &_name)
 Replace an item name.
const UStringgetItemNameAt (size_t _index)
 Get item name from specified position.
const UStringgetItemName (TabItem *_item)
 Get item name.
void beginToItemAt (size_t _index)
 Move all elements so specified becomes visible.
void beginToItem (TabItem *_item)
 Move all elements so specified becomes visible.
void beginToItemFirst ()
 Move all elements so first becomes visible.
void beginToItemLast ()
 Move all elements so last becomes visible.
void beginToItemSelected ()
 Move all elements so selected becomes visible.
void setButtonWidthAt (size_t _index, int _width=DEFAULT)
 Set button width at a specified position.
void setButtonWidth (TabItem *_item, int _width=DEFAULT)
 Set button width.
int getButtonWidthAt (size_t _index)
 Get button width at a specified position.
int getButtonWidth (TabItem *_item)
 Get button width.
void setButtonDefaultWidth (int _value)
int getButtonDefaultWidth () const
void setButtonAutoWidth (bool _value)
bool getButtonAutoWidth () const
void setSmoothShow (bool _value)
bool getSmoothShow () const
virtual size_t _getItemCount ()
virtual void _addItem (const MyGUI::UString &_name)
virtual void _removeItemAt (size_t _index)
virtual Widget_getItemAt (size_t _index)
virtual void _setItemNameAt (size_t _index, const UString &_name)
virtual const UString_getItemNameAt (size_t _index)

Static Public Member Functions

static const std::string & getClassTypeName ()

Data Fields

EventPair
< EventHandle_WidgetSizeT,
EventHandle_TabPtrSizeT
eventTabChangeSelect

Protected Member Functions

virtual void initialiseOverride ()
virtual void shutdownOverride ()
void updateBar ()
void notifyPressedButtonEvent (MyGUI::Widget *_sender)
void notifyPressedBarButtonEvent (MyGUI::Widget *_sender)
int _getTextWidth (const UString &_text)
void _showItem (TabItem *_sheet, bool _show, bool _smooth)
void _createItemButton ()
void _insertItem (size_t _index, const UString &_name, TabItem *_sheet, Any _data)
void _notifyDeleteItem (TabItem *_item)
virtual void onWidgetCreated (Widget *_widget)
virtual void setPropertyOverride (const std::string &_key, const std::string &_value)

Friends

class TabItem

Detailed Description

Definition at line 38 of file MyGUI_TabControl.h.


Member Typedef Documentation

Reimplemented from MyGUI::Widget.

Definition at line 47 of file MyGUI_TabControl.h.

Reimplemented from MyGUI::Widget.

Definition at line 47 of file MyGUI_TabControl.h.

Definition at line 68 of file MyGUI_TabControl.h.


Constructor & Destructor Documentation

Definition at line 35 of file MyGUI_TabControl.cpp.


Member Function Documentation

void MyGUI::TabControl::_addItem ( const MyGUI::UString _name) [virtual]

Reimplemented from MyGUI::IItemContainer.

Definition at line 769 of file MyGUI_TabControl.cpp.

Definition at line 440 of file MyGUI_TabControl.cpp.

Widget * MyGUI::TabControl::_getItemAt ( size_t  _index) [virtual]

Reimplemented from MyGUI::IItemContainer.

Definition at line 779 of file MyGUI_TabControl.cpp.

size_t MyGUI::TabControl::_getItemCount ( ) [virtual]

Reimplemented from MyGUI::IItemContainer.

Definition at line 764 of file MyGUI_TabControl.cpp.

const UString & MyGUI::TabControl::_getItemNameAt ( size_t  _index) [virtual]

Reimplemented from MyGUI::IItemContainer.

Definition at line 789 of file MyGUI_TabControl.cpp.

int MyGUI::TabControl::_getTextWidth ( const UString _text) [protected]

Definition at line 448 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::_insertItem ( size_t  _index,
const UString _name,
TabItem _sheet,
Any  _data 
) [protected]

Definition at line 494 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::_notifyDeleteItem ( TabItem _item) [protected]

Definition at line 465 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::_removeItemAt ( size_t  _index) [virtual]

Reimplemented from MyGUI::IItemContainer.

Definition at line 774 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::_setItemNameAt ( size_t  _index,
const UString _name 
) [virtual]

Reimplemented from MyGUI::IItemContainer.

Definition at line 784 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::_showItem ( TabItem _sheet,
bool  _show,
bool  _smooth 
) [protected]

Definition at line 404 of file MyGUI_TabControl.cpp.

TabItem * MyGUI::TabControl::addItem ( const UString _name,
Any  _data = Any::Null 
)

Add an item to the end of a array.

Definition at line 666 of file MyGUI_TabControl.cpp.

Move all elements so specified becomes visible.

Definition at line 711 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::beginToItemAt ( size_t  _index)

Move all elements so specified becomes visible.

Definition at line 280 of file MyGUI_TabControl.cpp.

Move all elements so first becomes visible.

Definition at line 716 of file MyGUI_TabControl.cpp.

Move all elements so last becomes visible.

Definition at line 722 of file MyGUI_TabControl.cpp.

Move all elements so selected becomes visible.

Definition at line 728 of file MyGUI_TabControl.cpp.

Clear an item data.

Definition at line 696 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::clearItemDataAt ( size_t  _index)

Clear an item data at a specified position.

Definition at line 691 of file MyGUI_TabControl.cpp.

Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found.

Definition at line 578 of file MyGUI_TabControl.cpp.

size_t MyGUI::TabControl::findItemIndexWith ( const UString _name)

Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found.

Definition at line 588 of file MyGUI_TabControl.cpp.

Search item, returns the item of the first occurrence in array or nullptr if item not found.

Definition at line 598 of file MyGUI_TabControl.cpp.

Get button auto width flag

Definition at line 749 of file MyGUI_TabControl.cpp.

Get default button width

Definition at line 744 of file MyGUI_TabControl.cpp.

Get button width.

Definition at line 739 of file MyGUI_TabControl.cpp.

int MyGUI::TabControl::getButtonWidthAt ( size_t  _index)

Get button width at a specified position.

Definition at line 524 of file MyGUI_TabControl.cpp.

static const std::string& MyGUI::TabControl::getClassTypeName ( ) [inline, static]

Reimplemented from MyGUI::Widget.

Definition at line 47 of file MyGUI_TabControl.h.

Get index of selected item (ITEM_NONE if none selected)

Definition at line 676 of file MyGUI_TabControl.cpp.

TabItem * MyGUI::TabControl::getItemAt ( size_t  _index)

Get item from specified position.

Definition at line 536 of file MyGUI_TabControl.cpp.

Get number of items.

Definition at line 656 of file MyGUI_TabControl.cpp.

template<typename ValueType >
ValueType* MyGUI::TabControl::getItemData ( TabItem _item,
bool  _throw = true 
) [inline]

Get item data.

Definition at line 162 of file MyGUI_TabControl.h.

template<typename ValueType >
ValueType* MyGUI::TabControl::getItemDataAt ( size_t  _index,
bool  _throw = true 
) [inline]

Get item data from specified position.

Definition at line 155 of file MyGUI_TabControl.h.

Get item index.

Definition at line 568 of file MyGUI_TabControl.cpp.

Get item name.

Definition at line 706 of file MyGUI_TabControl.cpp.

const UString & MyGUI::TabControl::getItemNameAt ( size_t  _index)

Get item name from specified position.

Definition at line 530 of file MyGUI_TabControl.cpp.

Get selected item (nullptr if none selected)

Definition at line 608 of file MyGUI_TabControl.cpp.

Get smooth sheets showing flag

Definition at line 759 of file MyGUI_TabControl.cpp.

virtual const std::string& MyGUI::TabControl::getTypeName ( ) const [inline, virtual]

Get type name as string

Reimplemented from MyGUI::Widget.

Definition at line 47 of file MyGUI_TabControl.h.

void MyGUI::TabControl::initialiseOverride ( ) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 57 of file MyGUI_TabControl.cpp.

TabItem * MyGUI::TabControl::insertItem ( TabItem _to,
const UString _name,
Any  _data = Any::Null 
)

Insert an item into a array.

Definition at line 661 of file MyGUI_TabControl.cpp.

TabItem * MyGUI::TabControl::insertItemAt ( size_t  _index,
const UString _name,
Any  _data = Any::Null 
)

Insert an item into a array at a specified position.

Definition at line 174 of file MyGUI_TabControl.cpp.

template<typename Type >
bool MyGUI::TabControl::isType ( ) const [inline]

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 47 of file MyGUI_TabControl.h.

virtual bool MyGUI::TabControl::isType ( const std::type_info &  _type) const [inline, virtual]

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 47 of file MyGUI_TabControl.h.

Definition at line 243 of file MyGUI_TabControl.cpp.

Definition at line 222 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::onWidgetCreated ( Widget _widget) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 160 of file MyGUI_TabControl.cpp.

Remove all items.

Definition at line 548 of file MyGUI_TabControl.cpp.

Remove item.

Definition at line 671 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::removeItemAt ( size_t  _index)

Remove item at a specified position.

Definition at line 542 of file MyGUI_TabControl.cpp.

Enable or disable button auto width

Definition at line 325 of file MyGUI_TabControl.cpp.

Set default button width and disable autowidth mode

Definition at line 317 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setButtonWidth ( TabItem _item,
int  _width = DEFAULT 
)

Set button width.

Definition at line 734 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setButtonWidthAt ( size_t  _index,
int  _width = DEFAULT 
)

Set button width at a specified position.

Definition at line 344 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setCoord ( const IntCoord _value) [virtual]

Set widget position and size

Reimplemented from MyGUI::Widget.

Definition at line 215 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setCoord ( int  _left,
int  _top,
int  _width,
int  _height 
)

See Widget::setCoord(const IntCoord& _coord)

Reimplemented from MyGUI::Widget.

Definition at line 651 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setIndexSelected ( size_t  _index)

Select specified _index.

Definition at line 379 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setItemData ( TabItem _item,
Any  _data 
)

Replace an item data.

Definition at line 686 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setItemDataAt ( size_t  _index,
Any  _data 
)

Replace an item data at a specified position.

Definition at line 518 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setItemName ( TabItem _item,
const UString _name 
)

Replace an item name.

Definition at line 701 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setItemNameAt ( size_t  _index,
const UString _name 
)

Replace an item name at a specified position.

Definition at line 362 of file MyGUI_TabControl.cpp.

Select item.

Definition at line 681 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setPosition ( const IntPoint _value) [virtual]

Set widget position (position of left top corner)

Reimplemented from MyGUI::Widget.

Definition at line 201 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setPosition ( int  _left,
int  _top 
)

See Widget::setPosition(const IntPoint& _pos)

Reimplemented from MyGUI::Widget.

Definition at line 641 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setPropertyOverride ( const std::string &  _key,
const std::string &  _value 
) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 623 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setSize ( const IntSize _value) [virtual]

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 208 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setSize ( int  _width,
int  _height 
)

See Widget::setSize(const IntSize& _size)

Reimplemented from MyGUI::Widget.

Definition at line 646 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setSmoothShow ( bool  _value)

Enable or disable smooth sheets showing

Definition at line 754 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::shutdownOverride ( ) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 140 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::swapItems ( size_t  _index1,
size_t  _index2 
)

Definition at line 189 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::updateBar ( ) [protected]

Definition at line 794 of file MyGUI_TabControl.cpp.


Friends And Related Function Documentation

friend class TabItem [friend]

Definition at line 45 of file MyGUI_TabControl.h.


Field Documentation

Event : Active TabControl sheet changed
signature : void method(MyGUI::TabControl* _sender, size_t _index)

Parameters:
_senderwidget that called this event
_indexIndex of selected sheet

Definition at line 237 of file MyGUI_TabControl.h.


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