Default list box GUI element. More...

#include <IGUIListBox.h>

Inheritance diagram for irr::gui::IGUIListBox:

Public Member Functions
	IGUIListBox (IGUIEnvironment environment, IGUIElement parent, s32 id, core::rect< s32 > rectangle)
	constructor
virtual u32	addItem (const wchar_t *text)=0
	adds an list item, returns id of item
virtual u32	addItem (const wchar_t *text, s32 icon)=0
	adds an list item with an icon
virtual void	clear ()=0
	clears the list, deletes all items in the listbox
virtual void	clearItemOverrideColor (u32 index)=0
	clear all item colors at index
virtual void	clearItemOverrideColor (u32 index, EGUI_LISTBOX_COLOR colorType)=0
	clear item color at index for given colortype
virtual s32	getIcon (u32 index) const =0
	Returns the icon of an item.
virtual s32	getItemAt (s32 xpos, s32 ypos) const =0
	get the the id of the item at the given absolute coordinates
virtual u32	getItemCount () const =0
	returns amount of list items
virtual video::SColor	getItemDefaultColor (EGUI_LISTBOX_COLOR colorType) const =0
	return the default color which is used for the given colorType
virtual video::SColor	getItemOverrideColor (u32 index, EGUI_LISTBOX_COLOR colorType) const =0
	return the overwrite color at given item index.
virtual const wchar_t *	getListItem (u32 id) const =0
	returns string of a list item. the may id be a value from 0 to itemCount-1
virtual s32	getSelected () const =0
	returns id of selected item. returns -1 if no item is selected.
virtual bool	hasItemOverrideColor (u32 index, EGUI_LISTBOX_COLOR colorType) const =0
	has the item at index its color overwritten?
virtual s32	insertItem (u32 index, const wchar_t *text, s32 icon)=0
	Insert the item at the given index.
virtual bool	isAutoScrollEnabled () const =0
	returns true if automatic scrolling is enabled, false if not.
virtual void	removeItem (u32 index)=0
	Removes an item from the list.
virtual void	setAutoScrollEnabled (bool scroll)=0
	set whether the listbox should scroll to newly selected items
virtual void	setDrawBackground (bool draw)=0
	Sets whether to draw the background.
virtual void	setItem (u32 index, const wchar_t *text, s32 icon)=0
	set the item at the given index
virtual void	setItemHeight (s32 height)=0
	set global itemHeight
virtual void	setItemOverrideColor (u32 index, EGUI_LISTBOX_COLOR colorType, video::SColor color)=0
	set all item colors of specified type at given index to color
virtual void	setItemOverrideColor (u32 index, video::SColor color)=0
	set all item colors at given index to color
virtual void	setSelected (const wchar_t *item)=0
	sets the selected item. Set this to 0 if no item should be selected
virtual void	setSelected (s32 index)=0
	sets the selected item. Set this to -1 if no item should be selected
virtual void	setSpriteBank (IGUISpriteBank *bank)=0
	Sets the sprite bank which should be used to draw list icons.
virtual void	swapItems (u32 index1, u32 index2)=0
	Swap the items at the given indices.
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.
virtual	~IGUIElement ()
	Destructor.
virtual void	addChild (IGUIElement *child)
	Adds a GUI element as new child of this element.
virtual bool	bringToFront (IGUIElement *element)
	Brings a child to front.
virtual void	deserializeAttributes (io::IAttributes in, io::SAttributeReadWriteOptions options=0)
	Reads attributes of the scene node.
virtual void	draw ()
	Draws the element and its children.
core::rect< s32 >	getAbsoluteClippingRect () const
	Returns the visible area of the element.
core::rect< s32 >	getAbsolutePosition () const
	Gets the absolute rectangle of this element.
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.
IGUIElement *	getElementFromPoint (const core::position2d< s32 > &point)
	Returns the topmost GUI element at the specific position.
virtual s32	getID () const
	Returns id. Can be used to identify the element.
virtual const c8 *	getName () const
	Returns the name of the element.
