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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
|
<!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::Scrollbar 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_1Scrollbar.html">Scrollbar</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::Scrollbar Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::Scrollbar" --><!-- doxytag: inherits="CEGUI::Window" -->
<p>Base scroll bar class.
<a href="classCEGUI_1_1Scrollbar.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::Scrollbar:</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_1Scrollbar__inherit__graph.gif" border="0" usemap="#CEGUI_1_1Scrollbar_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1Scrollbar_inherit__map" id="CEGUI_1_1Scrollbar_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv..." alt="" coords="16,83,136,112"/><area shape="rect" id="node4" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects." alt="" coords="5,5,147,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::Scrollbar:</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_1Scrollbar__coll__graph.gif" border="0" usemap="#CEGUI_1_1Scrollbar_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1Scrollbar_coll__map" id="CEGUI_1_1Scrollbar_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv..." alt="" coords="91,81,211,111"/><area shape="rect" id="node5" href="classCEGUI_1_1ScrollbarProperties_1_1PageSize.html" title="Property to access the page size for the Scrollbar." alt="" coords="28,135,273,164"/><area shape="rect" id="node7" href="classCEGUI_1_1ScrollbarProperties_1_1EndLockEnabled.html" title="Property to access the end lock mode setting for the Scrollbar." alt="" coords="7,188,295,217"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1Scrollbar-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">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a8b6ce07268e61e013a17089b1c8fb847">getDocumentSize</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the size of the document or data. <a href="#a8b6ce07268e61e013a17089b1c8fb847"></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_1Scrollbar.html#a4d8c169526487239eee110f9bc73428c">getPageSize</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the page size for this scroll bar. <a href="#a4d8c169526487239eee110f9bc73428c"></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_1Scrollbar.html#af5e6c21751359fc8323189ff95a2d2d2">getStepSize</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the step size for this scroll bar. <a href="#af5e6c21751359fc8323189ff95a2d2d2"></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_1Scrollbar.html#ad2a27a76a28578eb5ba7e1fa63b28f6d">getOverlapSize</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the overlap size for this scroll bar. <a href="#ad2a27a76a28578eb5ba7e1fa63b28f6d"></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_1Scrollbar.html#ad2f98f1d58641187b32c278ebfb8771d">getScrollPosition</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current position of scroll bar within the document. <a href="#ad2f98f1d58641187b32c278ebfb8771d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1PushButton.html">PushButton</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a5f0c15f93d66d34b222e5eef4bbc5e05">getIncreaseButton</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the 'increase' PushButtoncomponent widget for this <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a>. <a href="#a5f0c15f93d66d34b222e5eef4bbc5e05"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1PushButton.html">PushButton</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a83e25dc78484f3e63fac9e92d38d8435">getDecreaseButton</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the 'decrease' <a class="el" href="classCEGUI_1_1PushButton.html" title="Base class to provide logic for push button type widgets.">PushButton</a> component widget for this <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a>. <a href="#a83e25dc78484f3e63fac9e92d38d8435"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Thumb.html">Thumb</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a89c33813843ea0fac303dd5d7f9491b7">getThumb</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the <a class="el" href="classCEGUI_1_1Thumb.html" title="Base class for Thumb widget.">Thumb</a> component widget for this <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a>. <a href="#a89c33813843ea0fac303dd5d7f9491b7"></a><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_1Scrollbar.html#af41618525d5999a84b3234d238cf052e">initialiseComponents</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialises the <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> object ready for use. <a href="#af41618525d5999a84b3234d238cf052e"></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_1Scrollbar.html#ace8c71e43e7521ba8ced801a1ee0ffaa">setDocumentSize</a> (float document_size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the size of the document or data. <a href="#ace8c71e43e7521ba8ced801a1ee0ffaa"></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_1Scrollbar.html#a258f808d31e42fadae7dd4e2efc4f9e0">setPageSize</a> (float page_size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the page size for this scroll bar. <a href="#a258f808d31e42fadae7dd4e2efc4f9e0"></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_1Scrollbar.html#ac4773e81ba6a94c8e1e99955df20fca9">setStepSize</a> (float step_size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the step size for this scroll bar. <a href="#ac4773e81ba6a94c8e1e99955df20fca9"></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_1Scrollbar.html#a7401df8626bb696b25e9b37c7c7f4859">setOverlapSize</a> (float overlap_size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the overlap size for this scroll bar. <a href="#a7401df8626bb696b25e9b37c7c7f4859"></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_1Scrollbar.html#a0b432ab68a4fe91143cbc18828c7811e">setScrollPosition</a> (float position)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the current position of scroll bar within the document. <a href="#a0b432ab68a4fe91143cbc18828c7811e"></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_1Scrollbar.html#a506ab9709b851717a29f46d53f5c45d9">setConfig</a> (const float *const document_size, const float *const page_size, const float *const step_size, const float *const overlap_size, const float *const position)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets multiple scrollbar configuration parameters simultaneously. <a href="#a506ab9709b851717a29f46d53f5c45d9"></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_1Scrollbar.html#a3f6d724d29758a4675d402e0ef0b66fe">setEndLockEnabled</a> (const bool enabled)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable the 'end lock' mode for the scrollbar. <a href="#a3f6d724d29758a4675d402e0ef0b66fe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#afd01fc9947ed4b2a5376453ea4769fea">isEndLockEnabled</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the 'end lock'mode for the scrollbar is enabled. <a href="#afd01fc9947ed4b2a5376453ea4769fea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa7ccff9ac2f33f8d92e1405fb36c5d2"></a><!-- doxytag: member="CEGUI::Scrollbar::Scrollbar" ref="aaa7ccff9ac2f33f8d92e1405fb36c5d2" args="(const String &type, const String &name)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#aaa7ccff9ac2f33f8d92e1405fb36c5d2">Scrollbar</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 <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> objects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a489272b1dd0dcb1c48e510fda04d3ce3"></a><!-- doxytag: member="CEGUI::Scrollbar::~Scrollbar" ref="a489272b1dd0dcb1c48e510fda04d3ce3" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a489272b1dd0dcb1c48e510fda04d3ce3">~Scrollbar</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> objects. <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="a431602064c56a159a4ae09bed588b4d0"></a><!-- doxytag: member="CEGUI::Scrollbar::EventNamespace" ref="a431602064c56a159a4ae09bed588b4d0" 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_1Scrollbar.html#a431602064c56a159a4ae09bed588b4d0">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="a1d36e46bb1cd48732b82577020e7aed8"></a><!-- doxytag: member="CEGUI::Scrollbar::WidgetTypeName" ref="a1d36e46bb1cd48732b82577020e7aed8" 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_1Scrollbar.html#a1d36e46bb1cd48732b82577020e7aed8">WidgetTypeName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><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> factory name. <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_1Scrollbar.html#a6d5ad554df531170adc3ff3e40377dcd">EventScrollPositionChanged</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_1Scrollbar.html#a80243f56030d521188a9c2e905430448">EventThumbTrackStarted</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_1Scrollbar.html#ac6c1f06e473c3d62a6130af2c3aaf09b">EventThumbTrackEnded</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_1Scrollbar.html#a3d22f090d1fc4ca621c0d8e81ddc5d7e">EventScrollConfigChanged</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8791b6f0301470ac6e42f94904ce7b9"></a><!-- doxytag: member="CEGUI::Scrollbar::ThumbNameSuffix" ref="ad8791b6f0301470ac6e42f94904ce7b9" 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_1Scrollbar.html#ad8791b6f0301470ac6e42f94904ce7b9">ThumbNameSuffix</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Widget name suffix for the thumb component. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a451c6184189cf7991d314beb222ea2a3"></a><!-- doxytag: member="CEGUI::Scrollbar::IncreaseButtonNameSuffix" ref="a451c6184189cf7991d314beb222ea2a3" 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_1Scrollbar.html#a451c6184189cf7991d314beb222ea2a3">IncreaseButtonNameSuffix</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Widget name suffix for the increase button component. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af88554eef892d625ce0739e4ef14fc63"></a><!-- doxytag: member="CEGUI::Scrollbar::DecreaseButtonNameSuffix" ref="af88554eef892d625ce0739e4ef14fc63" 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_1Scrollbar.html#af88554eef892d625ce0739e4ef14fc63">DecreaseButtonNameSuffix</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Widget name suffix for the decrease button component. <br/></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="a8f5b8279af8dbf556703175c9b42c5dd"></a><!-- doxytag: member="CEGUI::Scrollbar::updateThumb" ref="a8f5b8279af8dbf556703175c9b42c5dd" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a8f5b8279af8dbf556703175c9b42c5dd">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_1Scrollbar.html#ab6b7c103c1ae452d951971768a020773">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="#ab6b7c103c1ae452d951971768a020773"></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_1Scrollbar.html#a980357b4ddb5dc6294ed8b16ae796537">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="#a980357b4ddb5dc6294ed8b16ae796537"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a47a77908c604f639077ad39aa9384b92">setScrollPosition_impl</a> (const float position)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31081a6c9f8acdb39a2dcd3a09a1d02e"></a><!-- doxytag: member="CEGUI::Scrollbar::isAtEnd" ref="a31081a6c9f8acdb39a2dcd3a09a1d02e" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a31081a6c9f8acdb39a2dcd3a09a1d02e">isAtEnd</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return whether the current scroll position is at the end of the range. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a117b23e4929f65c671e6dec601a04057"></a><!-- doxytag: member="CEGUI::Scrollbar::getMaxScrollPosition" ref="a117b23e4929f65c671e6dec601a04057" args="() const " -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a117b23e4929f65c671e6dec601a04057">getMaxScrollPosition</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the max allowable scroll position value <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad5db7bb41ca23c6789751b1c3e75b4fc"></a><!-- doxytag: member="CEGUI::Scrollbar::handleThumbMoved" ref="ad5db7bb41ca23c6789751b1c3e75b4fc" args="(const EventArgs &e)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#ad5db7bb41ca23c6789751b1c3e75b4fc">handleThumbMoved</a> (const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">handler function for when thumb moves. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab16c1e5fc92866195c73ea86a85b6e32"></a><!-- doxytag: member="CEGUI::Scrollbar::handleIncreaseClicked" ref="ab16c1e5fc92866195c73ea86a85b6e32" args="(const EventArgs &e)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#ab16c1e5fc92866195c73ea86a85b6e32">handleIncreaseClicked</a> (const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">handler function for when the increase button is clicked. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a72222c4c341bdbdb7d169b4b98add6"></a><!-- doxytag: member="CEGUI::Scrollbar::handleDecreaseClicked" ref="a6a72222c4c341bdbdb7d169b4b98add6" args="(const EventArgs &e)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a6a72222c4c341bdbdb7d169b4b98add6">handleDecreaseClicked</a> (const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">handler function for when the decrease button is clicked. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ea3bc6e8db668fd157de321db6caff4"></a><!-- doxytag: member="CEGUI::Scrollbar::handleThumbTrackStarted" ref="a1ea3bc6e8db668fd157de321db6caff4" args="(const EventArgs &e)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a1ea3bc6e8db668fd157de321db6caff4">handleThumbTrackStarted</a> (const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">handler function for when thumb tracking begins <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aded6dcedbebfa259f45df95ec0b5a9c5"></a><!-- doxytag: member="CEGUI::Scrollbar::handleThumbTrackEnded" ref="aded6dcedbebfa259f45df95ec0b5a9c5" args="(const EventArgs &e)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#aded6dcedbebfa259f45df95ec0b5a9c5">handleThumbTrackEnded</a> (const <a class="el" href="classCEGUI_1_1EventArgs.html">EventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">handler function for when thumb tracking begins <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a8af4007728ff2c305f418bf654b564a2">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="#a8af4007728ff2c305f418bf654b564a2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73b8b4a14de3c04f216ac3342a3d8c95"></a><!-- doxytag: member="CEGUI::Scrollbar::validateWindowRenderer" ref="a73b8b4a14de3c04f216ac3342a3d8c95" args="(const String &name) const " -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a73b8b4a14de3c04f216ac3342a3d8c95">validateWindowRenderer</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">validate window renderer <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad802a0f26b77e9dd83f034a165a4db48"></a><!-- doxytag: member="CEGUI::Scrollbar::onScrollPositionChanged" ref="ad802a0f26b77e9dd83f034a165a4db48" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#ad802a0f26b77e9dd83f034a165a4db48">onScrollPositionChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler triggered when the scroll position changes. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d7c4bd28b242e64225eedde0efb2207"></a><!-- doxytag: member="CEGUI::Scrollbar::onThumbTrackStarted" ref="a9d7c4bd28b242e64225eedde0efb2207" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a9d7c4bd28b242e64225eedde0efb2207">onThumbTrackStarted</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler triggered when the user begins to drag the scroll bar thumb. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf1785b4b313a5fb45c2bcba2f94a444"></a><!-- doxytag: member="CEGUI::Scrollbar::onThumbTrackEnded" ref="adf1785b4b313a5fb45c2bcba2f94a444" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#adf1785b4b313a5fb45c2bcba2f94a444">onThumbTrackEnded</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler triggered when the scroll bar thumb is released. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8afb3c0847f35fd43383b8fb7a5203e9"></a><!-- doxytag: member="CEGUI::Scrollbar::onScrollConfigChanged" ref="a8afb3c0847f35fd43383b8fb7a5203e9" args="(WindowEventArgs &e)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a8afb3c0847f35fd43383b8fb7a5203e9">onScrollConfigChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler triggered when the scroll bar data configuration changes. <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_1Scrollbar.html#a268e64cfe153804c08798626881011a6">onMouseButtonDown</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 a mouse button has been depressed within this window's area. <a href="#a268e64cfe153804c08798626881011a6"></a><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_1Scrollbar.html#a43ab0a9d1ce07a79f5335493531bc3d2">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="#a43ab0a9d1ce07a79f5335493531bc3d2"></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="a81337655973579ca434a82a7b06053f5"></a><!-- doxytag: member="CEGUI::Scrollbar::d_documentSize" ref="a81337655973579ca434a82a7b06053f5" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a81337655973579ca434a82a7b06053f5">d_documentSize</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The size of the document / data being scrolled thorugh. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afafa0625fb39956dc1148e639ddd3806"></a><!-- doxytag: member="CEGUI::Scrollbar::d_pageSize" ref="afafa0625fb39956dc1148e639ddd3806" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#afafa0625fb39956dc1148e639ddd3806">d_pageSize</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The size of a single 'page' of data. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f45de07bc3dc9f13a39604fc83390ee"></a><!-- doxytag: member="CEGUI::Scrollbar::d_stepSize" ref="a5f45de07bc3dc9f13a39604fc83390ee" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a5f45de07bc3dc9f13a39604fc83390ee">d_stepSize</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Step size used for increase / decrease button clicks. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3ed45c4bd2abba1abcde9cea95bd582"></a><!-- doxytag: member="CEGUI::Scrollbar::d_overlapSize" ref="ad3ed45c4bd2abba1abcde9cea95bd582" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#ad3ed45c4bd2abba1abcde9cea95bd582">d_overlapSize</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Amount of overlap when jumping by a page. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbef42a578326850c37e309be7e81c5b"></a><!-- doxytag: member="CEGUI::Scrollbar::d_position" ref="acbef42a578326850c37e309be7e81c5b" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#acbef42a578326850c37e309be7e81c5b">d_position</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Current scroll position. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25ba6fe46bed75cf74f13c9bb8be4460"></a><!-- doxytag: member="CEGUI::Scrollbar::d_endLockPosition" ref="a25ba6fe46bed75cf74f13c9bb8be4460" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scrollbar.html#a25ba6fe46bed75cf74f13c9bb8be4460">d_endLockPosition</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">whether 'end lock' mode is enabled. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base scroll bar class. </p>
<p>This base class for scroll bars does not have any idea of direction - a derived class would add whatever meaning is appropriate according to what that derived class represents to the user. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a980357b4ddb5dc6294ed8b16ae796537"></a><!-- doxytag: member="CEGUI::Scrollbar::getAdjustDirectionFromPoint" ref="a980357b4ddb5dc6294ed8b16ae796537" args="(const Point &pt) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::Scrollbar::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]</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>
</div>
</div>
<a class="anchor" id="a83e25dc78484f3e63fac9e92d38d8435"></a><!-- doxytag: member="CEGUI::Scrollbar::getDecreaseButton" ref="a83e25dc78484f3e63fac9e92d38d8435" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1PushButton.html">PushButton</a>* CEGUI::Scrollbar::getDecreaseButton </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a pointer to the 'decrease' <a class="el" href="classCEGUI_1_1PushButton.html" title="Base class to provide logic for push button type widgets.">PushButton</a> component widget for this <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to a <a class="el" href="classCEGUI_1_1PushButton.html" title="Base class to provide logic for push button type widgets.">PushButton</a> object.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1UnknownObjectException.html" title="Exception class used when a request was made for an unknown object.">UnknownObjectException</a></td><td>Thrown if the 'decrease' <a class="el" href="classCEGUI_1_1PushButton.html" title="Base class to provide logic for push button type widgets.">PushButton</a> component does not exist. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8b6ce07268e61e013a17089b1c8fb847"></a><!-- doxytag: member="CEGUI::Scrollbar::getDocumentSize" ref="a8b6ce07268e61e013a17089b1c8fb847" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::Scrollbar::getDocumentSize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the size of the document or data. </p>
<p>The document size should be thought of as the total size of the data that is being scrolled through (the number of lines in a text file for example).</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>float value specifying the currently set document size. </dd></dl>
</div>
</div>
<a class="anchor" id="a5f0c15f93d66d34b222e5eef4bbc5e05"></a><!-- doxytag: member="CEGUI::Scrollbar::getIncreaseButton" ref="a5f0c15f93d66d34b222e5eef4bbc5e05" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1PushButton.html">PushButton</a>* CEGUI::Scrollbar::getIncreaseButton </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a pointer to the 'increase' PushButtoncomponent widget for this <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to a <a class="el" href="classCEGUI_1_1PushButton.html" title="Base class to provide logic for push button type widgets.">PushButton</a> object.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1UnknownObjectException.html" title="Exception class used when a request was made for an unknown object.">UnknownObjectException</a></td><td>Thrown if the increase <a class="el" href="classCEGUI_1_1PushButton.html" title="Base class to provide logic for push button type widgets.">PushButton</a> component does not exist. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad2a27a76a28578eb5ba7e1fa63b28f6d"></a><!-- doxytag: member="CEGUI::Scrollbar::getOverlapSize" ref="ad2a27a76a28578eb5ba7e1fa63b28f6d" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::Scrollbar::getOverlapSize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the overlap size for this scroll bar. </p>
<p>The overlap size is the amount of data from the end of a 'page' that will remain visible when the position is moved by a page. This is usually used so that the user keeps some context of where they were within the document's data when jumping a page at a time.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>float value specifying the currently set overlap size. </dd></dl>
</div>
</div>
<a class="anchor" id="a4d8c169526487239eee110f9bc73428c"></a><!-- doxytag: member="CEGUI::Scrollbar::getPageSize" ref="a4d8c169526487239eee110f9bc73428c" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::Scrollbar::getPageSize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the page size for this scroll bar. </p>
<p>The page size is typically the amount of data that can be displayed at one time. This value is also used when calculating the amount the position will change when you click either side of the scroll bar thumb, the amount the position changes will is (pageSize - overlapSize).</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>float value specifying the currently set page size. </dd></dl>
</div>
</div>
<a class="anchor" id="ad2f98f1d58641187b32c278ebfb8771d"></a><!-- doxytag: member="CEGUI::Scrollbar::getScrollPosition" ref="ad2f98f1d58641187b32c278ebfb8771d" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::Scrollbar::getScrollPosition </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the current position of scroll bar within the document. </p>
<p>The range of the scroll bar is from 0 to the size of the document minus the size of a page (0 <= position <= (documentSize - pageSize)).</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>float value specifying the current position of the scroll bar within its document. </dd></dl>
</div>
</div>
<a class="anchor" id="af5e6c21751359fc8323189ff95a2d2d2"></a><!-- doxytag: member="CEGUI::Scrollbar::getStepSize" ref="af5e6c21751359fc8323189ff95a2d2d2" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::Scrollbar::getStepSize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the step size for this scroll bar. </p>
<p>The step size is typically a single unit of data that can be displayed, this is the amount the position will change when you click either of the arrow buttons on the scroll bar. (this could be 1 for a single line of text, for example).</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>float value specifying the currently set step size. </dd></dl>
</div>
</div>
<a class="anchor" id="a89c33813843ea0fac303dd5d7f9491b7"></a><!-- doxytag: member="CEGUI::Scrollbar::getThumb" ref="a89c33813843ea0fac303dd5d7f9491b7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Thumb.html">Thumb</a>* CEGUI::Scrollbar::getThumb </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a pointer to the <a class="el" href="classCEGUI_1_1Thumb.html" title="Base class for Thumb widget.">Thumb</a> component widget for this <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to a <a class="el" href="classCEGUI_1_1Thumb.html" title="Base class for Thumb widget.">Thumb</a> object.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1UnknownObjectException.html" title="Exception class used when a request was made for an unknown object.">UnknownObjectException</a></td><td>Thrown if the <a class="el" href="classCEGUI_1_1Thumb.html" title="Base class for Thumb widget.">Thumb</a> component does not exist. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab6b7c103c1ae452d951971768a020773"></a><!-- doxytag: member="CEGUI::Scrollbar::getValueFromThumb" ref="ab6b7c103c1ae452d951971768a020773" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::Scrollbar::getValueFromThumb </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [protected]</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>
</div>
</div>
<a class="anchor" id="af41618525d5999a84b3234d238cf052e"></a><!-- doxytag: member="CEGUI::Scrollbar::initialiseComponents" ref="af41618525d5999a84b3234d238cf052e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::Scrollbar::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>Initialises the <a class="el" href="classCEGUI_1_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> 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_1Window.html#a15d1b3c2be063277773eb28e33a2ee84">CEGUI::Window</a>.</p>
</div>
</div>
<a class="anchor" id="afd01fc9947ed4b2a5376453ea4769fea"></a><!-- doxytag: member="CEGUI::Scrollbar::isEndLockEnabled" ref="afd01fc9947ed4b2a5376453ea4769fea" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::Scrollbar::isEndLockEnabled </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the 'end lock'mode for the scrollbar is enabled. </p>
<p>When enabled, and the current position of the scrollbar is at the end of it's travel, the end lock mode of the scrollbar will automatically update the scrollbar position when the document and/or page size change in order that the scroll position will remain at the end of it's travel. This can be used to implement auto-scrolling in certain other widget types.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true to indicate that the end lock mode is enabled.</li>
<li>false to indicate that the end lock mode is disabled. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a268e64cfe153804c08798626881011a6"></a><!-- doxytag: member="CEGUI::Scrollbar::onMouseButtonDown" ref="a268e64cfe153804c08798626881011a6" args="(MouseEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::Scrollbar::onMouseButtonDown </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 a mouse button has been depressed 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#abb30780cd259d8328df6ff0809f8ce4a">CEGUI::Window</a>.</p>
</div>
</div>
<a class="anchor" id="a43ab0a9d1ce07a79f5335493531bc3d2"></a><!-- doxytag: member="CEGUI::Scrollbar::onMouseWheel" ref="a43ab0a9d1ce07a79f5335493531bc3d2" args="(MouseEventArgs &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::Scrollbar::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="a506ab9709b851717a29f46d53f5c45d9"></a><!-- doxytag: member="CEGUI::Scrollbar::setConfig" ref="a506ab9709b851717a29f46d53f5c45d9" args="(const float *const document_size, const float *const page_size, const float *const step_size, const float *const overlap_size, const float *const position)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Scrollbar::setConfig </td>
<td>(</td>
<td class="paramtype">const float *const </td>
<td class="paramname"><em>document_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float *const </td>
<td class="paramname"><em>page_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float *const </td>
<td class="paramname"><em>step_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float *const </td>
<td class="paramname"><em>overlap_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float *const </td>
<td class="paramname"><em>position</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets multiple scrollbar configuration parameters simultaneously. </p>
<p>This function is provided in order to be able to minimise the number of internal state updates that occur when modifying the scrollbar parameters.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">document_size</td><td>Pointer to a float value holding the new value to be used for the scroll bar document size. If this is 0 the document size is left unchanged.</td></tr>
<tr><td class="paramname">page_size</td><td>Pointer to a float value holding the new value to be used for the scroll bar page size. If this is 0 the page size is left unchanged.</td></tr>
<tr><td class="paramname">step_size</td><td>Pointer to a float value holding the new value to be used for the scroll bar step size. If this is 0 the step size is left unchanged.</td></tr>
<tr><td class="paramname">overlap_size</td><td>Pointer to a float value holding the new value to be used for the scroll bar overlap size. If this is 0 then overlap size is left unchanged.</td></tr>
<tr><td class="paramname">position</td><td>Pointer to a float value holding the new value to be used for the scroll bar current scroll position. If this is 0 then the current position is left unchanged.</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Even if <em>position</em> is 0, the scrollbar position may still change depending on how the other changes affect the scrollbar. </dd></dl>
</div>
</div>
<a class="anchor" id="ace8c71e43e7521ba8ced801a1ee0ffaa"></a><!-- doxytag: member="CEGUI::Scrollbar::setDocumentSize" ref="ace8c71e43e7521ba8ced801a1ee0ffaa" args="(float document_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Scrollbar::setDocumentSize </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>document_size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the size of the document or data. </p>
<p>The document size should be thought of as the total size of the data that is being scrolled through (the number of lines in a text file for example).</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The value set has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">document_size</td><td>float value specifying the document size.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a3f6d724d29758a4675d402e0ef0b66fe"></a><!-- doxytag: member="CEGUI::Scrollbar::setEndLockEnabled" ref="a3f6d724d29758a4675d402e0ef0b66fe" args="(const bool enabled)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Scrollbar::setEndLockEnabled </td>
<td>(</td>
<td class="paramtype">const bool </td>
<td class="paramname"><em>enabled</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enable or disable the 'end lock' mode for the scrollbar. </p>
<p>When enabled and the current position of the scrollbar is at the end of it's travel, the end lock mode of the scrollbar will automatically update the position when the document and/or page size change in order that the scroll position will remain at the end of it's travel. This can be used to implement auto-scrolling in certain other widget types.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">enabled</td><td><ul>
<li>true to indicate that end lock mode should be enabled.</li>
<li>false to indicate that end lock mode should be disabled. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7401df8626bb696b25e9b37c7c7f4859"></a><!-- doxytag: member="CEGUI::Scrollbar::setOverlapSize" ref="a7401df8626bb696b25e9b37c7c7f4859" args="(float overlap_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Scrollbar::setOverlapSize </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>overlap_size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the overlap size for this scroll bar. </p>
<p>The overlap size is the amount of data from the end of a 'page' that will remain visible when the position is moved by a page. This is usually used so that the user keeps some context of where they were within the document's data when jumping a page at a time.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The value set has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">overlap_size</td><td>float value specifying the overlap size.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a258f808d31e42fadae7dd4e2efc4f9e0"></a><!-- doxytag: member="CEGUI::Scrollbar::setPageSize" ref="a258f808d31e42fadae7dd4e2efc4f9e0" args="(float page_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Scrollbar::setPageSize </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>page_size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the page size for this scroll bar. </p>
<p>The page size is typically the amount of data that can be displayed at one time. This value is also used when calculating the amount the position will change when you click either side of the scroll bar thumb, the amount the position changes will is (pageSize - overlapSize).</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The value set has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">page_size</td><td>float value specifying the page size.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a0b432ab68a4fe91143cbc18828c7811e"></a><!-- doxytag: member="CEGUI::Scrollbar::setScrollPosition" ref="a0b432ab68a4fe91143cbc18828c7811e" args="(float position)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Scrollbar::setScrollPosition </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>position</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the current position of scroll bar within the document. </p>
<p>The range of the scroll bar is from 0 to the size of the document minus the size of a page (0 <= position <= (documentSize - pageSize)), any attempt to set the position outside this range will be adjusted so that it falls within the legal range.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>float value specifying the position of the scroll bar within its document.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a47a77908c604f639077ad39aa9384b92"></a><!-- doxytag: member="CEGUI::Scrollbar::setScrollPosition_impl" ref="a47a77908c604f639077ad39aa9384b92" args="(const float position)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::Scrollbar::setScrollPosition_impl </td>
<td>(</td>
<td class="paramtype">const float </td>
<td class="paramname"><em>position</em></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>implementation func that updates scroll position value, returns true if value was changed. NB: Fires no events and does no other updates. </p>
</div>
</div>
<a class="anchor" id="ac4773e81ba6a94c8e1e99955df20fca9"></a><!-- doxytag: member="CEGUI::Scrollbar::setStepSize" ref="ac4773e81ba6a94c8e1e99955df20fca9" args="(float step_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Scrollbar::setStepSize </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>step_size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the step size for this scroll bar. </p>
<p>The step size is typically a single unit of data that can be displayed, this is the amount the position will change when you click either of the arrow buttons on the scroll bar. (this could be 1 for a single line of text, for example).</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The value set has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">step_size</td><td>float value specifying the step size.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a8af4007728ff2c305f418bf654b564a2"></a><!-- doxytag: member="CEGUI::Scrollbar::testClassName_impl" ref="a8af4007728ff2c305f418bf654b564a2" args="(const String &class_name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::Scrollbar::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_1Window.html#a2b58cf00b4790c9cb08acfc18d5d3b0b">CEGUI::Window</a>.</p>
<p>References <a class="el" href="classCEGUI_1_1Window.html#a2b58cf00b4790c9cb08acfc18d5d3b0b">CEGUI::Window::testClassName_impl()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a3d22f090d1fc4ca621c0d8e81ddc5d7e"></a><!-- doxytag: member="CEGUI::Scrollbar::EventScrollConfigChanged" ref="a3d22f090d1fc4ca621c0d8e81ddc5d7e" 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_1Scrollbar.html#a3d22f090d1fc4ca621c0d8e81ddc5d7e">CEGUI::Scrollbar::EventScrollConfigChanged</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 scroll bar configuration data is changed. 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_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> whose configuration has been changed. </p>
</div>
</div>
<a class="anchor" id="a6d5ad554df531170adc3ff3e40377dcd"></a><!-- doxytag: member="CEGUI::Scrollbar::EventScrollPositionChanged" ref="a6d5ad554df531170adc3ff3e40377dcd" 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_1Scrollbar.html#a6d5ad554df531170adc3ff3e40377dcd">CEGUI::Scrollbar::EventScrollPositionChanged</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 scroll bar position value 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_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> whose position value had changed. </p>
</div>
</div>
<a class="anchor" id="ac6c1f06e473c3d62a6130af2c3aaf09b"></a><!-- doxytag: member="CEGUI::Scrollbar::EventThumbTrackEnded" ref="ac6c1f06e473c3d62a6130af2c3aaf09b" 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_1Scrollbar.html#ac6c1f06e473c3d62a6130af2c3aaf09b">CEGUI::Scrollbar::EventThumbTrackEnded</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 user releases the scrollbar thumb. 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_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> whose thumb has been released. </p>
</div>
</div>
<a class="anchor" id="a80243f56030d521188a9c2e905430448"></a><!-- doxytag: member="CEGUI::Scrollbar::EventThumbTrackStarted" ref="a80243f56030d521188a9c2e905430448" 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_1Scrollbar.html#a80243f56030d521188a9c2e905430448">CEGUI::Scrollbar::EventThumbTrackStarted</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 user begins dragging the scrollbar thumb. 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_1Scrollbar.html" title="Base scroll bar class.">Scrollbar</a> whose thumb is being dragged. </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>
|
