A standard tab control. More...

#include <nirtcpp/core/engine/IGUITabControl.hpp>

Inheritance diagram for nirt::gui::IGUITabControl:

Collaboration diagram for nirt::gui::IGUITabControl:

Public Member Functions
	IGUITabControl (IGUIEnvironment environment, IGUIElement parent, s32 id, core::rect< s32 > rectangle)
	constructor

virtual IGUITab *	addTab (const wchar_t *caption, s32 id=-1)=0
	Adds a tab.

virtual s32	addTab (IGUITab *tab)=0
	Adds an existing tab.

virtual IGUITab *	insertTab (s32 idx, const wchar_t *caption, s32 id=-1)=0
	Insert the tab at the given index.

virtual s32	insertTab (s32 idx, IGUITab *tab, bool serializationMode=false)=0
	Insert an existing tab.

virtual void	removeTab (s32 idx)=0
	Removes a tab from the tabcontrol.

virtual void	clear ()=0
	Clears the tabcontrol removing all tabs.

virtual s32	getTabCount () const =0
	Returns amount of tabs in the tabcontrol.

virtual IGUITab *	getTab (s32 idx) const =0
	Returns a tab based on zero based index.

virtual s32	getTabIndex (const IGUIElement *tab) const =0
	For given element find if it's a tab and return it's zero-based index (or -1 for not found)

virtual bool	setActiveTab (s32 idx)=0
	Brings a tab to front.

virtual bool	setActiveTab (IGUITab *tab)=0
	Brings a tab to front.

virtual s32	getActiveTab () const =0
	Returns which tab is currently active.

virtual s32	getTabAt (s32 xpos, s32 ypos) const =0
	get the the id of the tab at the given absolute coordinates

virtual void	setTabHeight (s32 height)=0
	Set the height of the tabs.

virtual s32	getTabHeight () const =0
	Get 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 s32	getTabMaxWidth () const =0
	get the maximal width of a tab

virtual void	setTabVerticalAlignment (gui::EGUI_ALIGNMENT alignment)=0
	Set the alignment of the tabs.

virtual gui::EGUI_ALIGNMENT	getTabVerticalAlignment () const =0
	Get the alignment of the tabs.

virtual void	setTabExtraWidth (s32 extraWidth)=0
	Set the extra width added to tabs on each side of the text.

virtual s32	getTabExtraWidth () const =0
	Get the extra width added to tabs on each side of the text.

Public Member Functions inherited from nirt::gui::IGUIElement
	IGUIElement (EGUI_ELEMENT_TYPE type, IGUIEnvironment environment, IGUIElement parent, s32 id, const core::rect< s32 > &rectangle)
	Constructor.

virtual	~IGUIElement ()
	Destructor.

IGUIElement *	getParent () const
	Returns parent of this element.

core::rect< s32 >	getRelativePosition () const
	Returns the relative rectangle of this element.

void	setRelativePosition (const core::rect< s32 > &r)
	Sets the relative rectangle of this element.

void	setRelativePosition (const core::position2di &position)
	Sets the relative rectangle of this element, maintaining its current width and height.

void	setRelativePositionProportional (const core::rect< f32 > &r)
	Sets the relative rectangle of this element as a proportion of its parent's area.

core::rect< s32 >	getAbsolutePosition () const
	Gets the absolute rectangle of this element.

core::rect< s32 >	getAbsoluteClippingRect () const
	Returns the visible area of the element.

void	setNotClipped (bool noClip)
	Sets whether the element will ignore its parent's clipping rectangle.

bool	isNotClipped () const
	Gets whether the element will ignore its parent's clipping rectangle.

void	setMaxSize (core::dimension2du size)
	Sets the maximum size allowed for this element.

void	setMinSize (core::dimension2du size)
	Sets the minimum size allowed for this element.

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.

EGUI_ALIGNMENT	getAlignLeft () const
	How left element border is aligned when parent is resized.

EGUI_ALIGNMENT	getAlignRight () const
	How right element border is aligned when parent is resized.

EGUI_ALIGNMENT	getAlignTop () const
	How top element border is aligned when parent is resized.

EGUI_ALIGNMENT	getAlignBottom () const
	How bottom element border is aligned when parent is resized.

virtual void	updateAbsolutePosition ()
	Updates the absolute position.

virtual IGUIElement *	getElementFromPoint (const core::position2d< s32 > &point)
	Returns the topmost GUI element at the specific position.

virtual bool	isPointInside (const core::position2d< s32 > &point) const
	Returns true if a point is within this element.

virtual void	addChild (IGUIElement *child)
	Adds a GUI element as new child of this element.