bool	getNextElement (s32 startOrder, bool reverse, bool group, IGUIElement &first, IGUIElement &closest, bool includeInvisible=false) const
	searches elements to find the closest next element to tab to
IGUIElement *	getParent () const
	Returns parent of this element.
core::rect< s32 >	getRelativePosition () const
	Returns the relative rectangle of this element.
IGUIElement *	getTabGroup ()
	Returns the container element which holds all elements in this element's tab group.
s32	getTabOrder () const
	Returns the number in the tab order sequence.
virtual const wchar_t *	getText () const
	Returns caption of this element.
virtual const core::stringw &	getToolTipText () const
	Returns caption of this element.
EGUI_ELEMENT_TYPE	getType () const
	Returns the type of the gui element.
virtual const c8 *	getTypeName () const
	Returns the type name of the gui element.
virtual bool	hasType (EGUI_ELEMENT_TYPE type) const
	Returns true if the gui element supports the given type.
virtual bool	isEnabled () const
	Returns true if element is enabled.
bool	isMyChild (IGUIElement *child) const
bool	isNotClipped () const
	Gets whether the element will ignore its parent's clipping rectangle.
virtual bool	isPointInside (const core::position2d< s32 > &point) const
	Returns true if a point is within this element.
virtual bool	isSubElement () const
	Returns true if this element was created as part of its parent control.
bool	isTabGroup () const
	Returns true if this element is a tab group.
bool	isTabStop () const
	Returns true if this element can be focused by navigating with the tab key.
virtual bool	isVisible () const
	Returns true if element is visible.
virtual void	move (core::position2d< s32 > absoluteMovement)
	Moves this element.
virtual bool	OnEvent (const SEvent &event)
	Called if an event happened.
virtual void	OnPostRender (u32 timeMs)
	animate the element and its children.
virtual void	remove ()
	Removes this element from its parent.
virtual void	removeChild (IGUIElement *child)
	Removes a child.
virtual bool	sendToBack (IGUIElement *child)
	Moves a child to the back, so it's siblings are drawn on top of it.
virtual void	serializeAttributes (io::IAttributes out, io::SAttributeReadWriteOptions options=0) const
	Writes attributes of the scene node.
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.
virtual void	setEnabled (bool enabled)
	Sets the enabled state of this element.
virtual void	setID (s32 id)
	Sets the id of this element.
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.
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.
void	setNotClipped (bool noClip)
	Sets whether the element will ignore its parent's clipping rectangle.
void	setRelativePosition (const core::position2di &position)
	Sets the relative rectangle of this element, maintaining its current width and height.
void	setRelativePosition (const core::rect< s32 > &r)
	Sets the relative rectangle of this element.
void	setRelativePositionProportional (const core::rect< f32 > &r)
	Sets the relative rectangle of this element as a proportion of its parent's area.
virtual void	setSubElement (bool subElement)
	Sets whether this control was created as part of its parent.
void	setTabGroup (bool isGroup)
	Sets whether this element is a container for a group of elements which can be navigated using the tab key.
void	setTabOrder (s32 index)
	Sets the priority of focus when using the tab key to navigate between a group of elements.
void	setTabStop (bool enable)
	If set to true, the focus will visit this element when using the tab key to cycle through elements.
virtual void	setText (const wchar_t *text)
	Sets the new caption of this element.
virtual void	setToolTipText (const wchar_t *text)
	Sets the new caption of this element.
virtual void	setVisible (bool visible)
	Sets the visible state of this element.
virtual void	updateAbsolutePosition ()
	Updates the absolute position.
Public Member Functions inherited from irr::IReferenceCounted
	IReferenceCounted ()
	Constructor.
virtual	~IReferenceCounted ()
	Destructor.
bool	drop () const
	Drops the object. Decrements the reference counter by one.
const c8 *	getDebugName () const
	Returns the debug name of the object.
s32	getReferenceCount () const
	Get the reference count.
void	grab () const
	Grabs the object. Increments the reference counter by one.
Public Member Functions inherited from irr::IEventReceiver
virtual	~IEventReceiver ()
	Destructor.

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.
Protected Attributes inherited from irr::gui::IGUIElement
core::rect< s32 >	AbsoluteClippingRect
	absolute clipping rect of element
core::rect< s32 >	AbsoluteRect
	absolute rect of element
EGUI_ALIGNMENT	AlignBottom
EGUI_ALIGNMENT	AlignLeft
	tells the element how to act when its parent is resized
EGUI_ALIGNMENT	AlignRight
EGUI_ALIGNMENT	AlignTop
core::list< IGUIElement * >	Children
	List of all children of this element.
core::rect< s32 >	DesiredRect
IGUIEnvironment *	Environment
	GUI Environment.
s32	ID
	users can set this for identificating the element by integer
bool	IsEnabled
	is enabled?
bool	IsSubElement
	is a part of a larger whole and should not be serialized?
bool	IsTabGroup
	tab groups are containers like windows, use ctrl+tab to navigate
bool	IsTabStop
	tab stop like in windows
bool	IsVisible
	is visible?
core::rect< s32 >	LastParentRect
	for calculating the difference when resizing parent
core::dimension2du	MaxSize
	maximum and minimum size of the element
core::dimension2du	MinSize
core::stringc	Name
	users can set this for identificating the element by string
bool	NoClip
	does this element ignore its parent's clipping rectangle?
IGUIElement *	Parent
	Pointer to the parent.
core::rect< s32 >	RelativeRect
	relative rect of element
core::rect< f32 >	ScaleRect
	relative scale of the element inside its parent
s32	TabOrder
	tab order
core::stringw	Text
	caption
core::stringw	ToolTipText
	tooltip
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

Definition at line 38 of file IGUIListBox.h.

Constructor & Destructor Documentation

◆ IGUIListBox()

irr::gui::IGUIListBox::IGUIListBox	(	IGUIEnvironment *	environment,
		IGUIElement *	parent,
		s32	id,
		core::rect< s32 >	rectangle )

inline

constructor

Definition at line 42 of file IGUIListBox.h.

References irr::gui::IGUIElement::IGUIElement(), and irr::gui::EGUIET_LIST_BOX.

Member Function Documentation

◆ addItem() [1/2]

virtual u32 irr::gui::IGUIListBox::addItem ( const wchar_t * text )

pure virtual

adds an list item, returns id of item

◆ addItem() [2/2]

virtual u32 irr::gui::IGUIListBox::addItem	(	const wchar_t *	text,
		s32	icon )

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

◆ clear()

virtual void irr::gui::IGUIListBox::clear ( )

pure virtual

clears the list, deletes all items in the listbox

◆ clearItemOverrideColor() [1/2]

virtual void irr::gui::IGUIListBox::clearItemOverrideColor ( u32 index )

pure virtual

clear all item colors at index

◆ clearItemOverrideColor() [2/2]

virtual void irr::gui::IGUIListBox::clearItemOverrideColor	(	u32	index,
		EGUI_LISTBOX_COLOR	colorType )

pure virtual

clear item color at index for given colortype

◆ getIcon()

virtual s32 irr::gui::IGUIListBox::getIcon ( u32 index ) const

pure virtual

Returns the icon of an item.

◆ getItemAt()

virtual s32 irr::gui::IGUIListBox::getItemAt	(	s32	xpos,
		s32	ypos ) const

pure virtual

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

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

◆ getItemCount()

virtual u32 irr::gui::IGUIListBox::getItemCount ( ) const

pure virtual

returns amount of list items

◆ getItemDefaultColor()

virtual video::SColor irr::gui::IGUIListBox::getItemDefaultColor ( EGUI_LISTBOX_COLOR colorType ) const

pure virtual

return the default color which is used for the given colorType

◆ getItemOverrideColor()

virtual video::SColor irr::gui::IGUIListBox::getItemOverrideColor	(	u32	index,
		EGUI_LISTBOX_COLOR	colorType ) const

