<!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::IGUISpinBox 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_spin_box.html">IGUISpinBox</a> </div> <div class="contents"> <h1>irr::gui::IGUISpinBox Class Reference</h1><!-- doxytag: class="irr::gui::IGUISpinBox" --><!-- doxytag: inherits="irr::gui::IGUIElement" -->Single line edit box + spin buttons. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="_i_g_u_i_spin_box_8h-source.html">IGUISpinBox.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for irr::gui::IGUISpinBox:</div> <div class="dynsection"> <p><center><img src="classirr_1_1gui_1_1_i_g_u_i_spin_box.png" usemap="#irr::gui::IGUISpinBox_map" border="0" alt=""></center> <map name="irr::gui::IGUISpinBox_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_spin_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="classirr_1_1gui_1_1_i_g_u_i_edit_box.html">IGUIEditBox</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_spin_box.html#04bd863724a7b37b97e7f9368fda77ef">getEditBox</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Access the edit box used in the spin control. <a href="#04bd863724a7b37b97e7f9368fda77ef"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_spin_box.html#f332d184560dee8f273b50d1beca45cc">getMax</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get the maximum value which can be used in the spinbox <a href="#f332d184560dee8f273b50d1beca45cc"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_spin_box.html#22f2211e612a7cfe7847d249724cadc1">getMin</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get the minimum value which can be used in the spinbox <a href="#22f2211e612a7cfe7847d249724cadc1"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_spin_box.html#5c66183b25860667488ff6c97df241bd">getStepSize</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get the current step size <a href="#5c66183b25860667488ff6c97df241bd"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_spin_box.html#cfb0ebe7ab30b58e9d34b7925e785bb8">getValue</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current value of the spinbox. <a href="#cfb0ebe7ab30b58e9d34b7925e785bb8"></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_spin_box.html#9e9c785f73b8fadbaff330f1cbb61adf">IGUISpinBox</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="#9e9c785f73b8fadbaff330f1cbb61adf"></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_spin_box.html#8a335d32cbdb7f43ca814422f8cee098">setDecimalPlaces</a> (<a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> places)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the number of decimal places to display. <a href="#8a335d32cbdb7f43ca814422f8cee098"></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_spin_box.html#f7bc07a7be30d16a6ff27750782aaa80">setRange</a> (<a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> min, <a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> max)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">set the range of values which can be used in the spinbox <a href="#f7bc07a7be30d16a6ff27750782aaa80"></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_spin_box.html#64296e93b52129fcf9068279baf0697d">setStepSize</a> (<a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> step=1.f)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Step size by which values are changed when pressing the spinbuttons. <a href="#64296e93b52129fcf9068279baf0697d"></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_spin_box.html#28e388e3767d4257f712d899c744bc20">setValue</a> (<a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> val)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">set the current value of the spinbox <a href="#28e388e3767d4257f712d899c744bc20"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Single line edit box + spin buttons. <p>Definition at line <a class="el" href="_i_g_u_i_spin_box_8h-source.html#l00017">17</a> of file <a class="el" href="_i_g_u_i_spin_box_8h-source.html">IGUISpinBox.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="9e9c785f73b8fadbaff330f1cbb61adf"></a><!-- doxytag: member="irr::gui::IGUISpinBox::IGUISpinBox" ref="9e9c785f73b8fadbaff330f1cbb61adf" 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::IGUISpinBox::IGUISpinBox </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_spin_box_8h-source.html#l00022">22</a> of file <a class="el" href="_i_g_u_i_spin_box_8h-source.html">IGUISpinBox.h</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="04bd863724a7b37b97e7f9368fda77ef"></a><!-- doxytag: member="irr::gui::IGUISpinBox::getEditBox" ref="04bd863724a7b37b97e7f9368fda77ef" args="() const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html">IGUIEditBox</a>* irr::gui::IGUISpinBox::getEditBox </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Access the edit box used in the spin control. <p> </div> </div><p> <a class="anchor" name="f332d184560dee8f273b50d1beca45cc"></a><!-- doxytag: member="irr::gui::IGUISpinBox::getMax" ref="f332d184560dee8f273b50d1beca45cc" args="() const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> irr::gui::IGUISpinBox::getMax </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> get the maximum value which can be used in the spinbox <p> </div> </div><p> <a class="anchor" name="22f2211e612a7cfe7847d249724cadc1"></a><!-- doxytag: member="irr::gui::IGUISpinBox::getMin" ref="22f2211e612a7cfe7847d249724cadc1" args="() const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> irr::gui::IGUISpinBox::getMin </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> get the minimum value which can be used in the spinbox <p> </div> </div><p> <a class="anchor" name="5c66183b25860667488ff6c97df241bd"></a><!-- doxytag: member="irr::gui::IGUISpinBox::getStepSize" ref="5c66183b25860667488ff6c97df241bd" args="() const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> irr::gui::IGUISpinBox::getStepSize </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> get the current step size <p> </div> </div><p> <a class="anchor" name="cfb0ebe7ab30b58e9d34b7925e785bb8"></a><!-- doxytag: member="irr::gui::IGUISpinBox::getValue" ref="cfb0ebe7ab30b58e9d34b7925e785bb8" args="() const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> irr::gui::IGUISpinBox::getValue </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the current value of the spinbox. <p> </div> </div><p> <a class="anchor" name="8a335d32cbdb7f43ca814422f8cee098"></a><!-- doxytag: member="irr::gui::IGUISpinBox::setDecimalPlaces" ref="8a335d32cbdb7f43ca814422f8cee098" args="(s32 places)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void irr::gui::IGUISpinBox::setDecimalPlaces </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> </td> <td class="paramname"> <em>places</em> </td> <td> ) </td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Sets the number of decimal places to display. <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>places,:</em> </td><td>The number of decimal places to display, use -1 to reset </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="f7bc07a7be30d16a6ff27750782aaa80"></a><!-- doxytag: member="irr::gui::IGUISpinBox::setRange" ref="f7bc07a7be30d16a6ff27750782aaa80" args="(f32 min, f32 max)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void irr::gui::IGUISpinBox::setRange </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> </td> <td class="paramname"> <em>min</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> </td> <td class="paramname"> <em>max</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> set the range of values which can be used in the spinbox <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>min,:</em> </td><td>minimum value </td></tr> <tr><td valign="top"></td><td valign="top"><em>max,:</em> </td><td>maximum value </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="64296e93b52129fcf9068279baf0697d"></a><!-- doxytag: member="irr::gui::IGUISpinBox::setStepSize" ref="64296e93b52129fcf9068279baf0697d" args="(f32 step=1.f)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void irr::gui::IGUISpinBox::setStepSize </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> </td> <td class="paramname"> <em>step</em> = <code>1.f</code> </td> <td> ) </td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Step size by which values are changed when pressing the spinbuttons. <p> The step size also determines the number of decimal places to display <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>step,:</em> </td><td>stepsize used for value changes when pressing spinbuttons </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="28e388e3767d4257f712d899c744bc20"></a><!-- doxytag: member="irr::gui::IGUISpinBox::setValue" ref="28e388e3767d4257f712d899c744bc20" args="(f32 val)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void irr::gui::IGUISpinBox::setValue </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> </td> <td class="paramname"> <em>val</em> </td> <td> ) </td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> set the current value of the spinbox <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>val,:</em> </td><td>value to be set in the spinbox </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_spin_box_8h-source.html">IGUISpinBox.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:11 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>