Irrlicht 3D Engine
irr::gui::IGUITabControl Class Referenceabstract

A standard tab control. More...

#include <IGUITabControl.h>

+ Inheritance diagram for irr::gui::IGUITabControl:

Public Member Functions

 IGUITabControl (IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect< s32 > rectangle)
 constructor More...
 
virtual IGUITabaddTab (const wchar_t *caption, s32 id=-1)=0
 Adds a tab. More...
 
virtual void clear ()=0
 Clears the tabcontrol removing all tabs. More...
 
virtual s32 getActiveTab () const =0
 Returns which tab is currently active. More...
 
virtual IGUITabgetTab (s32 idx) const =0
 Returns a tab based on zero based index. More...
 
virtual s32 getTabAt (s32 xpos, s32 ypos) const =0
 get the the id of the tab at the given absolute coordinates More...
 
virtual s32 getTabCount () const =0
 Returns amount of tabs in the tabcontrol. More...
 
virtual s32 getTabExtraWidth () const =0
 Get the extra width added to tabs on each side of the text. More...
 
virtual s32 getTabHeight () const =0
 Get the height of the tabs. More...
 
virtual s32 getTabMaxWidth () const =0
 get the maximal width of a tab More...
 
virtual gui::EGUI_ALIGNMENT getTabVerticalAlignment () const =0
 Get the alignment of the tabs. More...
 
virtual IGUITabinsertTab (s32 idx, const wchar_t *caption, s32 id=-1)=0
 Insert the tab at the given index. More...
 
virtual void removeTab (s32 idx)=0
 Removes a tab from the tabcontrol. More...
 
virtual bool setActiveTab (s32 idx)=0
 Brings a tab to front. More...
 
virtual bool setActiveTab (IGUITab *tab)=0
 Brings a tab to front. More...
 
virtual void setTabExtraWidth (s32 extraWidth)=0
 Set the extra width added to tabs on each side of the text. More...
 
virtual void setTabHeight (s32 height)=0
 Set the height of the tabs. More...
 
virtual void setTabMaxWidth (s32 width)=0
 set the maximal width of a tab. Per default width is 0 which means "no width restriction". More...
 
virtual void setTabVerticalAlignment (gui::EGUI_ALIGNMENT alignment)=0
 Set the alignment of the tabs. More...
 
- Public Member Functions inherited from irr::gui::IGUIElement
 IGUIElement (EGUI_ELEMENT_TYPE type, IGUIEnvironment *environment, IGUIElement *parent, s32 id, const core::rect< s32 > &rectangle)
 Constructor. More...
 
virtual ~IGUIElement ()
 Destructor. More...
 
virtual void addChild (IGUIElement *child)
 Adds a GUI element as new child of this element. More...
 
virtual bool bringToFront (IGUIElement *element)
 Brings a child to front. More...
 
virtual void deserializeAttributes (io::IAttributes *in, io::SAttributeReadWriteOptions *options=0)
 Reads attributes of the scene node. More...
 
virtual void draw ()
 Draws the element and its children. More...
 
core::rect< s32getAbsoluteClippingRect () const
 Returns the visible area of the element. More...
 
core::rect< s32getAbsolutePosition () const
 Gets the absolute rectangle of this element. More...
 
virtual const core::list< IGUIElement * > & getChildren () const
 Returns list with children of this element. More...
 
virtual IGUIElementgetElementFromId (s32 id, bool searchchildren=false) const
 Finds the first element with the given id. More...
 
virtual IGUIElementgetElementFromPoint (const core::position2d< s32 > &point)
 Returns the topmost GUI element at the specific position. More...
 
virtual s32 getID () const
 Returns id. Can be used to identify the element. More...
 
virtual const c8getName () const
 Returns the name of the element. More...
 
bool getNextElement (s32 startOrder, bool reverse, bool group, IGUIElement *&first, IGUIElement *&closest, bool includeInvisible=false, bool includeDisabled=false) const
 searches elements to find the closest next element to tab to More...
 
IGUIElementgetParent () const
 Returns parent of this element. More...
 
core::rect< s32getRelativePosition () const
 Returns the relative rectangle of this element. More...
 
IGUIElementgetTabGroup ()
 Returns the container element which holds all elements in this element's tab group. More...
 
s32 getTabOrder () const
 Returns the number in the tab order sequence. More...
 
virtual const wchar_t * getText () const
 Returns caption of this element. More...
 
virtual const core::stringwgetToolTipText () const
 Returns caption of this element. More...
 
EGUI_ELEMENT_TYPE getType () const
 Returns the type of the gui element. More...
 
