<!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::IGUIScrollBar 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_scroll_bar.html">IGUIScrollBar</a> </div> <div class="contents"> <h1>irr::gui::IGUIScrollBar Class Reference</h1><!-- doxytag: class="irr::gui::IGUIScrollBar" --><!-- doxytag: inherits="irr::gui::IGUIElement" -->Default scroll bar GUI element. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="_i_g_u_i_scroll_bar_8h-source.html">IGUIScrollBar.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for irr::gui::IGUIScrollBar:</div> <div class="dynsection"> <p><center><img src="classirr_1_1gui_1_1_i_g_u_i_scroll_bar.png" usemap="#irr::gui::IGUIScrollBar_map" border="0" alt=""></center> <map name="irr::gui::IGUIScrollBar_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_scroll_bar-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#c66849b7a6ed16e30ebede579f9b47c6">s32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_scroll_bar.html#791668bbe49a3b6bf89f7dcd8eb286b8">getLargeStep</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">gets the large step value <a href="#791668bbe49a3b6bf89f7dcd8eb286b8"></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_scroll_bar.html#f66eec810b46916d9bbe4aab58ecce95">getMax</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">gets the maximum value of the scrollbar. <a href="#f66eec810b46916d9bbe4aab58ecce95"></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_scroll_bar.html#ad9e0e40c540211d2680f1b2f963733c">getMin</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">gets the maximum value of the scrollbar. <a href="#ad9e0e40c540211d2680f1b2f963733c"></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_scroll_bar.html#d11122ee5eafc429c4e1b7710514f90b">getPos</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">gets the current position of the scrollbar <a href="#d11122ee5eafc429c4e1b7710514f90b"></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_scroll_bar.html#7c838c17236ae5012569b273251c1b18">getSmallStep</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">gets the small step value <a href="#7c838c17236ae5012569b273251c1b18"></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_scroll_bar.html#350c657e1cd95ddb566570e7759ff886">IGUIScrollBar</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="#350c657e1cd95ddb566570e7759ff886"></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_scroll_bar.html#2872ee4bc49bb26c979b4c891c567ab2">setLargeStep</a> (<a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> step)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the large step. <a href="#2872ee4bc49bb26c979b4c891c567ab2"></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_scroll_bar.html#0d07ab631a8aa6e8edbdfa65250cd556">setMax</a> (<a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> max)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">sets the maximum value of the scrollbar. <a href="#0d07ab631a8aa6e8edbdfa65250cd556"></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_scroll_bar.html#7d24132c60a7a8196e3135121da8387d">setMin</a> (<a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> max)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">sets the maximum value of the scrollbar. <a href="#7d24132c60a7a8196e3135121da8387d"></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_scroll_bar.html#62609bf3b076a16afeb6e67072a8ea13">setPos</a> (<a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> pos)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">sets the current position of the scrollbar <a href="#62609bf3b076a16afeb6e67072a8ea13"></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_scroll_bar.html#a85963aba6c9ac21a885fcab3eab3b20">setSmallStep</a> (<a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> step)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the small step. <a href="#a85963aba6c9ac21a885fcab3eab3b20"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Default scroll bar GUI element. <p>Definition at line <a class="el" href="_i_g_u_i_scroll_bar_8h-source.html#l00016">16</a> of file <a class="el" href="_i_g_u_i_scroll_bar_8h-source.html">IGUIScrollBar.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="350c657e1cd95ddb566570e7759ff886"></a><!-- doxytag: member="irr::gui::IGUIScrollBar::IGUIScrollBar" ref="350c657e1cd95ddb566570e7759ff886" 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::IGUIScrollBar::IGUIScrollBar </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_scroll_bar_8h-source.html#l00021">21</a> of file <a class="el" href="_i_g_u_i_scroll_bar_8h-source.html">IGUIScrollBar.h</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="791668bbe49a3b6bf89f7dcd8eb286b8"></a><!-- doxytag: member="irr::gui::IGUIScrollBar::getLargeStep" ref="791668bbe49a3b6bf89f7dcd8eb286b8" 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::IGUIScrollBar::getLargeStep </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> gets the large step value <p> </div> </div><p> <a class="anchor" name="f66eec810b46916d9bbe4aab58ecce95"></a><!-- doxytag: member="irr::gui::IGUIScrollBar::getMax" ref="f66eec810b46916d9bbe4aab58ecce95" 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::IGUIScrollBar::getMax </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> gets the maximum value of the scrollbar. <p> </div> </div><p> <a class="anchor" name="ad9e0e40c540211d2680f1b2f963733c"></a><!-- doxytag: member="irr::gui::IGUIScrollBar::getMin" ref="ad9e0e40c540211d2680f1b2f963733c" 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::IGUIScrollBar::getMin </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> gets the maximum value of the scrollbar. <p> </div> </div><p> <a class="anchor" name="d11122ee5eafc429c4e1b7710514f90b"></a><!-- doxytag: member="irr::gui::IGUIScrollBar::getPos" ref="d11122ee5eafc429c4e1b7710514f90b" 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::IGUIScrollBar::getPos </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> gets the current position of the scrollbar <p> </div> </div><p> <a class="anchor" name="7c838c17236ae5012569b273251c1b18"></a><!-- doxytag: member="irr::gui::IGUIScrollBar::getSmallStep" ref="7c838c17236ae5012569b273251c1b18" 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::IGUIScrollBar::getSmallStep </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> gets the small step value <p> </div> </div><p> <a class="anchor" name="2872ee4bc49bb26c979b4c891c567ab2"></a><!-- doxytag: member="irr::gui::IGUIScrollBar::setLargeStep" ref="2872ee4bc49bb26c979b4c891c567ab2" args="(s32 step)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void irr::gui::IGUIScrollBar::setLargeStep </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> </td> <td class="paramname"> <em>step</em> </td> <td> ) </td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Sets the large step. <p> That is the amount that the value changes by when clicking in the tray, or using the page up and page down keys. </div> </div><p> <a class="anchor" name="0d07ab631a8aa6e8edbdfa65250cd556"></a><!-- doxytag: member="irr::gui::IGUIScrollBar::setMax" ref="0d07ab631a8aa6e8edbdfa65250cd556" args="(s32 max)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void irr::gui::IGUIScrollBar::setMax </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> </td> <td class="paramname"> <em>max</em> </td> <td> ) </td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> sets the maximum value of the scrollbar. <p> </div> </div><p> <a class="anchor" name="7d24132c60a7a8196e3135121da8387d"></a><!-- doxytag: member="irr::gui::IGUIScrollBar::setMin" ref="7d24132c60a7a8196e3135121da8387d" args="(s32 max)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void irr::gui::IGUIScrollBar::setMin </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> </td> <td class="paramname"> <em>max</em> </td> <td> ) </td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> sets the maximum value of the scrollbar. <p> </div> </div><p> <a class="anchor" name="62609bf3b076a16afeb6e67072a8ea13"></a><!-- doxytag: member="irr::gui::IGUIScrollBar::setPos" ref="62609bf3b076a16afeb6e67072a8ea13" args="(s32 pos)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void irr::gui::IGUIScrollBar::setPos </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> </td> <td class="paramname"> <em>pos</em> </td> <td> ) </td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> sets the current position of the scrollbar <p> </div> </div><p> <a class="anchor" name="a85963aba6c9ac21a885fcab3eab3b20"></a><!-- doxytag: member="irr::gui::IGUIScrollBar::setSmallStep" ref="a85963aba6c9ac21a885fcab3eab3b20" args="(s32 step)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void irr::gui::IGUIScrollBar::setSmallStep </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> </td> <td class="paramname"> <em>step</em> </td> <td> ) </td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Sets the small step. <p> That is the amount that the value changes by when clicking on the buttons or using the cursor keys. </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_scroll_bar_8h-source.html">IGUIScrollBar.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>