pure virtual

return the overwrite color at given item index.

◆ getListItem()

virtual const wchar_t * irr::gui::IGUIListBox::getListItem ( u32 id ) const

pure virtual

returns string of a list item. the may id be a value from 0 to itemCount-1

◆ getSelected()

virtual s32 irr::gui::IGUIListBox::getSelected ( ) const

pure virtual

returns id of selected item. returns -1 if no item is selected.

◆ hasItemOverrideColor()

virtual bool irr::gui::IGUIListBox::hasItemOverrideColor	(	u32	index,
		EGUI_LISTBOX_COLOR	colorType ) const

pure virtual

has the item at index its color overwritten?

◆ insertItem()

virtual s32 irr::gui::IGUIListBox::insertItem	(	u32	index,
		const wchar_t *	text,
		s32	icon )

pure virtual

Insert the item at the given index.

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

◆ isAutoScrollEnabled()

virtual bool irr::gui::IGUIListBox::isAutoScrollEnabled ( ) const

pure virtual

returns true if automatic scrolling is enabled, false if not.

◆ removeItem()

virtual void irr::gui::IGUIListBox::removeItem ( u32 index )

pure virtual

Removes an item from the list.

◆ setAutoScrollEnabled()

virtual void irr::gui::IGUIListBox::setAutoScrollEnabled ( bool scroll )

pure virtual

set whether the listbox should scroll to newly selected items

◆ setDrawBackground()

virtual void irr::gui::IGUIListBox::setDrawBackground ( bool draw )

pure virtual

Sets whether to draw the background.

References irr::gui::IGUIElement::draw().

◆ setItem()

virtual void irr::gui::IGUIListBox::setItem	(	u32	index,
		const wchar_t *	text,
		s32	icon )

pure virtual

set the item at the given index

◆ setItemHeight()

virtual void irr::gui::IGUIListBox::setItemHeight ( s32 height )

pure virtual

set global itemHeight

◆ setItemOverrideColor() [1/2]

virtual void irr::gui::IGUIListBox::setItemOverrideColor	(	u32	index,
		EGUI_LISTBOX_COLOR	colorType,
		video::SColor	color )

pure virtual

set all item colors of specified type at given index to color

◆ setItemOverrideColor() [2/2]

virtual void irr::gui::IGUIListBox::setItemOverrideColor	(	u32	index,
		video::SColor	color )

pure virtual

set all item colors at given index to color

◆ setSelected() [1/2]

virtual void irr::gui::IGUIListBox::setSelected ( const wchar_t * item )

pure virtual

sets the selected item. Set this to 0 if no item should be selected

◆ setSelected() [2/2]

virtual void irr::gui::IGUIListBox::setSelected ( s32 index )

pure virtual

sets the selected item. Set this to -1 if no item should be selected

◆ setSpriteBank()

virtual void irr::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.

◆ swapItems()

virtual void irr::gui::IGUIListBox::swapItems	(	u32	index1,
		u32	index2 )

pure virtual

Swap the items at the given indices.

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

IGUIListBox.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IGUIListBox()

Member Function Documentation

◆ addItem() [1/2]

◆ addItem() [2/2]

◆ clear()

◆ clearItemOverrideColor() [1/2]

◆ clearItemOverrideColor() [2/2]

◆ getIcon()

◆ getItemAt()

◆ getItemCount()

◆ getItemDefaultColor()

◆ getItemOverrideColor()

◆ getListItem()

◆ getSelected()

◆ hasItemOverrideColor()

◆ insertItem()

◆ isAutoScrollEnabled()

◆ removeItem()

◆ setAutoScrollEnabled()

◆ setDrawBackground()

◆ setItem()

◆ setItemHeight()

◆ setItemOverrideColor() [1/2]

◆ setItemOverrideColor() [2/2]

◆ setSelected() [1/2]

◆ setSelected() [2/2]

◆ setSpriteBank()

◆ swapItems()