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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
|
<!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::ScrolledItemListBase 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_1ScrolledItemListBase.html">ScrolledItemListBase</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> </div>
<div class="headertitle">
<div class="title">CEGUI::ScrolledItemListBase Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::ScrolledItemListBase" --><!-- doxytag: inherits="CEGUI::ItemListBase" -->
<p><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html" title="ScrolledItemListBase window class.">ScrolledItemListBase</a> window class.
<a href="classCEGUI_1_1ScrolledItemListBase.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::ScrolledItemListBase:</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_1ScrolledItemListBase__inherit__graph.gif" border="0" usemap="#CEGUI_1_1ScrolledItemListBase_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1ScrolledItemListBase_inherit__map" id="CEGUI_1_1ScrolledItemListBase_inherit__map">
<area shape="rect" id="node5" href="classCEGUI_1_1ItemListbox.html" title="ItemListbox window class." alt="" coords="33,160,175,189"/><area shape="rect" id="node2" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets." alt="" coords="29,5,179,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::ScrolledItemListBase:</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_1ScrolledItemListBase__coll__graph.gif" border="0" usemap="#CEGUI_1_1ScrolledItemListBase_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1ScrolledItemListBase_coll__map" id="CEGUI_1_1ScrolledItemListBase_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ItemListBase.html" title="Base class for item list widgets." alt="" coords="119,5,268,35"/><area shape="rect" id="node4" href="classCEGUI_1_1ScrolledItemListBaseProperties_1_1ForceVertScrollbar.html" title="Property to access the state of the force vertical scrollbar setting." alt="" coords="8,59,379,88"/><area shape="rect" id="node6" href="classCEGUI_1_1ScrolledItemListBaseProperties_1_1ForceHorzScrollbar.html" title="Property to access the state of the force horizontal scrollbar setting." alt="" coords="5,112,381,141"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1ScrolledItemListBase-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="a160eb62270c99e62cf3212c06dd3c433"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::isVertScrollbarAlwaysShown" ref="a160eb62270c99e62cf3212c06dd3c433" args="(void) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a160eb62270c99e62cf3212c06dd3c433">isVertScrollbarAlwaysShown</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the vertical scrollbar is being forced visible. Despite content size. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9532247127a3ca81c7fc839a244df7c9"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::isHorzScrollbarAlwaysShown" ref="a9532247127a3ca81c7fc839a244df7c9" args="(void) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a9532247127a3ca81c7fc839a244df7c9">isHorzScrollbarAlwaysShown</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the horizontal scrollbar is being forced visible. Despite content size. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0cf9a7285e52781f04057e8e741dbd88"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::getVertScrollbar" ref="a0cf9a7285e52781f04057e8e741dbd88" args="() const " -->
<a class="el" href="classCEGUI_1_1Scrollbar.html">Scrollbar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a0cf9a7285e52781f04057e8e741dbd88">getVertScrollbar</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the vertical scrollbar component attached to this window. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf7f2316fdb297d2451430515ab9e1b8"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::getHorzScrollbar" ref="abf7f2316fdb297d2451430515ab9e1b8" args="() const " -->
<a class="el" href="classCEGUI_1_1Scrollbar.html">Scrollbar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#abf7f2316fdb297d2451430515ab9e1b8">getHorzScrollbar</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the horizontal scrollbar component attached to this window. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42e1e5540915994928badab9dc45489e"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::setShowVertScrollbar" ref="a42e1e5540915994928badab9dc45489e" args="(bool mode)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a42e1e5540915994928badab9dc45489e">setShowVertScrollbar</a> (bool mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the vertical scrollbar should be forced visible. Despite content size. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d391193cfe6c7732f5743807d91151a"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::setShowHorzScrollbar" ref="a2d391193cfe6c7732f5743807d91151a" args="(bool mode)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a2d391193cfe6c7732f5743807d91151a">setShowHorzScrollbar</a> (bool mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the horizontal scrollbar should be forced visible. Despite content size. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a035d2dd97aea40497fb1c79a207c0dfb">ensureItemIsVisibleVert</a> (const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> &item)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Scroll the vertical list position if needed to ensure that the <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> <em>item</em> is, if possible, fully visible witin the <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html" title="ScrolledItemListBase window class.">ScrolledItemListBase</a> viewable area. <a href="#a035d2dd97aea40497fb1c79a207c0dfb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a757c02aa5c0823e245d3452f97338e89">ensureItemIsVisibleHorz</a> (const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> &item)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Scroll the horizontal list position if needed to ensure that the <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> <em>item</em> is, if possible, fully visible witin the <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html" title="ScrolledItemListBase window class.">ScrolledItemListBase</a> viewable area. <a href="#a757c02aa5c0823e245d3452f97338e89"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cdd5b57bf28cb9a23fdee677411a337"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::ScrolledItemListBase" ref="a7cdd5b57bf28cb9a23fdee677411a337" args="(const String &type, const String &name)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a7cdd5b57bf28cb9a23fdee677411a337">ScrolledItemListBase</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &type, const <a class="el" href="classCEGUI_1_1String.html">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for the <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html" title="ScrolledItemListBase window class.">ScrolledItemListBase</a> base class constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55a16ca96956e2987116874733864d81"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::~ScrolledItemListBase" ref="a55a16ca96956e2987116874733864d81" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a55a16ca96956e2987116874733864d81">~ScrolledItemListBase</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for the <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html" title="ScrolledItemListBase window class.">ScrolledItemListBase</a> base class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a8b5cf75ac98200ad3c425589ff6d7d4d">initialiseComponents</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialise the <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> based object ready for use. <a href="#a8b5cf75ac98200ad3c425589ff6d7d4d"></a><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="a301a5110959732f9e91013c54ec8a9d3"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::EventNamespace" ref="a301a5110959732f9e91013c54ec8a9d3" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a301a5110959732f9e91013c54ec8a9d3">EventNamespace</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Namespace for global events. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4cd7730a86620ba097080021a745582"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::VertScrollbarNameSuffix" ref="ad4cd7730a86620ba097080021a745582" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#ad4cd7730a86620ba097080021a745582">VertScrollbarNameSuffix</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name suffix for vertical scrollbar component. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7fb13d9c68f34248638d567dd6f2ab17"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::HorzScrollbarNameSuffix" ref="a7fb13d9c68f34248638d567dd6f2ab17" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a7fb13d9c68f34248638d567dd6f2ab17">HorzScrollbarNameSuffix</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name suffix for horizontal scrollbar component. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3cdd92875e3c29421ea18ba53fcef9ec"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::ContentPaneNameSuffix" ref="a3cdd92875e3c29421ea18ba53fcef9ec" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a3cdd92875e3c29421ea18ba53fcef9ec">ContentPaneNameSuffix</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name suffix for the content pane component. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a1d1636d7130c16d6b0c44dcc93364da1">EventVertScrollbarModeChanged</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a12153c312b1c4bc6a4549d3325f8c6e6">EventHorzScrollbarModeChanged</a></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">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#abec44d48bbc7cf23c4e24314a4a91959">testClassName_impl</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &class_name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. <a href="#abec44d48bbc7cf23c4e24314a4a91959"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b006c4292e642ddd326e34ddca6f5ba"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::configureScrollbars" ref="a8b006c4292e642ddd326e34ddca6f5ba" args="(const Size &doc_size)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a8b006c4292e642ddd326e34ddca6f5ba">configureScrollbars</a> (const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &doc_size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Configure scrollbars. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6e1c3d089fdd5e147eb19f5d9e95a22"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::onVertScrollbarModeChanged" ref="ac6e1c3d089fdd5e147eb19f5d9e95a22" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>onVertScrollbarModeChanged</b> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39b1c048f95571a161c4331bd1cd30c2"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::onHorzScrollbarModeChanged" ref="a39b1c048f95571a161c4331bd1cd30c2" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>onHorzScrollbarModeChanged</b> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#ace4aa4a85d2639b943144fe5e61814e2">onMouseWheel</a> (<a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler called when the mouse wheel (z-axis) position changes within this window's area. <a href="#ace4aa4a85d2639b943144fe5e61814e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac39824051b3f04138c4dd6ac8b2d4995"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::handle_VScroll" ref="ac39824051b3f04138c4dd6ac8b2d4995" args="(const EventArgs &e)" -->
bool </td><td class="memItemRight" valign="bottom"><b>handle_VScroll</b> (const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &e)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a200b01ef99349e72731d006ec5c1b966"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::handle_HScroll" ref="a200b01ef99349e72731d006ec5c1b966" args="(const EventArgs &e)" -->
bool </td><td class="memItemRight" valign="bottom"><b>handle_HScroll</b> (const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &e)</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="a457c24002d9dba1d5592ed237f8273d8"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::d_forceVScroll" ref="a457c24002d9dba1d5592ed237f8273d8" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>d_forceVScroll</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae5978e283624d6592f947b03fc4bab65"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::d_forceHScroll" ref="ae5978e283624d6592f947b03fc4bab65" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>d_forceHScroll</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_1ScrolledItemListBase.html" title="ScrolledItemListBase window class.">ScrolledItemListBase</a> window class. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a757c02aa5c0823e245d3452f97338e89"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::ensureItemIsVisibleHorz" ref="a757c02aa5c0823e245d3452f97338e89" args="(const ItemEntry &item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ScrolledItemListBase::ensureItemIsVisibleHorz </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> & </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Scroll the horizontal list position if needed to ensure that the <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> <em>item</em> is, if possible, fully visible witin the <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html" title="ScrolledItemListBase window class.">ScrolledItemListBase</a> viewable area. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">item</td><td>const reference to an <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> attached to this <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html" title="ScrolledItemListBase window class.">ScrolledItemListBase</a> that should be made visible in the view area.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a035d2dd97aea40497fb1c79a207c0dfb"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::ensureItemIsVisibleVert" ref="a035d2dd97aea40497fb1c79a207c0dfb" args="(const ItemEntry &item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ScrolledItemListBase::ensureItemIsVisibleVert </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1ItemEntry.html">ItemEntry</a> & </td>
<td class="paramname"><em>item</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Scroll the vertical list position if needed to ensure that the <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> <em>item</em> is, if possible, fully visible witin the <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html" title="ScrolledItemListBase window class.">ScrolledItemListBase</a> viewable area. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">item</td><td>const reference to an <a class="el" href="classCEGUI_1_1ItemEntry.html" title="Base class for item type widgets.">ItemEntry</a> attached to this <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html" title="ScrolledItemListBase window class.">ScrolledItemListBase</a> that should be made visible in the view area.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a8b5cf75ac98200ad3c425589ff6d7d4d"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::initialiseComponents" ref="a8b5cf75ac98200ad3c425589ff6d7d4d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ScrolledItemListBase::initialiseComponents </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialise the <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> based object ready for use. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This must be called for every window created. Normally this is handled automatically by the <a class="el" href="classCEGUI_1_1WindowFactory.html" title="Abstract class that defines the required interface for all WindowFactory objects.">WindowFactory</a> for each <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> type.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1ItemListBase.html#ab61cc9fea4017e9a5e131910810d741f">CEGUI::ItemListBase</a>.</p>
<p>Reimplemented in <a class="el" href="classCEGUI_1_1ItemListbox.html#a7ff27cd96add3373ac69fe7b08ca4f38">CEGUI::ItemListbox</a>.</p>
</div>
</div>
<a class="anchor" id="ace4aa4a85d2639b943144fe5e61814e2"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::onMouseWheel" ref="ace4aa4a85d2639b943144fe5e61814e2" args="(MouseEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::ScrolledItemListBase::onMouseWheel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> & </td>
<td class="paramname"><em>e</em></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handler called when the mouse wheel (z-axis) position changes within this window's area. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1MouseEventArgs.html" title="EventArgs based class that is used for objects passed to input event handlers concerning mouse input...">MouseEventArgs</a> object. All fields are valid. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a56aa0b4041705f88b3191c2d5adac79b">CEGUI::Window</a>.</p>
</div>
</div>
<a class="anchor" id="abec44d48bbc7cf23c4e24314a4a91959"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::testClassName_impl" ref="abec44d48bbc7cf23c4e24314a4a91959" args="(const String &class_name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::ScrolledItemListBase::testClassName_impl </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>class_name</em></td><td>)</td>
<td> const<code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">class_name</td><td>The class name that is to be checked.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this window was inherited from <em>class_name</em>. false if not. </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1ItemListBase.html#a9c26c62516fd505f667c8a7c19338691">CEGUI::ItemListBase</a>.</p>
<p>Reimplemented in <a class="el" href="classCEGUI_1_1ItemListbox.html#a11c85f7abb6010a055e928ae2c5f9645">CEGUI::ItemListbox</a>.</p>
<p>References <a class="el" href="classCEGUI_1_1ItemListBase.html#a9c26c62516fd505f667c8a7c19338691">CEGUI::ItemListBase::testClassName_impl()</a>.</p>
<p>Referenced by <a class="el" href="classCEGUI_1_1ItemListbox.html#a11c85f7abb6010a055e928ae2c5f9645">CEGUI::ItemListbox::testClassName_impl()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a12153c312b1c4bc6a4549d3325f8c6e6"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::EventHorzScrollbarModeChanged" ref="a12153c312b1c4bc6a4549d3325f8c6e6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a12153c312b1c4bc6a4549d3325f8c6e6">CEGUI::ScrolledItemListBase::EventHorzScrollbarModeChanged</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> fired when the horizontal scroll bar mode change. Handlers are passed a const <a class="el" href="classCEGUI_1_1WindowEventArgs.html" title="EventArgs based class that is used for objects passed to handlers triggered for events concerning som...">WindowEventArgs</a> reference with <a class="el" href="classCEGUI_1_1WindowEventArgs.html#a5817b522882b9648d445a20b8c354966" title="pointer to a Window object of relevance to the event.">WindowEventArgs::window</a> set to the <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html" title="ScrolledItemListBase window class.">ScrolledItemListBase</a> whose horizontal scroll bar mode has been changed. </p>
</div>
</div>
<a class="anchor" id="a1d1636d7130c16d6b0c44dcc93364da1"></a><!-- doxytag: member="CEGUI::ScrolledItemListBase::EventVertScrollbarModeChanged" ref="a1d1636d7130c16d6b0c44dcc93364da1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html#a1d1636d7130c16d6b0c44dcc93364da1">CEGUI::ScrolledItemListBase::EventVertScrollbarModeChanged</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> fired when the vertical scroll bar mode changes. Handlers are passed a const <a class="el" href="classCEGUI_1_1WindowEventArgs.html" title="EventArgs based class that is used for objects passed to handlers triggered for events concerning som...">WindowEventArgs</a> reference with <a class="el" href="classCEGUI_1_1WindowEventArgs.html#a5817b522882b9648d445a20b8c354966" title="pointer to a Window object of relevance to the event.">WindowEventArgs::window</a> set to the <a class="el" href="classCEGUI_1_1ScrolledItemListBase.html" title="ScrolledItemListBase window class.">ScrolledItemListBase</a> whose vertical scroll bar mode has been changed. </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 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>
|
