1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::SliderWindowRenderer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1SliderWindowRenderer.html">SliderWindowRenderer</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::SliderWindowRenderer Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::SliderWindowRenderer" --><!-- doxytag: inherits="CEGUI::WindowRenderer" -->
<p>Base class for <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> window renderer objects.
<a href="classCEGUI_1_1SliderWindowRenderer.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::SliderWindowRenderer:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1SliderWindowRenderer__inherit__graph.gif" border="0" usemap="#CEGUI_1_1SliderWindowRenderer_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1SliderWindowRenderer_inherit__map" id="CEGUI_1_1SliderWindowRenderer_inherit__map">
<area shape="rect" id="node5" href="classCEGUI_1_1FalagardSlider.html" title="Slider class for the FalagardBase module." alt="" coords="31,160,185,189"/><area shape="rect" id="node2" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object." alt="" coords="21,5,195,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::SliderWindowRenderer:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1SliderWindowRenderer__coll__graph.gif" border="0" usemap="#CEGUI_1_1SliderWindowRenderer_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1SliderWindowRenderer_coll__map" id="CEGUI_1_1SliderWindowRenderer_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object." alt="" coords="109,199,283,228"/><area shape="rect" id="node6" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv..." alt="" coords="235,387,355,416"/><area shape="rect" id="node4" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="259,5,365,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1SliderWindowRenderer-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac514e664abf773c89981192c88026781"></a><!-- doxytag: member="CEGUI::SliderWindowRenderer::SliderWindowRenderer" ref="ac514e664abf773c89981192c88026781" args="(const String &name)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1SliderWindowRenderer.html#ac514e664abf773c89981192c88026781">SliderWindowRenderer</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e36ab47630e37db373c5b9dc4b8156b"></a><!-- doxytag: member="CEGUI::SliderWindowRenderer::updateThumb" ref="a3e36ab47630e37db373c5b9dc4b8156b" args="(void)=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1SliderWindowRenderer.html#a3e36ab47630e37db373c5b9dc4b8156b">updateThumb</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">update the size and location of the thumb to properly represent the current state of the slider <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1SliderWindowRenderer.html#a6771ce073febd43a565244a952b819b8">getValueFromThumb</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return value that best represents current slider value given the current location of the thumb. <a href="#a6771ce073febd43a565244a952b819b8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1SliderWindowRenderer.html#a21dd3c0d81ed3b5e6589bee323638618">getAdjustDirectionFromPoint</a> (const <a class="el" href="classCEGUI_1_1Vector2.html">Point</a> &pt) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Given window location <em>pt</em>, return a value indicating what change should be made to the slider. <a href="#a21dd3c0d81ed3b5e6589bee323638618"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class for <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> window renderer objects. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a21dd3c0d81ed3b5e6589bee323638618"></a><!-- doxytag: member="CEGUI::SliderWindowRenderer::getAdjustDirectionFromPoint" ref="a21dd3c0d81ed3b5e6589bee323638618" args="(const Point &pt) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float CEGUI::SliderWindowRenderer::getAdjustDirectionFromPoint </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Vector2.html">Point</a> & </td>
<td class="paramname"><em>pt</em></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Given window location <em>pt</em>, return a value indicating what change should be made to the slider. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pt</td><td>Point object describing a pixel position in window space.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>-1 to indicate slider should be moved to a lower setting.</li>
<li>0 to indicate slider should not be moved.</li>
<li>+1 to indicate slider should be moved to a higher setting. </li>
</ul>
</dd></dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1FalagardSlider.html#a511e0a711308dcdb9dc4f7b172df2c9c">CEGUI::FalagardSlider</a>.</p>
</div>
</div>
<a class="anchor" id="a6771ce073febd43a565244a952b819b8"></a><!-- doxytag: member="CEGUI::SliderWindowRenderer::getValueFromThumb" ref="a6771ce073febd43a565244a952b819b8" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float CEGUI::SliderWindowRenderer::getValueFromThumb </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return value that best represents current slider value given the current location of the thumb. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>float value that, given the thumb widget position, best represents the current value for the slider. </dd></dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1FalagardSlider.html#a9b42c0edd297421d3964413e7ac42103">CEGUI::FalagardSlider</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|