virtual void	removeChild (IGUIElement *child)
	Removes a child.

virtual void	remove ()
	Removes this element from its parent.

virtual void	draw ()
	Draws the element and its children.

virtual void	OnPostRender (u32 timeMs)
	animate the element and its children.

virtual void	move (core::position2d< s32 > absoluteMovement)
	Moves this element.

virtual bool	isVisible () const
	Returns true if element is visible.

virtual bool	isTrulyVisible () const
	Check whether the element is truly visible, taking into accounts its parents' visibility.

virtual void	setVisible (bool visible)
	Sets the visible state of this element.

virtual bool	isSubElement () const
	Returns true if this element was created as part of its parent control.

virtual void	setSubElement (bool subElement)
	Sets whether this control was created as part of its parent.

void	setTabStop (bool enable)
	If set to true, the focus will visit this element when using the tab key to cycle through elements.

bool	isTabStop () const
	Returns true if this element can be focused by navigating with the tab key.

void	setTabOrder (s32 index)
	Sets the priority of focus when using the tab key to navigate between a group of elements.

s32	getTabOrder () const
	Returns the number in the tab order sequence.

void	setTabGroup (bool isGroup)
	Sets whether this element is a container for a group of elements which can be navigated using the tab key.

bool	isTabGroup () const
	Returns true if this element is a tab group.

IGUIElement *	getTabGroup ()
	Returns the container element which holds all elements in this element's tab group.

virtual bool	isEnabled () const
	Returns true if element is enabled.

virtual void	setEnabled (bool enabled)
	Sets the enabled state of this element.

virtual void	setText (const wchar_t *text)
	Sets the new caption of this element.

virtual const wchar_t *	getText () const
	Returns caption of this element.

virtual void	setToolTipText (const wchar_t *text)
	Sets the new caption of this element.

virtual const core::stringw &	getToolTipText () const
	Returns caption of this element.

virtual s32	getID () const
	Returns id. Can be used to identify the element.

virtual void	setID (s32 id)
	Sets the id of this element.

virtual bool	OnEvent (const SEvent &event) override
	Called if an event happened.

virtual bool	bringToFront (IGUIElement *element)
	Brings a child to front.

virtual bool	sendToBack (IGUIElement *child)
	Moves a child to the back, so it's siblings are drawn on top of it.

virtual const core::list< IGUIElement * > &	getChildren () const
	Returns list with children of this element.

virtual IGUIElement *	getElementFromId (s32 id, bool searchchildren=false) const
	Finds the first element with the given id.

bool	isMyChild (IGUIElement *child) const

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

EGUI_ELEMENT_TYPE	getType () const
	Returns the type of the gui element.

virtual bool	hasType (EGUI_ELEMENT_TYPE type) const
	Returns true if the gui element supports the given type.

virtual const c8 *	getTypeName () const
	Returns the type name of the gui element.

virtual const c8 *	getName () const
	Returns the name of the element.

virtual void	setName (const c8 *name)
	Sets the name of the element.

virtual void	setName (const core::stringc &name)
	Sets the name of the element.

virtual void	serializeAttributes (io::IAttributes out, io::SAttributeReadWriteOptions options=0) const override
	Writes attributes of the scene node.

virtual void	deserializeAttributes (io::IAttributes in, io::SAttributeReadWriteOptions options=0) override
	Reads attributes of the scene node.

Public Member Functions inherited from nirt::IReferenceCounted
	IReferenceCounted ()
	Constructor.

virtual	~IReferenceCounted ()
	Destructor.

void	grab () const
	Grabs the object. Increments the reference counter by one.

bool	drop () const
	Drops the object. Decrements the reference counter by one.

s32	getReferenceCount () const
	Get the reference count.

const c8 *	getDebugName () const
	Returns the debug name of the object.

Public Member Functions inherited from nirt::IEventReceiver
virtual	~IEventReceiver ()
	Destructor.

Additional Inherited Members
Protected Member Functions inherited from nirt::gui::IGUIElement
void	addChildToEnd (IGUIElement *child)

void	recalculateAbsolutePosition (bool recursive)

Protected Member Functions inherited from nirt::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object.

Protected Attributes inherited from nirt::gui::IGUIElement
core::list< IGUIElement * >	Children
	List of all children of this element.

IGUIElement *	Parent
	Pointer to the parent.

core::rect< s32 >	RelativeRect
	relative rect of element

core::rect< s32 >	AbsoluteRect
	absolute rect of element

core::rect< s32 >	AbsoluteClippingRect
	absolute clipping rect of element

core::rect< s32 >	DesiredRect