virtual const c8getTypeName () const
 Returns the type name of the gui element. More...
 
virtual bool hasType (EGUI_ELEMENT_TYPE type) const
 Returns true if the gui element supports the given type. More...
 
virtual bool isEnabled () const
 Returns true if element is enabled. More...
 
bool isMyChild (IGUIElement *child) const
 
bool isNotClipped () const
 Gets whether the element will ignore its parent's clipping rectangle. More...
 
virtual bool isPointInside (const core::position2d< s32 > &point) const
 Returns true if a point is within this element. More...
 
virtual bool isSubElement () const
 Returns true if this element was created as part of its parent control. More...
 
bool isTabGroup () const
 Returns true if this element is a tab group. More...
 
bool isTabStop () const
 Returns true if this element can be focused by navigating with the tab key. More...
 
virtual bool isTrulyVisible () const
 Check whether the element is truly visible, taking into accounts its parents' visibility. More...
 
virtual bool isVisible () const
 Returns true if element is visible. More...
 
virtual void move (core::position2d< s32 > absoluteMovement)
 Moves this element. More...
 
virtual bool OnEvent (const SEvent &event)
 Called if an event happened. More...
 
virtual void OnPostRender (u32 timeMs)
 animate the element and its children. More...
 
virtual void remove ()
 Removes this element from its parent. More...
 
virtual void removeChild (IGUIElement *child)
 Removes a child. More...
 
virtual bool sendToBack (IGUIElement *child)
 Moves a child to the back, so it's siblings are drawn on top of it. More...
 
virtual void serializeAttributes (io::IAttributes *out, io::SAttributeReadWriteOptions *options=0) const
 Writes attributes of the scene node. More...
 
void setAlignment (EGUI_ALIGNMENT left, EGUI_ALIGNMENT right, EGUI_ALIGNMENT top, EGUI_ALIGNMENT bottom)
 The alignment defines how the borders of this element will be positioned when the parent element is resized. More...
 
virtual void setEnabled (bool enabled)
 Sets the enabled state of this element. More...
 
virtual void setID (s32 id)
 Sets the id of this element. More...
 
void setMaxSize (core::dimension2du size)
 Sets the maximum size allowed for this element. More...
 
void setMinSize (core::dimension2du size)
 Sets the minimum size allowed for this element. More...
 
virtual void setName (const c8 *name)
 Sets the name of the element. More...
 
virtual void setName (const core::stringc &name)
 Sets the name of the element. More...
 
void setNotClipped (bool noClip)
 Sets whether the element will ignore its parent's clipping rectangle. More...
 
void setRelativePosition (const core::rect< s32 > &r)
 Sets the relative rectangle of this element. More...
 
void setRelativePosition (const core::position2di &position)
 Sets the relative rectangle of this element, maintaining its current width and height. More...
 
void setRelativePositionProportional (const core::rect< f32 > &r)
 Sets the relative rectangle of this element as a proportion of its parent's area. More...
 
virtual void setSubElement (bool subElement)
 Sets whether this control was created as part of its parent. More...
 
void setTabGroup (bool isGroup)
 Sets whether this element is a container for a group of elements which can be navigated using the tab key. More...
 
void setTabOrder (s32 index)
 Sets the priority of focus when using the tab key to navigate between a group of elements. More...
 
void setTabStop (bool enable)
 If set to true, the focus will visit this element when using the tab key to cycle through elements. More...
 
virtual void setText (const wchar_t *text)
 Sets the new caption of this element. More...
 
virtual void setToolTipText (const wchar_t *text)
 Sets the new caption of this element. More...
 
virtual void setVisible (bool visible)
 Sets the visible state of this element. More...
 
virtual void updateAbsolutePosition ()
 Updates the absolute position. More...
 
- Public Member Functions inherited from irr::IReferenceCounted
 IReferenceCounted ()
 Constructor. More...
 
virtual ~IReferenceCounted ()
 Destructor. More...
 
bool drop () const
 Drops the object. Decrements the reference counter by one. More...
 
const c8getDebugName () const
 Returns the debug name of the object. More...
 
s32 getReferenceCount () const
 Get the reference count. More...
 
void grab () const
 Grabs the object. Increments the reference counter by one. More...
 
- Public Member Functions inherited from irr::IEventReceiver
virtual ~IEventReceiver ()
 Destructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from irr::gui::IGUIElement
void addChildToEnd (IGUIElement *child)
 
void recalculateAbsolutePosition (bool recursive)
 
- Protected Member Functions inherited from irr::IReferenceCounted
void setDebugName (const c8 *newName)
 Sets the debug name of the object. More...
 
