Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members | Tutorials

irr::gui::IGUITabControl Class Reference

A standard tab control. More...

#include <IGUITabControl.h>

Inheritance diagram for irr::gui::IGUITabControl:
irr::gui::IGUIElement irr::io::IAttributeExchangingObject irr::IEventReceiver irr::IReferenceCounted

List of all members.

Public Member Functions

virtual IGUITabaddTab (const wchar_t *caption, s32 id=-1)=0
 Adds a tab.
virtual s32 getActiveTab () const =0
 Returns which tab is currently active.
virtual IGUITabgetTab (s32 idx) const =0
 Returns a tab based on zero based index.
virtual s32 getTabCount () const =0
 Returns amount of tabs in the tabcontrol.
virtual s32 getTabExtraWidth () const =0
 Get the extra width added to tabs on each side of the text.
virtual s32 getTabHeight () const =0
 Get the height of the tabs.
virtual s32 getTabMaxWidth () const =0
 get the maximal width of a tab
virtual gui::EGUI_ALIGNMENT getTabVerticalAlignment () const =0
 Get the alignment of the tabs.
 IGUITabControl (IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect< s32 > rectangle)
 constructor
virtual bool setActiveTab (IGUIElement *tab)=0
 Brings a tab to front.
virtual bool setActiveTab (s32 idx)=0
 Brings a tab to front.
virtual void setTabExtraWidth (s32 extraWidth)=0
 Set the extra width added to tabs on each side of the text.
virtual void setTabHeight (s32 height)=0
 Set the height of the tabs.
virtual void setTabMaxWidth (s32 width)=0
 set the maximal width of a tab. Per default width is 0 which means "no width restriction".
virtual void setTabVerticalAlignment (gui::EGUI_ALIGNMENT alignment)=0
 Set the alignment of the tabs.

Detailed Description

A standard tab control.

Definition at line 50 of file IGUITabControl.h.


Constructor & Destructor Documentation

irr::gui::IGUITabControl::IGUITabControl ( IGUIEnvironment environment,
IGUIElement parent,
s32  id,
core::rect< s32 rectangle 
) [inline]

constructor

Definition at line 55 of file IGUITabControl.h.


Member Function Documentation

virtual IGUITab* irr::gui::IGUITabControl::addTab ( const wchar_t *  caption,
s32  id = -1 
) [pure virtual]

Adds a tab.

virtual s32 irr::gui::IGUITabControl::getActiveTab (  )  const [pure virtual]

Returns which tab is currently active.

virtual IGUITab* irr::gui::IGUITabControl::getTab ( s32  idx  )  const [pure virtual]

Returns a tab based on zero based index.

Parameters:
idx,: zero based index of tab. Is a value betwenn 0 and getTabcount()-1;
Returns:
Returns pointer to the Tab. Returns 0 if no tab is corresponding to this tab.
virtual s32 irr::gui::IGUITabControl::getTabCount (  )  const [pure virtual]

Returns amount of tabs in the tabcontrol.

virtual s32 irr::gui::IGUITabControl::getTabExtraWidth (  )  const [pure virtual]

Get the extra width added to tabs on each side of the text.

return Returns the extra width of the tabs

virtual s32 irr::gui::IGUITabControl::getTabHeight (  )  const [pure virtual]

Get the height of the tabs.

return Returns the height of the tabs

virtual s32 irr::gui::IGUITabControl::getTabMaxWidth (  )  const [pure virtual]

get the maximal width of a tab

virtual gui::EGUI_ALIGNMENT irr::gui::IGUITabControl::getTabVerticalAlignment (  )  const [pure virtual]

Get the alignment of the tabs.

return Returns the alignment of the tabs

virtual bool irr::gui::IGUITabControl::setActiveTab ( IGUIElement tab  )  [pure virtual]

Brings a tab to front.

Parameters:
tab,: pointer to the tab.
Returns:
Returns true if successful.
virtual bool irr::gui::IGUITabControl::setActiveTab ( s32  idx  )  [pure virtual]

Brings a tab to front.

Parameters:
idx,: number of the tab.
Returns:
Returns true if successful.
virtual void irr::gui::IGUITabControl::setTabExtraWidth ( s32  extraWidth  )  [pure virtual]

Set the extra width added to tabs on each side of the text.

virtual void irr::gui::IGUITabControl::setTabHeight ( s32  height  )  [pure virtual]

Set the height of the tabs.

virtual void irr::gui::IGUITabControl::setTabMaxWidth ( s32  width  )  [pure virtual]

set the maximal width of a tab. Per default width is 0 which means "no width restriction".

virtual void irr::gui::IGUITabControl::setTabVerticalAlignment ( gui::EGUI_ALIGNMENT  alignment  )  [pure virtual]

Set the alignment of the tabs.

Use EGUIA_UPPERLEFT or EGUIA_LOWERRIGHT


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

The Irrlicht Engine
The Irrlicht Engine Documentation © 2003-2010 by Nikolaus Gebhardt. Generated on Sun Oct 24 12:42:04 2010 by Doxygen (1.6.2)