core::rect< s32 >	LastParentRect
	for calculating the difference when resizing parent

core::rect< f32 >	ScaleRect
	relative scale of the element inside its parent

core::dimension2du	MaxSize
	maximum and minimum size of the element

core::dimension2du	MinSize

bool	IsVisible
	is visible?

bool	IsEnabled
	is enabled?

bool	IsSubElement
	is a part of a larger whole and should not be serialized?

bool	NoClip
	does this element ignore its parent's clipping rectangle?

core::stringw	Text
	caption

core::stringw	ToolTipText
	tooltip

core::stringc	Name
	users can set this for identifying the element by string

s32	ID
	users can set this for identifying the element by integer

bool	IsTabStop
	tab stop like in windows

s32	TabOrder
	tab order

bool	IsTabGroup
	tab groups are containers like windows, use ctrl+tab to navigate

EGUI_ALIGNMENT	AlignLeft
	tells the element how to act when its parent is resized

EGUI_ALIGNMENT	AlignRight

EGUI_ALIGNMENT	AlignTop

EGUI_ALIGNMENT	AlignBottom

IGUIEnvironment *	Environment
	GUI Environment.

EGUI_ELEMENT_TYPE	Type
	type of element

Detailed Description

A standard tab control.

This element can create the following events of type EGUI_EVENT_TYPE:

EGET_TAB_CHANGED

Member Function Documentation

◆ addTab()

virtual s32 nirt::gui::IGUITabControl::addTab ( IGUITab * tab )

pure virtual

Adds an existing tab.

Note that it will also add the tab as a child of this TabControl.

Returns: Index of added tab or -1 for failure

◆ getTab()

virtual IGUITab * nirt::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 between 0 and getTabcount()-1;

Returns: Returns pointer to the Tab. Returns 0 if no tab is corresponding to this tab.

◆ getTabAt()

virtual s32 nirt::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

◆ getTabExtraWidth()

virtual s32 nirt::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 nirt::gui::IGUITabControl::getTabHeight ( ) const

pure virtual

Get the height of the tabs.

return Returns the height of the tabs

◆ getTabIndex()

virtual s32 nirt::gui::IGUITabControl::getTabIndex ( const IGUIElement * tab ) const

pure virtual

For given element find if it's a tab and return it's zero-based index (or -1 for not found)

Parameters

tab Tab for which we are looking (usually you will look for an IGUITab* type as only
those can be tabs, but we allow looking for any kind of IGUIElement* as there are some use-cases for that even if it just returns 0. For example this way you can check for all children of this gui-element if they are tabs or some non-tab children.

◆ getTabVerticalAlignment()

virtual gui::EGUI_ALIGNMENT nirt::gui::IGUITabControl::getTabVerticalAlignment ( ) const

pure virtual

Get the alignment of the tabs.

return Returns the alignment of the tabs

◆ insertTab() [1/2]

virtual IGUITab * nirt::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.

◆ insertTab() [2/2]

virtual s32 nirt::gui::IGUITabControl::insertTab	(	s32	idx,
		IGUITab *	tab,
		bool	serializationMode = `false`
	)

pure virtual

Insert an existing tab.

Note that it will also add the tab as a child of this TabControl.

Parameters

idx	Index at which tab will be inserted. Later tabs will be moved. Previous active tab will stay active unless this is the first element to be inserted in which case it becomes active.
tab	New tab to insert.
serializationMode	Internally used for serialization. You should not need this. When true it reserves space for the index, doesn't move but replaces tabs and it doesn't change the active tab.

Returns: Index of added tab (should be same as the one passed) or -1 for failure

◆ setActiveTab() [1/2]

virtual bool nirt::gui::IGUITabControl::setActiveTab ( IGUITab * tab )

pure virtual

Brings a tab to front.

Parameters

tab	pointer to the tab.

Returns: Returns true if successful.

◆ setActiveTab() [2/2]

virtual bool nirt::gui::IGUITabControl::setActiveTab ( s32 idx )

pure virtual

Brings a tab to front.

Parameters

idx	number of the tab.

Returns: Returns true if successful.

◆ setTabVerticalAlignment()

virtual void nirt::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:

include/nirtcpp/core/engine/IGUITabControl.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addTab()

◆ getTab()

◆ getTabAt()

◆ getTabExtraWidth()

◆ getTabHeight()

◆ getTabIndex()

◆ getTabVerticalAlignment()

◆ insertTab() [1/2]

◆ insertTab() [2/2]

◆ setActiveTab() [1/2]

◆ setActiveTab() [2/2]

◆ setTabVerticalAlignment()