- Protected Attributes inherited from irr::gui::IGUIElement
core::rect< s32AbsoluteClippingRect
 absolute clipping rect of element More...
 
core::rect< s32AbsoluteRect
 absolute rect of element More...
 
EGUI_ALIGNMENT AlignBottom
 
EGUI_ALIGNMENT AlignLeft
 tells the element how to act when its parent is resized More...
 
EGUI_ALIGNMENT AlignRight
 
EGUI_ALIGNMENT AlignTop
 
core::list< IGUIElement * > Children
 List of all children of this element. More...
 
core::rect< s32DesiredRect
 
IGUIEnvironmentEnvironment
 GUI Environment. More...
 
s32 ID
 users can set this for identifying the element by integer More...
 
bool IsEnabled
 is enabled? More...
 
bool IsSubElement
 is a part of a larger whole and should not be serialized? More...
 
bool IsTabGroup
 tab groups are containers like windows, use ctrl+tab to navigate More...
 
bool IsTabStop
 tab stop like in windows More...
 
bool IsVisible
 is visible? More...
 
core::rect< s32LastParentRect
 for calculating the difference when resizing parent More...
 
core::dimension2du MaxSize
 maximum and minimum size of the element More...
 
core::dimension2du MinSize
 
core::stringc Name
 users can set this for identifying the element by string More...
 
bool NoClip
 does this element ignore its parent's clipping rectangle? More...
 
IGUIElementParent
 Pointer to the parent. More...
 
core::rect< s32RelativeRect
 relative rect of element More...
 
core::rect< f32ScaleRect
 relative scale of the element inside its parent More...
 
s32 TabOrder
 tab order More...
 
core::stringw Text
 caption More...
 
core::stringw ToolTipText
 tooltip More...
 
EGUI_ELEMENT_TYPE Type
 type of element More...
 

Detailed Description

A standard tab control.

This element can create the following events of type EGUI_EVENT_TYPE:
  • EGET_TAB_CHANGED

Definition at line 55 of file IGUITabControl.h.

Constructor & Destructor Documentation

◆ IGUITabControl()

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

constructor

Definition at line 60 of file IGUITabControl.h.

Member Function Documentation

◆ addTab()

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

Adds a tab.

◆ clear()

virtual void irr::gui::IGUITabControl::clear ( )
pure virtual

Clears the tabcontrol removing all tabs.

◆ getActiveTab()

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

Returns which tab is currently active.

◆ getTab()

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

Returns a tab based on zero based index.

Parameters
idxzero based index of tab. Is a value between 0 and getTabcount()-1;
Returns
Returns pointer to the Tab. Returns 0 if no tab is corresponding to this tab.

◆ getTabAt()

virtual s32 irr::gui::IGUITabControl::getTabAt ( s32  xpos,
s32  ypos 
) const
pure virtual

get the the id of the tab at the given absolute coordinates

Returns
The id of the tab or -1 when no tab is at those coordinates

◆ getTabCount()

virtual s32 irr::gui::IGUITabControl::getTabCount ( ) const
pure virtual

Returns amount of tabs in the tabcontrol.

◆ getTabExtraWidth()

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

◆ getTabHeight()

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

Get the height of the tabs.

return Returns the height of the tabs

◆ getTabMaxWidth()

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

get the maximal width of a tab

◆ getTabVerticalAlignment()

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

Get the alignment of the tabs.

return Returns the alignment of the tabs

◆ insertTab()

virtual IGUITab* irr::gui::IGUITabControl::insertTab ( s32  idx,
const wchar_t *  caption,
s32  id = -1 
)
pure virtual

Insert the tab at the given index.

Returns
The tab on success or NULL on failure.

◆ removeTab()

virtual void irr::gui::IGUITabControl::removeTab ( s32  idx)
pure virtual

Removes a tab from the tabcontrol.

◆ setActiveTab() [1/2]

virtual bool irr::gui::IGUITabControl::setActiveTab ( s32  idx)
pure virtual

Brings a tab to front.

Parameters
idxnumber of the tab.
Returns
Returns true if successful.

◆ setActiveTab() [2/2]

virtual bool irr::gui::IGUITabControl::setActiveTab ( IGUITab tab)
pure virtual

Brings a tab to front.

Parameters
tabpointer to the tab.
Returns
Returns true if successful.

◆ setTabExtraWidth()

virtual void irr::gui::IGUITabControl::setTabExtraWidth ( s32  extraWidth)
pure virtual

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

◆ setTabHeight()

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

Set the height of the tabs.

◆ setTabMaxWidth()

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".

◆ setTabVerticalAlignment()

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: