A standard tab control. More...

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

Inheritance diagram for dcpp::gui::IGUITabControl:

Collaboration diagram for dcpp::gui::IGUITabControl:

Public Member Functions
	IGUITabControl (IGUIEnvironment environment, IGUIElement parent, dcpp::int32_kt id, dcpp::nub::recti rectangle)
	constructor

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

virtual dcpp::int32_kt	addTab (IGUITab *tab)=0
	Adds an existing tab.

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

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

virtual void	removeTab (dcpp::int32_kt idx)=0
	Removes a tab from the tabcontrol.

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

virtual dcpp::int32_kt	getTabCount () const =0
	Returns amount of tabs in the tabcontrol.

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

virtual dcpp::int32_kt	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 (dcpp::int32_kt idx)=0
	Brings a tab to front.

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

virtual dcpp::int32_kt	getActiveTab () const =0
	Returns which tab is currently active.

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

virtual void	setTabHeight (dcpp::int32_kt height)=0
	Set the height of the tabs.

virtual dcpp::int32_kt	getTabHeight () const =0
	Get the height of the tabs.

virtual void	setTabMaxWidth (dcpp::int32_kt width)=0
	set the maximal width of a tab. Per default width is 0 which means "no width restriction".

virtual dcpp::int32_kt	getTabMaxWidth () const =0
	get the maximal width of a tab

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

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

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

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

Public Member Functions inherited from dcpp::gui::IGUIElement
	IGUIElement (EGUI_ELEMENT_TYPE type, IGUIEnvironment environment, IGUIElement parent, dcpp::int32_kt id, const dcpp::nub::recti &rectangle)
	Constructor.

virtual	~IGUIElement ()
	Destructor.

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

dcpp::nub::recti	getRelativePosition () const
	Returns the relative rectangle of this element.

void	setRelativePosition (const dcpp::nub::recti &r)
	Sets the relative rectangle of this element.

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

void	setRelativePositionProportional (const dcpp::nub::rectf &r)
	Sets the relative rectangle of this element as a proportion of its parent's area.

dcpp::nub::recti	getAbsolutePosition () const
	Gets the absolute rectangle of this element.

dcpp::nub::recti	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 (dcpp::nub::dimension2du size)
	Sets the maximum size allowed for this element.

void	setMinSize (dcpp::nub::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 dcpp::nub::position2di &point)
	Returns the topmost GUI element at the specific position.

virtual bool	isPointInside (const dcpp::nub::position2di &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 (dcpp::uint32_kt timeMs)
	animate the element and its children.

virtual void	move (dcpp::nub::position2di 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 (dcpp::int32_kt index)
	Sets the priority of focus when using the tab key to navigate between a group of elements.

dcpp::int32_kt	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 dcpp::nub::wstring &	getToolTipText () const
	Returns caption of this element.

virtual dcpp::int32_kt	getID () const
	Returns id. Can be used to identify the element.

virtual void	setID (dcpp::int32_kt 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 dcpp::nub::list< IGUIElement * > &	getChildren () const
	Returns list with children of this element.

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

bool	isMyChild (IGUIElement *child) const

bool	getNextElement (dcpp::int32_kt 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 dcpp::char_kt *	getTypeName () const
	Returns the type name of the gui element.

virtual const dcpp::char_kt *	getName () const
	Returns the name of the element.

virtual void	setName (const dcpp::char_kt *name)
	Sets the name of the element.

virtual void	setName (const dcpp::nub::string &name)
	Sets the name of the element.

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

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

Public Member Functions inherited from dcpp::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.

dcpp::int32_kt	getReferenceCount () const
	Get the reference count.

const dcpp::char_kt *	getDebugName () const
	Returns the debug name of the object.

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

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

void	recalculateAbsolutePosition (bool recursive)

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

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

IGUIElement *	Parent
	Pointer to the parent.

dcpp::nub::recti	RelativeRect
	relative rect of element

dcpp::nub::recti	AbsoluteRect
	absolute rect of element

dcpp::nub::recti	AbsoluteClippingRect
	absolute clipping rect of element

dcpp::nub::recti	DesiredRect

dcpp::nub::recti	LastParentRect
	for calculating the difference when resizing parent

dcpp::nub::rectf	ScaleRect
	relative scale of the element inside its parent

dcpp::nub::dimension2du	MaxSize
	maximum and minimum size of the element

dcpp::nub::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?

dcpp::nub::wstring	Text
	caption

dcpp::nub::wstring	ToolTipText
	tooltip

dcpp::nub::string	Name
	users can set this for identifying the element by string

dcpp::int32_kt	ID
	users can set this for identifying the element by integer

bool	IsTabStop
	tab stop like in windows

dcpp::int32_kt	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 dcpp::int32_kt dcpp::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 * dcpp::gui::IGUITabControl::getTab ( dcpp::int32_kt 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 dcpp::int32_kt dcpp::gui::IGUITabControl::getTabAt	(	dcpp::int32_kt	xpos,
		dcpp::int32_kt	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 dcpp::int32_kt dcpp::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 dcpp::int32_kt dcpp::gui::IGUITabControl::getTabHeight ( ) const

pure virtual

Get the height of the tabs.

return Returns the height of the tabs

◆ getTabIndex()

virtual dcpp::int32_kt dcpp::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 dcpp::gui::EGUI_ALIGNMENT dcpp::gui::IGUITabControl::getTabVerticalAlignment ( ) const

pure virtual

Get the alignment of the tabs.

return Returns the alignment of the tabs

◆ insertTab() [1/2]

virtual IGUITab * dcpp::gui::IGUITabControl::insertTab	(	dcpp::int32_kt	idx,
		const wchar_t *	caption,
		dcpp::int32_kt	id = `-1`
	)

pure virtual

Insert the tab at the given index.

Returns: The tab on success or NULL on failure.

◆ insertTab() [2/2]

virtual dcpp::int32_kt dcpp::gui::IGUITabControl::insertTab	(	dcpp::int32_kt	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 dcpp::gui::IGUITabControl::setActiveTab ( dcpp::int32_kt idx )

pure virtual

Brings a tab to front.

Parameters

idx	number of the tab.

Returns: Returns true if successful.

◆ setActiveTab() [2/2]

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

pure virtual

Brings a tab to front.

Parameters

tab	pointer to the tab.

Returns: Returns true if successful.

◆ setTabVerticalAlignment()

virtual void dcpp::gui::IGUITabControl::setTabVerticalAlignment ( dcpp::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/duckcpp/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()