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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
<!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::FalagardScrollbar 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_1FalagardScrollbar.html">FalagardScrollbar</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pro-static-attribs">Static Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::FalagardScrollbar Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::FalagardScrollbar" --><!-- doxytag: inherits="CEGUI::ScrollbarWindowRenderer" -->
<p><a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> class for the FalagardBase module.
<a href="classCEGUI_1_1FalagardScrollbar.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::FalagardScrollbar:</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_1FalagardScrollbar__inherit__graph.gif" border="0" usemap="#CEGUI_1_1FalagardScrollbar_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1FalagardScrollbar_inherit__map" id="CEGUI_1_1FalagardScrollbar_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ScrollbarWindowRenderer.html" title="Base class for Scrollbar window renderer objects." alt="" coords="5,83,229,112"/><area shape="rect" id="node4" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object." alt="" coords="31,5,204,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::FalagardScrollbar:</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_1FalagardScrollbar__coll__graph.gif" border="0" usemap="#CEGUI_1_1FalagardScrollbar_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1FalagardScrollbar_coll__map" id="CEGUI_1_1FalagardScrollbar_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ScrollbarWindowRenderer.html" title="Base class for Scrollbar window renderer objects." alt="" coords="285,5,509,35"/><area shape="rect" id="node4" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object." alt="" coords="5,5,179,35"/><area shape="rect" id="node6" href="classCEGUI_1_1FalagardScrollbarProperties_1_1VerticalScrollbar.html" title="Property to access the setting that controls whether the scrollbar is horizontal or vertical..." alt="" coords="229,59,565,88"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1FalagardScrollbar-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardScrollbar.html#a18cd179825a1c92d9b0d718691b9b8a1">FalagardScrollbar</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">type name for this widget. <a href="#a18cd179825a1c92d9b0d718691b9b8a1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afcd7ecf1c7d0412ced738f438901d5d5"></a><!-- doxytag: member="CEGUI::FalagardScrollbar::isVertical" ref="afcd7ecf1c7d0412ced738f438901d5d5" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><b>isVertical</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a604b289cdd76a14ab2df3d5fcd6eb474"></a><!-- doxytag: member="CEGUI::FalagardScrollbar::setVertical" ref="a604b289cdd76a14ab2df3d5fcd6eb474" args="(bool setting)" -->
void </td><td class="memItemRight" valign="bottom"><b>setVertical</b> (bool setting)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardScrollbar.html#af5cd5710f1d76b90dd45ac4e7d808a7b">render</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Populate render cache. <a href="#af5cd5710f1d76b90dd45ac4e7d808a7b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef1372833a98aa9091cb3774bbd97665"></a><!-- doxytag: member="CEGUI::FalagardScrollbar::performChildWindowLayout" ref="aef1372833a98aa9091cb3774bbd97665" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardScrollbar.html#aef1372833a98aa9091cb3774bbd97665">performChildWindowLayout</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Method called to perform extended laying out of the window's attached child windows. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac137313d80efdd8aac89309332df362f"></a><!-- doxytag: member="CEGUI::FalagardScrollbar::TypeName" ref="ac137313d80efdd8aac89309332df362f" args="[]" -->
static const utf8 </td><td class="memItemRight" valign="bottom"><b>TypeName</b> []</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afdaea2bb2a09e89dbeedfec175d001d3"></a><!-- doxytag: member="CEGUI::FalagardScrollbar::updateThumb" ref="afdaea2bb2a09e89dbeedfec175d001d3" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardScrollbar.html#afdaea2bb2a09e89dbeedfec175d001d3">updateThumb</a> (void)</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 scroll bar <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardScrollbar.html#a25466821aea253a5ec841967776e9a5c">getValueFromThumb</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return value that best represents current scroll bar position given the current location of the thumb. <a href="#a25466821aea253a5ec841967776e9a5c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardScrollbar.html#a0bf5de247c98e23c3bfc139f0333d218">getAdjustDirectionFromPoint</a> (const <a class="el" href="classCEGUI_1_1Vector2.html">Point</a> &pt) const </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 scroll bar. <a href="#a0bf5de247c98e23c3bfc139f0333d218"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae14fa1f063d745b110e611b1cb0c91a2"></a><!-- doxytag: member="CEGUI::FalagardScrollbar::d_vertical" ref="ae14fa1f063d745b110e611b1cb0c91a2" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardScrollbar.html#ae14fa1f063d745b110e611b1cb0c91a2">d_vertical</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">True if slider operates in vertical direction. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab1558fe6fba9cfd1b3b50614acc7c1a4"></a><!-- doxytag: member="CEGUI::FalagardScrollbar::d_verticalProperty" ref="ab1558fe6fba9cfd1b3b50614acc7c1a4" args="" -->
static <br class="typebreak"/>
<a class="el" href="classCEGUI_1_1FalagardScrollbarProperties_1_1VerticalScrollbar.html">FalagardScrollbarProperties::VerticalScrollbar</a> </td><td class="memItemRight" valign="bottom"><b>d_verticalProperty</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> class for the FalagardBase module. </p>
<p>This class requires LookNFeel to be assigned. The LookNFeel should provide the following:</p>
<p>States:</p>
<ul>
<li>Enabled</li>
<li>Disabled</li>
</ul>
<p>Named Areas:</p>
<ul>
<li>ThumbTrackArea</li>
</ul>
<p>Child Widgets: <a class="el" href="classCEGUI_1_1Thumb.html" title="Base class for Thumb widget.">Thumb</a> based widget with name suffix "__auto_thumb__" <a class="el" href="classCEGUI_1_1PushButton.html" title="Base class to provide logic for push button type widgets.">PushButton</a> based widget with name suffix "__auto_incbtn__" <a class="el" href="classCEGUI_1_1PushButton.html" title="Base class to provide logic for push button type widgets.">PushButton</a> based widget with name suffix "__auto_decbtn__"</p>
<p><a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> initialiser definitions:</p>
<ul>
<li>VerticalScrollbar - boolean property. Indicates whether this scrollbar will operate in the vertical or horizontal direction. Default is for horizontal. Optional. </li>
</ul>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a18cd179825a1c92d9b0d718691b9b8a1"></a><!-- doxytag: member="CEGUI::FalagardScrollbar::FalagardScrollbar" ref="a18cd179825a1c92d9b0d718691b9b8a1" args="(const String &type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::FalagardScrollbar::FalagardScrollbar </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>type name for this widget. </p>
<p>Constructor </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0bf5de247c98e23c3bfc139f0333d218"></a><!-- doxytag: member="CEGUI::FalagardScrollbar::getAdjustDirectionFromPoint" ref="a0bf5de247c98e23c3bfc139f0333d218" args="(const Point &pt) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::FalagardScrollbar::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> [protected, 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 scroll bar. </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 scroll bar position should be moved to a lower value.</li>
<li>0 to indicate scroll bar position should not be changed.</li>
<li>+1 to indicate scroll bar position should be moved to a higher value. </li>
</ul>
</dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1ScrollbarWindowRenderer.html#a5f345e4a32540c9aa236e02d3d90ae05">CEGUI::ScrollbarWindowRenderer</a>.</p>
</div>
</div>
<a class="anchor" id="a25466821aea253a5ec841967776e9a5c"></a><!-- doxytag: member="CEGUI::FalagardScrollbar::getValueFromThumb" ref="a25466821aea253a5ec841967776e9a5c" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::FalagardScrollbar::getValueFromThumb </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return value that best represents current scroll bar position 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 position for the scroll bar. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1ScrollbarWindowRenderer.html#aa2ab8514af5756460752ba8625a22324">CEGUI::ScrollbarWindowRenderer</a>.</p>
</div>
</div>
<a class="anchor" id="af5cd5710f1d76b90dd45ac4e7d808a7b"></a><!-- doxytag: member="CEGUI::FalagardScrollbar::render" ref="af5cd5710f1d76b90dd45ac4e7d808a7b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardScrollbar::render </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Populate render cache. </p>
<p>This method must be implemented by all window renderers and should perform the rendering operations needed for this widget. Normally using the Falagard API... </p>
<p>Implements <a class="el" href="classCEGUI_1_1WindowRenderer.html#aafeb7dd00fe1e81f640fac257946ee66">CEGUI::WindowRenderer</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>
|
