Default list box GUI element. More...

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

Inheritance diagram for dcpp::gui::IGUIListBox:

Collaboration diagram for dcpp::gui::IGUIListBox:

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

virtual dcpp::uint32_kt	getItemCount () const =0
	returns amount of list items

virtual const wchar_t *	getListItem (dcpp::uint32_kt id) const =0
	returns string of a list item. the may id be a value from 0 to itemCount-1

virtual dcpp::uint32_kt	addItem (const wchar_t *text, dcpp::int32_kt icon=-1)=0
	adds an list item with an icon

virtual dcpp::int32_kt	insertItem (dcpp::uint32_kt index, const wchar_t *text, dcpp::int32_kt icon=-1)=0
	Insert the item at the given index.

virtual void	setItem (dcpp::uint32_kt index, const wchar_t *text, dcpp::int32_kt icon=-1)=0
	set the item at the given index

virtual void	removeItem (dcpp::uint32_kt index)=0
	Removes an item from the list.

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

virtual dcpp::int32_kt	getIcon (dcpp::uint32_kt index) const =0
	Returns the icon of an item.

virtual void	setSpriteBank (IGUISpriteBank *bank)=0
	Sets the sprite bank which should be used to draw list icons.

virtual void	clear ()=0
	clears the list, deletes all items in the listbox

virtual dcpp::int32_kt	getSelected () const =0
	returns id of selected item. returns -1 if no item is selected.

virtual void	setSelected (dcpp::int32_kt index)=0
	sets the selected item. Set this to -1 if no item should be selected

virtual void	setSelected (const wchar_t *item)=0
	sets the selected item. Set this to 0 if no item should be selected

virtual void	setAutoScrollEnabled (bool scroll)=0
	set whether the listbox should scroll to newly selected items

virtual bool	isAutoScrollEnabled () const =0
	returns true if automatic scrolling is enabled, false if not.

virtual void	setItemOverrideColor (dcpp::uint32_kt index, dcpp::video::SColor color)=0
	set all item colors at given index to color

virtual void	setItemOverrideColor (dcpp::uint32_kt index, EGUI_LISTBOX_COLOR colorType, dcpp::video::SColor color)=0
	set all item colors of specified type at given index to color

virtual void	clearItemOverrideColor (dcpp::uint32_kt index)=0
	clear all item colors at index

virtual void	clearItemOverrideColor (dcpp::uint32_kt index, EGUI_LISTBOX_COLOR colorType)=0
	clear item color at index for given colortype

virtual bool	hasItemOverrideColor (dcpp::uint32_kt index, EGUI_LISTBOX_COLOR colorType) const =0
	has the item at index its color overwritten?

virtual dcpp::video::SColor	getItemOverrideColor (dcpp::uint32_kt index, EGUI_LISTBOX_COLOR colorType) const =0
	return the overwrite color at given item index.

virtual dcpp::video::SColor	getItemDefaultColor (EGUI_LISTBOX_COLOR colorType) const =0
	return the default color which is used for the given colorType

virtual void	swapItems (dcpp::uint32_kt index1, dcpp::uint32_kt index2)=0
	Swap the items at the given indices.

virtual void	setItemHeight (dcpp::int32_kt height)=0
	set global itemHeight

virtual void	setDrawBackground (bool draw)=0
	Sets whether to draw the background.

virtual IGUIScrollBar *	getVerticalScrollBar () const =0
	Access the vertical scrollbar.

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

Default list box GUI element.

This element can create the following events of type EGUI_EVENT_TYPE:

EGET_LISTBOX_CHANGED
EGET_LISTBOX_SELECTED_AGAIN

Member Function Documentation

◆ addItem()

virtual dcpp::uint32_kt dcpp::gui::IGUIListBox::addItem	(	const wchar_t *	text,
		dcpp::int32_kt	icon = `-1`
	)

pure virtual

adds an list item with an icon

Parameters

text	Text of list entry
icon	Sprite index of the Icon within the current sprite bank. Set it to -1 if you want no icon

Returns: The id of the new created item

◆ getItemAt()

virtual dcpp::int32_kt dcpp::gui::IGUIListBox::getItemAt	(	dcpp::int32_kt	xpos,
		dcpp::int32_kt	ypos
	)		const

pure virtual

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

Returns: The id of the list item or -1 when no item is at those coordinates

◆ insertItem()

virtual dcpp::int32_kt dcpp::gui::IGUIListBox::insertItem	(	dcpp::uint32_kt	index,
		const wchar_t *	text,
		dcpp::int32_kt	icon = `-1`
	)

pure virtual

Insert the item at the given index.

Returns: The index on success or -1 on failure.

◆ setSpriteBank()

virtual void dcpp::gui::IGUIListBox::setSpriteBank ( IGUISpriteBank * bank )

pure virtual

Sets the sprite bank which should be used to draw list icons.

This font is set to the sprite bank of the built-in-font by default. A sprite can be displayed in front of every list item. An icon is an index within the icon sprite bank. Several default icons are available in the skin through getIcon.

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

include/duckcpp/core/engine/IGUIListBox.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addItem()

◆ getItemAt()

◆ insertItem()

◆ setSpriteBank()