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

TabControl properties. Skin childs. TabControl widget description should be here. More...

#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

TabControl properties. Skin childs. TabControl widget description should be here.

Definition at line 26 of file MyGUI_TabControl.h.


Member Typedef Documentation

Reimplemented from MyGUI::Widget.

Definition at line 35 of file MyGUI_TabControl.h.

Reimplemented from MyGUI::Widget.

Definition at line 35 of file MyGUI_TabControl.h.

Definition at line 56 of file MyGUI_TabControl.h.


Constructor & Destructor Documentation

Definition at line 20 of file MyGUI_TabControl.cpp.


Member Function Documentation

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 772 of file MyGUI_TabControl.cpp.

Definition at line 434 of file MyGUI_TabControl.cpp.

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 782 of file MyGUI_TabControl.cpp.

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 767 of file MyGUI_TabControl.cpp.

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 792 of file MyGUI_TabControl.cpp.

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

Definition at line 442 of file MyGUI_TabControl.cpp.

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

Definition at line 488 of file MyGUI_TabControl.cpp.

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

Definition at line 459 of file MyGUI_TabControl.cpp.

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 777 of file MyGUI_TabControl.cpp.

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

Reimplemented from MyGUI::IItemContainer.

Definition at line 787 of file MyGUI_TabControl.cpp.

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

Definition at line 398 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 669 of file MyGUI_TabControl.cpp.

Move all elements so specified becomes visible.

Definition at line 714 of file MyGUI_TabControl.cpp.

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

Move all elements so specified becomes visible.

Definition at line 274 of file MyGUI_TabControl.cpp.

Move all elements so first becomes visible.

Definition at line 719 of file MyGUI_TabControl.cpp.

Move all elements so last becomes visible.

Definition at line 725 of file MyGUI_TabControl.cpp.

Move all elements so selected becomes visible.

Definition at line 731 of file MyGUI_TabControl.cpp.

Clear an item data.

Definition at line 699 of file MyGUI_TabControl.cpp.

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

Clear an item data at a specified position.

Definition at line 694 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 572 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 582 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 592 of file MyGUI_TabControl.cpp.

Get button auto width flag

Definition at line 752 of file MyGUI_TabControl.cpp.

Get default button width

Definition at line 747 of file MyGUI_TabControl.cpp.

Get button width.

Definition at line 742 of file MyGUI_TabControl.cpp.

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

Get button width at a specified position.

Definition at line 518 of file MyGUI_TabControl.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 35 of file MyGUI_TabControl.h.

Get index of selected item (ITEM_NONE if none selected)

Definition at line 679 of file MyGUI_TabControl.cpp.

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

Get item from specified position.

Definition at line 530 of file MyGUI_TabControl.cpp.

Get number of items.

Definition at line 659 of file MyGUI_TabControl.cpp.

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

Get item data.

Definition at line 150 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 143 of file MyGUI_TabControl.h.

Get item index.

Definition at line 562 of file MyGUI_TabControl.cpp.

Get item name.

Definition at line 709 of file MyGUI_TabControl.cpp.

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

Get item name from specified position.

Definition at line 524 of file MyGUI_TabControl.cpp.

Get selected item (nullptr if none selected)

Definition at line 602 of file MyGUI_TabControl.cpp.

Get smooth sheets showing flag

Definition at line 762 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 35 of file MyGUI_TabControl.h.

void MyGUI::TabControl::initialiseOverride ( ) [protected, virtual]
skin clilds:
Left is child widget with type Button. Кнопка прокрутки заголовков влево.
skin clilds:
Right is child widget with type Button. Кнопка прокрутки заголовков вправо.
skin clilds:
TabItem is child widget with type Widget. Шаблон для страницы, по которому будут создаваться клиентские зоны страниц.
skin clilds:
HeaderPlace is child widget with type Widget. Место для заголовоков.
skin clilds:
Controls is child widget with type Widget. Виджет на котором должны быть расположены кнопки влево и вправо для заголовоков.
skin clilds:
Empty is child widget with type Widget. Виджет который будет показываться в месте где нет заголовков (справа от заголовков).

Reimplemented from MyGUI::Widget.

Definition at line 42 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 664 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 168 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 35 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 35 of file MyGUI_TabControl.h.

Definition at line 237 of file MyGUI_TabControl.cpp.

Definition at line 216 of file MyGUI_TabControl.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 154 of file MyGUI_TabControl.cpp.

Remove all items.

Definition at line 542 of file MyGUI_TabControl.cpp.

Remove item.

Definition at line 674 of file MyGUI_TabControl.cpp.

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

Remove item at a specified position.

Definition at line 536 of file MyGUI_TabControl.cpp.

Enable or disable button auto width

Definition at line 319 of file MyGUI_TabControl.cpp.

Set default button width and disable autowidth mode

Definition at line 311 of file MyGUI_TabControl.cpp.

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

Set button width.

Definition at line 737 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 338 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 209 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 654 of file MyGUI_TabControl.cpp.

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

Select specified _index.

Definition at line 373 of file MyGUI_TabControl.cpp.

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

Replace an item data.

Definition at line 689 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 512 of file MyGUI_TabControl.cpp.

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

Replace an item name.

Definition at line 704 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 356 of file MyGUI_TabControl.cpp.

Select item.

Definition at line 684 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 195 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 644 of file MyGUI_TabControl.cpp.

void MyGUI::TabControl::setPropertyOverride ( const std::string &  _key,
const std::string &  _value 
) [protected, virtual]
Properties:
ButtonWidth is TabControl property with type int. Ширина кнопок в заголовках в пикселях.
Properties:
ButtonAutoWidth is TabControl property with type bool. Режим автоматического вычисления ширины кнопок в заголовках.
Properties:
SmoothShow is TabControl property with type bool. Плавное переключение между закладками.

Reimplemented from MyGUI::Widget.

Definition at line 617 of file MyGUI_TabControl.cpp.

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

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 202 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 649 of file MyGUI_TabControl.cpp.

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

Enable or disable smooth sheets showing

Definition at line 757 of file MyGUI_TabControl.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 134 of file MyGUI_TabControl.cpp.

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

Definition at line 183 of file MyGUI_TabControl.cpp.

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

Definition at line 797 of file MyGUI_TabControl.cpp.


Friends And Related Function Documentation

friend class TabItem [friend]

Definition at line 33 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 224 of file MyGUI_TabControl.h.


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