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

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 More...
 
virtual u32 addItem (const wchar_t *text)=0
 adds an list item, returns id of item More...
 
virtual u32 addItem (const wchar_t *text, s32 icon)=0
 adds an list item with an icon More...
 
virtual void clear ()=0
 clears the list, deletes all items in the listbox More...
 
virtual void clearItemOverrideColor (u32 index)=0
 clear all item colors at index More...
 
virtual void clearItemOverrideColor (u32 index, EGUI_LISTBOX_COLOR colorType)=0
 clear item color at index for given colortype More...
 
virtual s32 getIcon (u32 index) const =0
 Returns the icon of an item. More...
 
virtual s32 getItemAt (s32 xpos, s32 ypos) const =0
 get the the id of the item at the given absolute coordinates More...
 
virtual u32 getItemCount () const =0
 returns amount of list items More...
 
virtual video::SColor getItemDefaultColor (EGUI_LISTBOX_COLOR colorType) const =0
 return the default color which is used for the given colorType More...
 
virtual video::SColor getItemOverrideColor (u32 index, EGUI_LISTBOX_COLOR colorType) const =0
 return the overwrite color at given item index. More...
 
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 More...
 
virtual s32 getSelected () const =0
 returns id of selected item. returns -1 if no item is selected. More...
 
virtual IGUIScrollBargetVerticalScrollBar () const =0
 Access the vertical scrollbar. More...
 
virtual bool hasItemOverrideColor (u32 index, EGUI_LISTBOX_COLOR colorType) const =0
 has the item at index its color overwritten? More...
 
virtual s32 insertItem (u32 index, const wchar_t *text, s32 icon)=0
 Insert the item at the given index. More...
 
virtual bool isAutoScrollEnabled () const =0
 returns true if automatic scrolling is enabled, false if not. More...
 
virtual void removeItem (u32 index)=0
 Removes an item from the list. More...
 
virtual void setAutoScrollEnabled (bool scroll)=0
 set whether the listbox should scroll to newly selected items More...
 
virtual void setDrawBackground (bool draw)=0
 Sets whether to draw the background. More...
 
virtual void setItem (u32 index, const wchar_t *text, s32 icon)=0
 set the item at the given index More...
 
virtual void setItemHeight (s32 height)=0
 set global itemHeight More...
 
virtual void setItemOverrideColor (u32 index, video::SColor color)=0
 set all item colors at given index to color More...
 
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 More...
 
virtual void setSelected (s32 index)=0
 sets the selected item. Set this to -1 if no item should be selected More...
 
virtual void setSelected (const wchar_t *item)=0
 sets the selected item. Set this to 0 if no item should be selected More...
 
virtual void setSpriteBank (IGUISpriteBank *bank)=0
 Sets the sprite bank which should be used to draw list icons. More...
 
virtual void swapItems (u32 index1, u32 index2)=0
 Swap the items at the given indices. 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

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 39 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 43 of file IGUIListBox.h.

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
textText of list entry
iconSprite 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 list item 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.

◆ getVerticalScrollBar()

virtual IGUIScrollBar* irr::gui::IGUIListBox::getVerticalScrollBar ( ) const
pure virtual

Access the vertical scrollbar.

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

◆ 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,
video::SColor  color 
)
pure virtual

set all item colors at given index to color

◆ setItemOverrideColor() [2/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

◆ setSelected() [1/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

◆ setSelected() [2/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

◆ 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: