Irrlicht 3D Engine
IGUIComboBox.h
Go to the documentation of this file.
1 // Copyright (C) 2002-2012 Nikolaus Gebhardt
2 // This file is part of the "Irrlicht Engine".
3 // For conditions of distribution and use, see copyright notice in irrlicht.h
4 
5 #ifndef __I_GUI_COMBO_BOX_H_INCLUDED__
6 #define __I_GUI_COMBO_BOX_H_INCLUDED__
7 
8 #include "IGUIElement.h"
9 
10 namespace irr
11 {
12 namespace gui
13 {
14 
16 
19  class IGUIComboBox : public IGUIElement
20  {
21  public:
22 
24  IGUIComboBox(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
25  : IGUIElement(EGUIET_COMBO_BOX, environment, parent, id, rectangle) {}
26 
28  virtual u32 getItemCount() const = 0;
29 
31  virtual const wchar_t* getItem(u32 idx) const = 0;
32 
34  virtual u32 getItemData(u32 idx) const = 0;
35 
37  virtual s32 getIndexForItemData(u32 data ) const = 0;
38 
40  virtual u32 addItem(const wchar_t* text, u32 data = 0) = 0;
41 
43 
44  virtual void removeItem(u32 idx) = 0;
45 
47  virtual void clear() = 0;
48 
50  virtual s32 getSelected() const = 0;
51 
53  virtual void setSelected(s32 idx) = 0;
54 
56 
60  virtual void setTextAlignment(EGUI_ALIGNMENT horizontal, EGUI_ALIGNMENT vertical) = 0;
61 
63  virtual void setMaxSelectionRows(u32 max) = 0;
64 
66  virtual u32 getMaxSelectionRows() const = 0;
67  };
68 
69 
70 } // end namespace gui
71 } // end namespace irr
72 
73 #endif
74 
irr::gui::IGUIComboBox::getSelected
virtual s32 getSelected() const =0
Returns id of selected item. returns -1 if no item is selected.
irr::gui::IGUIComboBox::getMaxSelectionRows
virtual u32 getMaxSelectionRows() const =0
Get the maximimal number of rows for the selection listbox.
irr::gui::EGUIET_COMBO_BOX
@ EGUIET_COMBO_BOX
A combo box (IGUIComboBox)
Definition: EGUIElementTypes.h:26
irr::gui::IGUIComboBox::clear
virtual void clear()=0
Deletes all items in the combo box.
irr::gui::IGUIComboBox::addItem
virtual u32 addItem(const wchar_t *text, u32 data=0)=0
Adds an item and returns the index of it.
irr::gui::IGUIComboBox::getIndexForItemData
virtual s32 getIndexForItemData(u32 data) const =0
Returns index based on item data.
irr::gui::IGUIComboBox::getItemCount
virtual u32 getItemCount() const =0
Returns amount of items in box.
irr::gui::IGUIComboBox::setSelected
virtual void setSelected(s32 idx)=0
Sets the selected item. Set this to -1 if no item should be selected.
irr::s32
signed int s32
32 bit signed variable.
Definition: irrTypes.h:66
irr::gui::EGUI_ALIGNMENT
EGUI_ALIGNMENT
Definition: EGUIAlignment.h:12
irr::gui::IGUIComboBox::getItemData
virtual u32 getItemData(u32 idx) const =0
Returns item data of an item. the idx may be a value from 0 to itemCount-1.
irr::gui::IGUIComboBox::setTextAlignment
virtual void setTextAlignment(EGUI_ALIGNMENT horizontal, EGUI_ALIGNMENT vertical)=0
Sets text justification of the text area.
irr::gui::IGUIComboBox::getItem
virtual const wchar_t * getItem(u32 idx) const =0
Returns string of an item. the idx may be a value from 0 to itemCount-1.
irr::gui::IGUIComboBox::removeItem
virtual void removeItem(u32 idx)=0
Removes an item from the combo box.
IGUIElement.h
irr::gui::IGUIComboBox
Combobox widget.
Definition: IGUIComboBox.h:19
irr::gui::IGUIComboBox::IGUIComboBox
IGUIComboBox(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect< s32 > rectangle)
constructor
Definition: IGUIComboBox.h:24
irr::gui::IGUIComboBox::setMaxSelectionRows
virtual void setMaxSelectionRows(u32 max)=0
Set the maximal number of rows for the selection listbox.
irr
Everything in the Irrlicht Engine can be found in this namespace.
Definition: aabbox3d.h:12
irr::core::rect< s32 >
irr::u32
unsigned int u32
32 bit unsigned variable.
Definition: irrTypes.h:58
irr::gui::IGUIEnvironment
GUI Environment. Used as factory and manager of all other GUI elements.
Definition: IGUIEnvironment.h:70
irr::gui::IGUIElement
Base class of all GUI elements.
Definition: IGUIElement.h:25