<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Irrlicht Engine: irr::gui::IGUIComboBox Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table class="irrlicht" >
<tr valign="middle">
<td><font size="2"><a class="qindex" href="index.html"><font color="#FFFFFF">Home</font></a>
| <a class="qindex" href="namespaces.html"><font color="#FFFFFF">Namespaces</font></a>
| <a class="qindex" href="hierarchy.html"><font color="#FFFFFF">Hierarchy</font></a>
| <a class="qindex" href="classes.html"><font color="#FFFFFF">Alphabetical
List</font></a> | <a class="qindex" href="annotated.html"><font color="#FFFFFF">
Class list</font></a> | <a class="qindex" href="files.html"><font color="#FFFFFF">Files</font></a>
| <a class="qindex" href="namespacemembers.html"><font color="#FFFFFF">
Namespace Members</font></a> | <a class="qindex" href="functions.html"><font color="#FFFFFF">Class
members</font></a> | <a class="qindex" href="globals.html"><font color="#FFFFFF">File
members</font></a> | <a class="qindex" href="pages.html"><font color="#FFFFFF">Tutorials</font></a></font> </td>
</tr>
</table>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navpath"><a class="el" href="namespaceirr.html">irr</a>::<a class="el" href="namespaceirr_1_1gui.html">gui</a>::<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_combo_box.html">IGUIComboBox</a>
</div>
<div class="contents">
<h1>irr::gui::IGUIComboBox Class Reference</h1><!-- doxytag: class="irr::gui::IGUIComboBox" --><!-- doxytag: inherits="irr::gui::IGUIElement" -->Combobox widget.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="_i_g_u_i_combo_box_8h-source.html">IGUIComboBox.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for irr::gui::IGUIComboBox:</div>
<div class="dynsection">
<p><center><img src="classirr_1_1gui_1_1_i_g_u_i_combo_box.png" usemap="#irr::gui::IGUIComboBox_map" border="0" alt=""></center>
<map name="irr::gui::IGUIComboBox_map">
<area href="classirr_1_1gui_1_1_i_g_u_i_element.html" alt="irr::gui::IGUIElement" shape="rect" coords="105,112,305,136">
<area href="classirr_1_1io_1_1_i_attribute_exchanging_object.html" alt="irr::io::IAttributeExchangingObject" shape="rect" coords="0,56,200,80">
<area href="classirr_1_1_i_event_receiver.html" alt="irr::IEventReceiver" shape="rect" coords="210,56,410,80">
<area href="classirr_1_1_i_reference_counted.html" alt="irr::IReferenceCounted" shape="rect" coords="0,0,200,24">
</map>
</div>
<p>
<a href="classirr_1_1gui_1_1_i_g_u_i_combo_box-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_combo_box.html#1952afb705f497306cb006c502ac181c">addItem</a> (const wchar_t *text, <a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> data=0)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an item and returns the index of it. <a href="#1952afb705f497306cb006c502ac181c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_combo_box.html#f9f5d813496af19af437a6f51fa7e029">clear</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deletes all items in the combo box. <a href="#f9f5d813496af19af437a6f51fa7e029"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_combo_box.html#01c1dea5455f7a9302cea8d156787c3e">getIndexForItemData</a> (<a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> data) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns index based on item data. <a href="#01c1dea5455f7a9302cea8d156787c3e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const wchar_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_combo_box.html#fe60f75b5e8685f6a19101d31ad6d369">getItem</a> (<a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> idx) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string of an item. the idx may be a value from 0 to itemCount-1. <a href="#fe60f75b5e8685f6a19101d31ad6d369"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_combo_box.html#573bdf5507fd9d389635cbb4d84c3757">getItemCount</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns amount of items in box. <a href="#573bdf5507fd9d389635cbb4d84c3757"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_combo_box.html#c0f2189cf87e4ffe38834edea01c75fb">getItemData</a> (<a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> idx) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns item data of an item. the idx may be a value from 0 to itemCount-1. <a href="#c0f2189cf87e4ffe38834edea01c75fb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_combo_box.html#7cb6bb2a86fccfc78cbb3c3d56b88778">getSelected</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns id of selected item. returns -1 if no item is selected. <a href="#7cb6bb2a86fccfc78cbb3c3d56b88778"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_combo_box.html#89e96a8ac4c47e7b202be120486f1f94">IGUIComboBox</a> (<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">IGUIEnvironment</a> *environment, <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> *parent, <a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> id, <a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>< <a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> > rectangle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#89e96a8ac4c47e7b202be120486f1f94"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_combo_box.html#a6a351f80aa57374459a9d66f416ce3c">removeItem</a> (<a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> idx)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes an item from the combo box. <a href="#a6a351f80aa57374459a9d66f416ce3c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_combo_box.html#84660e6f4a677349ca7dc39024fe7b17">setSelected</a> (<a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> idx)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the selected item. Set this to -1 if no item should be selected. <a href="#84660e6f4a677349ca7dc39024fe7b17"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_combo_box.html#902681b9cfc783d29270f919ab3e71d8">setTextAlignment</a> (<a class="el" href="namespaceirr_1_1gui.html#19eb5fb40e67f108cb16aba922ddaa2d">EGUI_ALIGNMENT</a> horizontal, <a class="el" href="namespaceirr_1_1gui.html#19eb5fb40e67f108cb16aba922ddaa2d">EGUI_ALIGNMENT</a> vertical)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets text justification of the text area. <a href="#902681b9cfc783d29270f919ab3e71d8"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Combobox widget.
<p>Definition at line <a class="el" href="_i_g_u_i_combo_box_8h-source.html#l00016">16</a> of file <a class="el" href="_i_g_u_i_combo_box_8h-source.html">IGUIComboBox.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="89e96a8ac4c47e7b202be120486f1f94"></a><!-- doxytag: member="irr::gui::IGUIComboBox::IGUIComboBox" ref="89e96a8ac4c47e7b202be120486f1f94" args="(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect< s32 > rectangle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">irr::gui::IGUIComboBox::IGUIComboBox </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">IGUIEnvironment</a> * </td>
<td class="paramname"> <em>environment</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> * </td>
<td class="paramname"> <em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>< <a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> > </td>
<td class="paramname"> <em>rectangle</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
constructor
<p>
<p>Definition at line <a class="el" href="_i_g_u_i_combo_box_8h-source.html#l00021">21</a> of file <a class="el" href="_i_g_u_i_combo_box_8h-source.html">IGUIComboBox.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1952afb705f497306cb006c502ac181c"></a><!-- doxytag: member="irr::gui::IGUIComboBox::addItem" ref="1952afb705f497306cb006c502ac181c" args="(const wchar_t *text, u32 data=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> irr::gui::IGUIComboBox::addItem </td>
<td>(</td>
<td class="paramtype">const wchar_t * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> </td>
<td class="paramname"> <em>data</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds an item and returns the index of it.
<p>
</div>
</div><p>
<a class="anchor" name="f9f5d813496af19af437a6f51fa7e029"></a><!-- doxytag: member="irr::gui::IGUIComboBox::clear" ref="f9f5d813496af19af437a6f51fa7e029" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIComboBox::clear </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Deletes all items in the combo box.
<p>
</div>
</div><p>
<a class="anchor" name="01c1dea5455f7a9302cea8d156787c3e"></a><!-- doxytag: member="irr::gui::IGUIComboBox::getIndexForItemData" ref="01c1dea5455f7a9302cea8d156787c3e" args="(u32 data) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> irr::gui::IGUIComboBox::getIndexForItemData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> </td>
<td class="paramname"> <em>data</em> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns index based on item data.
<p>
</div>
</div><p>
<a class="anchor" name="fe60f75b5e8685f6a19101d31ad6d369"></a><!-- doxytag: member="irr::gui::IGUIComboBox::getItem" ref="fe60f75b5e8685f6a19101d31ad6d369" args="(u32 idx) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const wchar_t* irr::gui::IGUIComboBox::getItem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns string of an item. the idx may be a value from 0 to itemCount-1.
<p>
</div>
</div><p>
<a class="anchor" name="573bdf5507fd9d389635cbb4d84c3757"></a><!-- doxytag: member="irr::gui::IGUIComboBox::getItemCount" ref="573bdf5507fd9d389635cbb4d84c3757" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> irr::gui::IGUIComboBox::getItemCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns amount of items in box.
<p>
</div>
</div><p>
<a class="anchor" name="c0f2189cf87e4ffe38834edea01c75fb"></a><!-- doxytag: member="irr::gui::IGUIComboBox::getItemData" ref="c0f2189cf87e4ffe38834edea01c75fb" args="(u32 idx) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> irr::gui::IGUIComboBox::getItemData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns item data of an item. the idx may be a value from 0 to itemCount-1.
<p>
</div>
</div><p>
<a class="anchor" name="7cb6bb2a86fccfc78cbb3c3d56b88778"></a><!-- doxytag: member="irr::gui::IGUIComboBox::getSelected" ref="7cb6bb2a86fccfc78cbb3c3d56b88778" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> irr::gui::IGUIComboBox::getSelected </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns id of selected item. returns -1 if no item is selected.
<p>
</div>
</div><p>
<a class="anchor" name="a6a351f80aa57374459a9d66f416ce3c"></a><!-- doxytag: member="irr::gui::IGUIComboBox::removeItem" ref="a6a351f80aa57374459a9d66f416ce3c" args="(u32 idx)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIComboBox::removeItem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Removes an item from the combo box.
<p>
Warning. This will change the index of all following items
</div>
</div><p>
<a class="anchor" name="84660e6f4a677349ca7dc39024fe7b17"></a><!-- doxytag: member="irr::gui::IGUIComboBox::setSelected" ref="84660e6f4a677349ca7dc39024fe7b17" args="(s32 idx)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIComboBox::setSelected </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the selected item. Set this to -1 if no item should be selected.
<p>
</div>
</div><p>
<a class="anchor" name="902681b9cfc783d29270f919ab3e71d8"></a><!-- doxytag: member="irr::gui::IGUIComboBox::setTextAlignment" ref="902681b9cfc783d29270f919ab3e71d8" args="(EGUI_ALIGNMENT horizontal, EGUI_ALIGNMENT vertical)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIComboBox::setTextAlignment </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#19eb5fb40e67f108cb16aba922ddaa2d">EGUI_ALIGNMENT</a> </td>
<td class="paramname"> <em>horizontal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#19eb5fb40e67f108cb16aba922ddaa2d">EGUI_ALIGNMENT</a> </td>
<td class="paramname"> <em>vertical</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets text justification of the text area.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>horizontal,:</em> </td><td>EGUIA_UPPERLEFT for left justified (default), EGUIA_LOWEERRIGHT for right justified, or EGUIA_CENTER for centered text. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vertical,:</em> </td><td>EGUIA_UPPERLEFT to align with top edge, EGUIA_LOWEERRIGHT for bottom edge, or EGUIA_CENTER for centered text (default). </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_i_g_u_i_combo_box_8h-source.html">IGUIComboBox.h</a></ul>
</div>
<hr size="1">
<address style="align: right;">
<small> </small>
</address>
<table width="100%" border="0" cellspacing="0" cellpadding="2">
<tr>
<td width="0"> <div align="left"><small><a href="http://irrlicht.sourceforge.net" target="_blank"><img src="irrlicht.png" alt="The Irrlicht Engine" align="middle" border=0 width=88 height=31></a></small></div></td>
<td> <div align="left"><small><em><font size="2">The <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
Engine</a> Documentation © 2003-2009 by Nikolaus Gebhardt. Generated
on Sun Jan 10 09:24:10 2010 by <a href="http://www.doxygen.org" target="_blank">Doxygen</a>
(1.5.6)</font></em></small></div></td>
</tr>
</table>
<address style="align: right;">
</address>
</body>
</html>
