252 lines
12 KiB
HTML
Executable File
252 lines
12 KiB
HTML
Executable File
<!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>Gewi::GSlider class Reference</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.3 -->
|
|
<center>
|
|
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> </center>
|
|
<hr><h1>Gewi::GSlider Class Reference</h1><code>#include <<a class="el" href="GewiSlider_8h-source.html">GewiSlider.h</a>></code>
|
|
<p>
|
|
Inherits <a class="el" href="classGewi_1_1GWidget.html">Gewi::GWidget</a>.
|
|
<p>
|
|
Inherited by <a class="el" href="classGewi_1_1GHorizSlider.html">Gewi::GHorizSlider</a>, and <a class="el" href="classGewi_1_1GVertSlider.html">Gewi::GVertSlider</a>.
|
|
<p>
|
|
<a href="classGewi_1_1GSlider-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
Framework for simple slider widget, virtual (fails to overload Show), derived from <a class="el" href="classGewi_1_1GWidget.html">GWidget</a>.
|
|
<p>
|
|
<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 nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classGewi_1_1GSlider.html#a0">GSlider</a> (<a class="el" href="classGewi_1_1GContainer.html">GContainer</a> *parent=NULL)</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Simple constructor for <a class="el" href="classGewi_1_1GSlider.html">GSlider</a>.</em> <a href="#a0"></a><em></em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classGewi_1_1GSlider.html#a1">Create</a> (float x, float y, float width, float height, <a class="el" href="namespaceGewi.html#a2">ResourceID</a> backgroundImg, <a class="el" href="namespaceGewi.html#a2">ResourceID</a> sliderImg, float min, float max, int increment)</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">GSlider's create function, must be called to set up actual slider.</em> <a href="#a1"></a><em></em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classGewi_1_1GSlider.html#a2">SetPos</a> (float pos)</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Set position of slider.</em> <a href="#a2"></a><em></em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>float </td><td valign=bottom><a class="el" href="classGewi_1_1GSlider.html#a3">GetPos</a> ()</td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Get position of slider.</em> <a href="#a3"></a><em></em><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="n0" doxytag="Gewi::GSlider::rPressed"></a>
|
|
bool </td><td valign=bottom><a class="el" href="classGewi_1_1GSlider.html#n0">rPressed</a></td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Boolean value holding if slider is currently 'pressed' or active.</em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="n1" doxytag="Gewi::GSlider::rBackground"></a>
|
|
<a class="el" href="namespaceGewi.html#a2">ResourceID</a> </td><td valign=bottom><a class="el" href="classGewi_1_1GSlider.html#n1">rBackground</a></td></tr>
|
|
<tr><td> </td><td><em class="mdesc">ID for background image for slider.</em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="n2" doxytag="Gewi::GSlider::rSlider"></a>
|
|
<a class="el" href="namespaceGewi.html#a2">ResourceID</a> </td><td valign=bottom><a class="el" href="classGewi_1_1GSlider.html#n2">rSlider</a></td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Image ID for the sliding part of the slider.</em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="n3" doxytag="Gewi::GSlider::rMin"></a>
|
|
float </td><td valign=bottom><a class="el" href="classGewi_1_1GSlider.html#n3">rMin</a></td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Minimum position for slider.</em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="n4" doxytag="Gewi::GSlider::rMax"></a>
|
|
float </td><td valign=bottom><a class="el" href="classGewi_1_1GSlider.html#n4">rMax</a></td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Maximum position for slider.</em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="n5" doxytag="Gewi::GSlider::rPos"></a>
|
|
float </td><td valign=bottom><a class="el" href="classGewi_1_1GSlider.html#n5">rPos</a></td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Current position of slider.</em><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="n6" doxytag="Gewi::GSlider::rIncrement"></a>
|
|
int </td><td valign=bottom><a class="el" href="classGewi_1_1GSlider.html#n6">rIncrement</a></td></tr>
|
|
<tr><td> </td><td><em class="mdesc">Movement snap increment.</em><br><br></td></tr>
|
|
</table>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a name="a0" doxytag="Gewi::GSlider::GSlider"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> Gewi::GSlider::GSlider </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classGewi_1_1GContainer.html">GContainer</a> * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>parent</em> = NULL </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Default constructor for <a class="el" href="classGewi_1_1GSlider.html">GSlider</a>, can take a parent. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>parent</em> </td><td>Pointer to <a class="el" href="classGewi_1_1GContainer.html">GContainer</a> derived class to be the parent. Default value is NULL which means no parent. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a name="a1" doxytag="Gewi::GSlider::Create"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void Gewi::GSlider::Create </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">float </td>
|
|
<td class="mdname" nowrap> <em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>float </td>
|
|
<td class="mdname" nowrap> <em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>float </td>
|
|
<td class="mdname" nowrap> <em>width</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>float </td>
|
|
<td class="mdname" nowrap> <em>height</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap><a class="el" href="namespaceGewi.html#a2">ResourceID</a> </td>
|
|
<td class="mdname" nowrap> <em>backgroundImg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap><a class="el" href="namespaceGewi.html#a2">ResourceID</a> </td>
|
|
<td class="mdname" nowrap> <em>sliderImg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>float </td>
|
|
<td class="mdname" nowrap> <em>min</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>float </td>
|
|
<td class="mdname" nowrap> <em>max</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>int </td>
|
|
<td class="mdname" nowrap> <em>increment</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Every widget has a create function which must be called to define the button's appearance and settings. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>x</em> </td><td>X position of widget within it's container (entire screen if no parent) </td></tr>
|
|
<tr><td valign=top><em>y</em> </td><td>Y position of widget within it's container (entire screen if no parent) </td></tr>
|
|
<tr><td valign=top><em>width</em> </td><td>Width of widget. </td></tr>
|
|
<tr><td valign=top><em>height</em> </td><td>Height of widget. </td></tr>
|
|
<tr><td valign=top><em>backgroundImg</em> </td><td>Image for stationary portion of slider. </td></tr>
|
|
<tr><td valign=top><em>sliderImg</em> </td><td>Image for moving portion of slider. </td></tr>
|
|
<tr><td valign=top><em>min</em> </td><td>Minimum value on slider. </td></tr>
|
|
<tr><td valign=top><em>max</em> </td><td>Maximum value on slider. </td></tr>
|
|
<tr><td valign=top><em>increment</em> </td><td>Slider snap-to increment. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a2" doxytag="Gewi::GSlider::SetPos"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void Gewi::GSlider::SetPos </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">float </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>pos</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Sets position of slider, will snap within bounds. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>pos</em> </td><td>Desired position. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a3" doxytag="Gewi::GSlider::GetPos"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> float Gewi::GSlider::GetPos </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Access current position of slider. <dl compact><dt><b>Returns:</b></dt><dd>Slider position. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following files:<ul>
|
|
<li>/include/<a class="el" href="GewiSlider_8h-source.html">GewiSlider.h</a><li>/src/<a class="el" href="GewiSlider_8cpp.html">GewiSlider.cpp</a></ul>
|
|
<hr><address style="align: right;"><small>Generated on Mon Jun 16 03:27:18 2003 for Gewi by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border=0
|
|
width=110 height=53></a>1.3 </small></address>
|
|
</body>
|
|
</html>
|