Default list box GUI element. More...
#include <IGUIListBox.h>
Default list box GUI element.
Definition at line 38 of file IGUIListBox.h.
irr::gui::IGUIListBox::IGUIListBox | ( | IGUIEnvironment * | environment, |
IGUIElement * | parent, | ||
s32 | id, | ||
core::rect< s32 > | rectangle | ||
) | [inline] |
constructor
Definition at line 42 of file IGUIListBox.h.
virtual u32 irr::gui::IGUIListBox::addItem | ( | const wchar_t * | text | ) | [pure virtual] |
adds an list item, returns id of item
adds an list item with an icon
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 |
virtual void irr::gui::IGUIListBox::clear | ( | ) | [pure virtual] |
clears the list, deletes all items in the listbox
virtual void irr::gui::IGUIListBox::clearItemOverrideColor | ( | u32 | index | ) | [pure virtual] |
clear all item colors at index
virtual void irr::gui::IGUIListBox::clearItemOverrideColor | ( | u32 | index, |
EGUI_LISTBOX_COLOR | colorType | ||
) | [pure virtual] |
clear item color at index for given colortype
Returns the icon of an item.
get the the id of the item at the given absolute coordinates
virtual u32 irr::gui::IGUIListBox::getItemCount | ( | ) | const [pure virtual] |
returns amount of list items
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
virtual video::SColor irr::gui::IGUIListBox::getItemOverrideColor | ( | u32 | index, |
EGUI_LISTBOX_COLOR | colorType | ||
) | const [pure virtual] |
return the overwrite color at given item index.
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
virtual s32 irr::gui::IGUIListBox::getSelected | ( | ) | const [pure virtual] |
returns id of selected item. returns -1 if no item is selected.
virtual bool irr::gui::IGUIListBox::hasItemOverrideColor | ( | u32 | index, |
EGUI_LISTBOX_COLOR | colorType | ||
) | const [pure virtual] |
has the item at index its color overwritten?
virtual s32 irr::gui::IGUIListBox::insertItem | ( | u32 | index, |
const wchar_t * | text, | ||
s32 | icon | ||
) | [pure virtual] |
Insert the item at the given index.
virtual bool irr::gui::IGUIListBox::isAutoScrollEnabled | ( | ) | const [pure virtual] |
returns true if automatic scrolling is enabled, false if not.
virtual void irr::gui::IGUIListBox::removeItem | ( | u32 | index | ) | [pure virtual] |
Removes an item from the list.
virtual void irr::gui::IGUIListBox::setAutoScrollEnabled | ( | bool | scroll | ) | [pure virtual] |
set whether the listbox should scroll to newly selected items
virtual void irr::gui::IGUIListBox::setDrawBackground | ( | bool | draw | ) | [pure virtual] |
Sets whether to draw the background.
virtual void irr::gui::IGUIListBox::setItem | ( | u32 | index, |
const wchar_t * | text, | ||
s32 | icon | ||
) | [pure virtual] |
set the item at the given index
virtual void irr::gui::IGUIListBox::setItemHeight | ( | s32 | height | ) | [pure virtual] |
set global itemHeight
virtual void irr::gui::IGUIListBox::setItemOverrideColor | ( | u32 | index, |
video::SColor | color | ||
) | [pure virtual] |
set all item colors at given index to color
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
virtual void irr::gui::IGUIListBox::setSelected | ( | s32 | index | ) | [pure virtual] |
sets the selected item. Set this to -1 if no item should be selected
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
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.
Swap the items at the given indices.