File: classCEGUI_1_1Editbox.html

package info (click to toggle)
cegui-mk2 0.7.6-2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 105,384 kB
  • sloc: cpp: 142,729; ansic: 27,984; sh: 11,010; makefile: 2,275; python: 916; xml: 17
file content (1251 lines) | stat: -rw-r--r-- 98,794 bytes parent folder | download | duplicates (2)
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
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
<!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::Editbox 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&#160;<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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_1Editbox.html">Editbox</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">CEGUI::Editbox Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::Editbox" --><!-- doxytag: inherits="CEGUI::Window" -->
<p>Base class for an <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> widget.  
 <a href="classCEGUI_1_1Editbox.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::Editbox:</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_1Editbox__inherit__graph.gif" border="0" usemap="#CEGUI_1_1Editbox_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1Editbox_inherit__map" id="CEGUI_1_1Editbox_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::Editbox:</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_1Editbox__coll__graph.gif" border="0" usemap="#CEGUI_1_1Editbox_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1Editbox_coll__map" id="CEGUI_1_1Editbox_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="83,81,203,111"/><area shape="rect" id="node5" href="classCEGUI_1_1EditboxProperties_1_1MaskText.html" title="Property to access the mask text setting of the edit box." alt="" coords="21,135,264,164"/><area shape="rect" id="node7" href="classCEGUI_1_1EditboxProperties_1_1MaxTextLength.html" title="Property to access the maximum text length for the edit box." alt="" coords="5,188,280,217"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classCEGUI_1_1Editbox-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">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a825ed5823dfda99ab5e647a3936f8aa0">hasInputFocus</a> (void) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return true if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> has input focus.  <a href="#a825ed5823dfda99ab5e647a3936f8aa0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#aa5c6612849e31ed77183011c50126945">isReadOnly</a> (void) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return true if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> is read-only.  <a href="#aa5c6612849e31ed77183011c50126945"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a0b20fe61058a187f363fa9d2e2387e3d">isTextMasked</a> (void) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return true if the text for the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> will be rendered masked.  <a href="#a0b20fe61058a187f363fa9d2e2387e3d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a36c664cfd3126f5e3f99bb7c38946649">isTextValid</a> (void) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return true if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> text is valid given the currently set validation string.  <a href="#a36c664cfd3126f5e3f99bb7c38946649"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a8a779ed8eeae317eaf68178074f874e2">getValidationString</a> (void) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return the currently set validation string  <a href="#a8a779ed8eeae317eaf68178074f874e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a524a688b8c09c75da649a23cab3085c7">getCaratIndex</a> (void) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return the current position of the carat.  <a href="#a524a688b8c09c75da649a23cab3085c7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#aea7ef010a7960874432d6a260181b969">getSelectionStartIndex</a> (void) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return the current selection start point.  <a href="#aea7ef010a7960874432d6a260181b969"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a629eacb35eda735bf683895d498b299a">getSelectionEndIndex</a> (void) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return the current selection end point.  <a href="#a629eacb35eda735bf683895d498b299a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#aa621ff989a3ddfe313d6220b76304f07">getSelectionLength</a> (void) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return the length of the current selection (in code points / characters).  <a href="#aa621ff989a3ddfe313d6220b76304f07"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">utf32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a3bc9f426f94470fd9e69f6b18e8c37a9">getMaskCodePoint</a> (void) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return the utf32 code point used when rendering masked text.  <a href="#a3bc9f426f94470fd9e69f6b18e8c37a9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a000fdd54b1bbea10d15cdb9cb0b5010e">getMaxTextLength</a> (void) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return the maximum text length set for this <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a>.  <a href="#a000fdd54b1bbea10d15cdb9cb0b5010e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a172058dc75d7cdf706b80b2b05134b65">setReadOnly</a> (bool setting)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Specify whether the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> is read-only.  <a href="#a172058dc75d7cdf706b80b2b05134b65"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#afb1d819e07f7e8f19d23f01f21e125f5">setTextMasked</a> (bool setting)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Specify whether the text for the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> will be rendered masked.  <a href="#afb1d819e07f7e8f19d23f01f21e125f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a02539b76ad3f188c2cf8ee7abe7672d6">setValidationString</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;validation_string)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the text validation string.  <a href="#a02539b76ad3f188c2cf8ee7abe7672d6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a7a40b48cf966f5415b40221127218434">setCaratIndex</a> (size_t carat_pos)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current position of the carat.  <a href="#a7a40b48cf966f5415b40221127218434"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#ae2381c9d2eb07ebb3eb7ed92f41e25b5">setSelection</a> (size_t start_pos, size_t end_pos)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Define the current selection for the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a>.  <a href="#ae2381c9d2eb07ebb3eb7ed92f41e25b5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a07040d5f53afa4e1911da9131c0f19ea">setMaskCodePoint</a> (utf32 code_point)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set the utf32 code point used when rendering masked text.  <a href="#a07040d5f53afa4e1911da9131c0f19ea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#aa9e55cd7e7ce509408efa1d0d435efa1">setMaxTextLength</a> (size_t max_len)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set the maximum text length for this <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a>.  <a href="#aa9e55cd7e7ce509408efa1d0d435efa1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad072e7ca3ca9452cc7897d71d42e4e91"></a><!-- doxytag: member="CEGUI::Editbox::Editbox" ref="ad072e7ca3ca9452cc7897d71d42e4e91" args="(const String &amp;type, const String &amp;name)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#ad072e7ca3ca9452cc7897d71d42e4e91">Editbox</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;type, const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;name)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a450d863bdbe43424715d8412f767f224"></a><!-- doxytag: member="CEGUI::Editbox::~Editbox" ref="a450d863bdbe43424715d8412f767f224" args="(void)" -->
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a450d863bdbe43424715d8412f767f224">~Editbox</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> class. <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="a28d0e77e3fe2ccf0b673b77275cba94d"></a><!-- doxytag: member="CEGUI::Editbox::EventNamespace" ref="a28d0e77e3fe2ccf0b673b77275cba94d" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a28d0e77e3fe2ccf0b673b77275cba94d">EventNamespace</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Namespace for global events. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a07b2aa2464e8820163fefaf4610ba0b8"></a><!-- doxytag: member="CEGUI::Editbox::WidgetTypeName" ref="a07b2aa2464e8820163fefaf4610ba0b8" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a07b2aa2464e8820163fefaf4610ba0b8">WidgetTypeName</a></td></tr>
<tr><td class="mdescLeft">&#160;</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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a4afd04c075b11fc60c0a17d5a52d732a">EventReadOnlyModeChanged</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a3b4a7ee738096cc8a733bc7ed99f0f4c">EventMaskedRenderingModeChanged</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#aef8aba616569086dc89e91933ce6a52c">EventMaskCodePointChanged</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#aaaccc0f8650dcc019ec13032305423c4">EventValidationStringChanged</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#ae22fd6f886a0c1cc278c36f9b5a28a41">EventMaximumTextLengthChanged</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a5914642dd90304932b225b07ee398601">EventTextInvalidated</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#acc0098f35887bbfb8dda4bb50bd1b938">EventInvalidEntryAttempted</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a30a3263e943aa407da31936806130762">EventCaratMoved</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#ab67e6cc93ac0b3849e0c2be5ed8c43a6">EventTextSelectionChanged</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a7dea371061bcd085a587e8393c8f4c7b">EventEditboxFull</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a443b42106b04ea73e6e4015f75f2c563">EventTextAccepted</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">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#aefa5996c0e14630265ddb29673aa1926">getTextIndexFromPosition</a> (const <a class="el" href="classCEGUI_1_1Vector2.html">Point</a> &amp;pt) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the text code point index that is rendered closest to screen position <em>pt</em>.  <a href="#aefa5996c0e14630265ddb29673aa1926"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3bc69557970fdd08c661b031e534cf3d"></a><!-- doxytag: member="CEGUI::Editbox::clearSelection" ref="a3bc69557970fdd08c661b031e534cf3d" args="(void)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a3bc69557970fdd08c661b031e534cf3d">clearSelection</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the currently defined selection (just the region, not the text). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a3c7339824b1d45212f5a24e8ce411c6d">eraseSelectedText</a> (bool modify_text=true)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Erase the currently selected text.  <a href="#a3c7339824b1d45212f5a24e8ce411c6d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c8dc38c9bb5b76bdb9930b7ac574085"></a><!-- doxytag: member="CEGUI::Editbox::isStringValid" ref="a7c8dc38c9bb5b76bdb9930b7ac574085" args="(const String &amp;str) const " -->
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a7c8dc38c9bb5b76bdb9930b7ac574085">isStringValid</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;str) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return true if the given string matches the validation regular expression. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51f981433e4b07859a09ce5777ddeb2d"></a><!-- doxytag: member="CEGUI::Editbox::handleBackspace" ref="a51f981433e4b07859a09ce5777ddeb2d" args="(void)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a51f981433e4b07859a09ce5777ddeb2d">handleBackspace</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Processing for backspace key. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac900ea038977a1d105d68b46cdf69bd1"></a><!-- doxytag: member="CEGUI::Editbox::handleDelete" ref="ac900ea038977a1d105d68b46cdf69bd1" args="(void)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#ac900ea038977a1d105d68b46cdf69bd1">handleDelete</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Processing for Delete key. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2aecbc94e24dfe91b14039702ea3c36d"></a><!-- doxytag: member="CEGUI::Editbox::handleCharLeft" ref="a2aecbc94e24dfe91b14039702ea3c36d" args="(uint sysKeys)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a2aecbc94e24dfe91b14039702ea3c36d">handleCharLeft</a> (uint sysKeys)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Processing to move carat one character left. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ccf08d63f8ed26e0d7d70c414b17978"></a><!-- doxytag: member="CEGUI::Editbox::handleWordLeft" ref="a2ccf08d63f8ed26e0d7d70c414b17978" args="(uint sysKeys)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a2ccf08d63f8ed26e0d7d70c414b17978">handleWordLeft</a> (uint sysKeys)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Processing to move carat one word left. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac634b70e214ba12f8ab91202427a2359"></a><!-- doxytag: member="CEGUI::Editbox::handleCharRight" ref="ac634b70e214ba12f8ab91202427a2359" args="(uint sysKeys)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#ac634b70e214ba12f8ab91202427a2359">handleCharRight</a> (uint sysKeys)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Processing to move carat one character right. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a899a5aab5f172d07d7ac1e7c5157cc4a"></a><!-- doxytag: member="CEGUI::Editbox::handleWordRight" ref="a899a5aab5f172d07d7ac1e7c5157cc4a" args="(uint sysKeys)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a899a5aab5f172d07d7ac1e7c5157cc4a">handleWordRight</a> (uint sysKeys)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Processing to move carat one word right. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9c6fb05d1edc235064b4c9ad3c1cf45"></a><!-- doxytag: member="CEGUI::Editbox::handleHome" ref="ae9c6fb05d1edc235064b4c9ad3c1cf45" args="(uint sysKeys)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#ae9c6fb05d1edc235064b4c9ad3c1cf45">handleHome</a> (uint sysKeys)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Processing to move carat to the start of the text. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac0c7f7d106aacee5dcf9ac619c8f016"></a><!-- doxytag: member="CEGUI::Editbox::handleEnd" ref="aac0c7f7d106aacee5dcf9ac619c8f016" args="(uint sysKeys)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#aac0c7f7d106aacee5dcf9ac619c8f016">handleEnd</a> (uint sysKeys)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Processing to move carat to the end of the text. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#ab004c500cadaf81973efab30ee3d445e">testClassName_impl</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;class_name) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.  <a href="#ab004c500cadaf81973efab30ee3d445e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25ce125527f6448f195d2d8c89d8d771"></a><!-- doxytag: member="CEGUI::Editbox::validateWindowRenderer" ref="a25ce125527f6448f195d2d8c89d8d771" args="(const String &amp;name) const " -->
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a25ce125527f6448f195d2d8c89d8d771">validateWindowRenderer</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;name) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">validate window renderer <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a90ccdf00d2a399f17ddfbab3eb91606a"></a><!-- doxytag: member="CEGUI::Editbox::onReadOnlyChanged" ref="a90ccdf00d2a399f17ddfbab3eb91606a" args="(WindowEventArgs &amp;e)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a90ccdf00d2a399f17ddfbab3eb91606a">onReadOnlyChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when the read only state of the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> has been changed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0cb49a110f074559e22f1747f2baf8ac"></a><!-- doxytag: member="CEGUI::Editbox::onMaskedRenderingModeChanged" ref="a0cb49a110f074559e22f1747f2baf8ac" args="(WindowEventArgs &amp;e)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a0cb49a110f074559e22f1747f2baf8ac">onMaskedRenderingModeChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when the masked rendering mode (password mode) has been changed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a62a91934c488411f1d001c04a656a042"></a><!-- doxytag: member="CEGUI::Editbox::onMaskCodePointChanged" ref="a62a91934c488411f1d001c04a656a042" args="(WindowEventArgs &amp;e)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a62a91934c488411f1d001c04a656a042">onMaskCodePointChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when the code point to use for masked rendering has been changed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2bb29e6ca28cf3fdd42274c70bc79ef0"></a><!-- doxytag: member="CEGUI::Editbox::onValidationStringChanged" ref="a2bb29e6ca28cf3fdd42274c70bc79ef0" args="(WindowEventArgs &amp;e)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a2bb29e6ca28cf3fdd42274c70bc79ef0">onValidationStringChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired internally when the validation string is changed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17edc328542b3a9cfa47eb8546622507"></a><!-- doxytag: member="CEGUI::Editbox::onMaximumTextLengthChanged" ref="a17edc328542b3a9cfa47eb8546622507" args="(WindowEventArgs &amp;e)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a17edc328542b3a9cfa47eb8546622507">onMaximumTextLengthChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when the maximum text length for the edit box is changed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#affaf10dee771a8c92f33d7efa946f59d">onTextInvalidatedEvent</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when something has caused the current text to now fail validation.  <a href="#affaf10dee771a8c92f33d7efa946f59d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f3473697a2fb6ca40df770a39a88752"></a><!-- doxytag: member="CEGUI::Editbox::onInvalidEntryAttempted" ref="a9f3473697a2fb6ca40df770a39a88752" args="(WindowEventArgs &amp;e)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a9f3473697a2fb6ca40df770a39a88752">onInvalidEntryAttempted</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when the user attempted to make a change to the edit box that would have caused it to fail validation. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a904b7a36249606aadd78aca0c4fd0146"></a><!-- doxytag: member="CEGUI::Editbox::onCaratMoved" ref="a904b7a36249606aadd78aca0c4fd0146" args="(WindowEventArgs &amp;e)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a904b7a36249606aadd78aca0c4fd0146">onCaratMoved</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when the carat (insert point) position changes. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b4e20e4af083cf8508b4aa0fadbe48c"></a><!-- doxytag: member="CEGUI::Editbox::onTextSelectionChanged" ref="a0b4e20e4af083cf8508b4aa0fadbe48c" args="(WindowEventArgs &amp;e)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a0b4e20e4af083cf8508b4aa0fadbe48c">onTextSelectionChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when the current text selection changes. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc87615514a7acf9cfbc3ffe195e2381"></a><!-- doxytag: member="CEGUI::Editbox::onEditboxFullEvent" ref="abc87615514a7acf9cfbc3ffe195e2381" args="(WindowEventArgs &amp;e)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#abc87615514a7acf9cfbc3ffe195e2381">onEditboxFullEvent</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when the edit box text has reached the set maximum length. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a95f8f3bf6df0cf33d051b23750b20902"></a><!-- doxytag: member="CEGUI::Editbox::onTextAcceptedEvent" ref="a95f8f3bf6df0cf33d051b23750b20902" args="(WindowEventArgs &amp;e)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a95f8f3bf6df0cf33d051b23750b20902">onTextAcceptedEvent</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when the user accepts the edit box text by pressing Return, Enter, or Tab. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a7e6b7e7108fb122f2da36dab37631a9f">onMouseButtonDown</a> (<a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when a mouse button has been depressed within this window's area.  <a href="#a7e6b7e7108fb122f2da36dab37631a9f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a1586897ae008397bc70d70bacfa0a93c">onMouseButtonUp</a> (<a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when a mouse button has been released within this window's area.  <a href="#a1586897ae008397bc70d70bacfa0a93c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a66e29da45b698a19f59bbb98343fa13b">onMouseDoubleClicked</a> (<a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when a mouse button has been double-clicked within this window's area.  <a href="#a66e29da45b698a19f59bbb98343fa13b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a3207a2f5568ba33f1148b84db231dbb2">onMouseTripleClicked</a> (<a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when a mouse button has been triple-clicked within this window's area.  <a href="#a3207a2f5568ba33f1148b84db231dbb2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a2cd492369f365f7604c6c8ebe0d2c9c6">onMouseMove</a> (<a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when the mouse cursor has been moved within this window's area.  <a href="#a2cd492369f365f7604c6c8ebe0d2c9c6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a2186c21a030ee64382d58ff97f3cd560">onCaptureLost</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when this window loses capture of mouse inputs.  <a href="#a2186c21a030ee64382d58ff97f3cd560"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#ac5e07ffba56f634da8ff919ed4f8c511">onCharacter</a> (<a class="el" href="classCEGUI_1_1KeyEventArgs.html">KeyEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when a character-key has been pressed while this window has input focus.  <a href="#ac5e07ffba56f634da8ff919ed4f8c511"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#aefe45c61a4efca45ea1a7e9b4ef50175">onKeyDown</a> (<a class="el" href="classCEGUI_1_1KeyEventArgs.html">KeyEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when a key as been depressed while this window has input focus.  <a href="#aefe45c61a4efca45ea1a7e9b4ef50175"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#ae41838821e2dbef964493041b5b3f24e">onTextChanged</a> (<a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;e)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when the window's text is changed.  <a href="#ae41838821e2dbef964493041b5b3f24e"></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="a0d6c63ff97ffb74b89f34028bee62628"></a><!-- doxytag: member="CEGUI::Editbox::d_readOnly" ref="a0d6c63ff97ffb74b89f34028bee62628" args="" -->
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a0d6c63ff97ffb74b89f34028bee62628">d_readOnly</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the editbox is in read-only mode. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2be6c38f93feced0df90aa3f7e1d06c6"></a><!-- doxytag: member="CEGUI::Editbox::d_maskText" ref="a2be6c38f93feced0df90aa3f7e1d06c6" args="" -->
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a2be6c38f93feced0df90aa3f7e1d06c6">d_maskText</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the editbox text should be rendered masked. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75db63ee42adeb9b75610339acf91491"></a><!-- doxytag: member="CEGUI::Editbox::d_maskCodePoint" ref="a75db63ee42adeb9b75610339acf91491" args="" -->
utf32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a75db63ee42adeb9b75610339acf91491">d_maskCodePoint</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Code point to use when rendering masked text. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04c63233f60c56243641b0bc569d8132"></a><!-- doxytag: member="CEGUI::Editbox::d_maxTextLen" ref="a04c63233f60c56243641b0bc569d8132" args="" -->
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a04c63233f60c56243641b0bc569d8132">d_maxTextLen</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of characters for this <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2288a65ab7ee6e8d2d59ec1d0dc78d4"></a><!-- doxytag: member="CEGUI::Editbox::d_caratPos" ref="af2288a65ab7ee6e8d2d59ec1d0dc78d4" args="" -->
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#af2288a65ab7ee6e8d2d59ec1d0dc78d4">d_caratPos</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Position of the carat / insert-point. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70b72b1d78644c97be7032c4ca1f206c"></a><!-- doxytag: member="CEGUI::Editbox::d_selectionStart" ref="a70b72b1d78644c97be7032c4ca1f206c" args="" -->
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a70b72b1d78644c97be7032c4ca1f206c">d_selectionStart</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Start of selection area. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ba588b2432cbbb0e437178abf3ae362"></a><!-- doxytag: member="CEGUI::Editbox::d_selectionEnd" ref="a1ba588b2432cbbb0e437178abf3ae362" args="" -->
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a1ba588b2432cbbb0e437178abf3ae362">d_selectionEnd</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">End of selection area. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5a1140ab7b753cd7ae2a5384ea6f9d73"></a><!-- doxytag: member="CEGUI::Editbox::d_validationString" ref="a5a1140ab7b753cd7ae2a5384ea6f9d73" args="" -->
<a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a5a1140ab7b753cd7ae2a5384ea6f9d73">d_validationString</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy of validation reg-ex string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b59297fdc3b7a6a6babc2d553b83337"></a><!-- doxytag: member="CEGUI::Editbox::d_validator" ref="a9b59297fdc3b7a6a6babc2d553b83337" args="" -->
<a class="el" href="classCEGUI_1_1RegexMatcher.html">RegexMatcher</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a9b59297fdc3b7a6a6babc2d553b83337">d_validator</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to class used for validation of text. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8cc5e9762e18697bb77c09dedc778003"></a><!-- doxytag: member="CEGUI::Editbox::d_dragging" ref="a8cc5e9762e18697bb77c09dedc778003" args="" -->
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a8cc5e9762e18697bb77c09dedc778003">d_dragging</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">true when a selection is being dragged. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e51072af48c94a1a17b15080d64228c"></a><!-- doxytag: member="CEGUI::Editbox::d_dragAnchorIdx" ref="a9e51072af48c94a1a17b15080d64228c" args="" -->
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Editbox.html#a9e51072af48c94a1a17b15080d64228c">d_dragAnchorIdx</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Selection index for drag selection anchor point. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class for an <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> widget. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3c7339824b1d45212f5a24e8ce411c6d"></a><!-- doxytag: member="CEGUI::Editbox::eraseSelectedText" ref="a3c7339824b1d45212f5a24e8ce411c6d" args="(bool modify_text=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::eraseSelectedText </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>modify_text</em> = <code>true</code></td><td>)</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Erase the currently selected text. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">modify_text</td><td>when true, the actual text will be modified. When false, everything is done except erasing the characters. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a524a688b8c09c75da649a23cab3085c7"></a><!-- doxytag: member="CEGUI::Editbox::getCaratIndex" ref="a524a688b8c09c75da649a23cab3085c7" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t CEGUI::Editbox::getCaratIndex </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>return the current position of the carat. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Index of the insert carat relative to the start of the text. </dd></dl>

</div>
</div>
<a class="anchor" id="a3bc9f426f94470fd9e69f6b18e8c37a9"></a><!-- doxytag: member="CEGUI::Editbox::getMaskCodePoint" ref="a3bc9f426f94470fd9e69f6b18e8c37a9" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">utf32 CEGUI::Editbox::getMaskCodePoint </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>return the utf32 code point used when rendering masked text. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>utf32 code point value representing the Unicode code point that will be rendered instead of the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> text when rendering in masked mode. </dd></dl>

</div>
</div>
<a class="anchor" id="a000fdd54b1bbea10d15cdb9cb0b5010e"></a><!-- doxytag: member="CEGUI::Editbox::getMaxTextLength" ref="a000fdd54b1bbea10d15cdb9cb0b5010e" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t CEGUI::Editbox::getMaxTextLength </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>return the maximum text length set for this <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The maximum number of code points (characters) that can be entered into this <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a>.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Depending on the validation string set, the actual length of text that can be entered may be less than the value returned here (it will never be more). </dd></dl>

</div>
</div>
<a class="anchor" id="a629eacb35eda735bf683895d498b299a"></a><!-- doxytag: member="CEGUI::Editbox::getSelectionEndIndex" ref="a629eacb35eda735bf683895d498b299a" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t CEGUI::Editbox::getSelectionEndIndex </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>return the current selection end point. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Index of the selection end point relative to the start of the text. If no selection is defined this function returns the position of the carat. </dd></dl>

</div>
</div>
<a class="anchor" id="aa621ff989a3ddfe313d6220b76304f07"></a><!-- doxytag: member="CEGUI::Editbox::getSelectionLength" ref="aa621ff989a3ddfe313d6220b76304f07" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t CEGUI::Editbox::getSelectionLength </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>return the length of the current selection (in code points / characters). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Number of code points (or characters) contained within the currently defined selection. </dd></dl>

</div>
</div>
<a class="anchor" id="aea7ef010a7960874432d6a260181b969"></a><!-- doxytag: member="CEGUI::Editbox::getSelectionStartIndex" ref="aea7ef010a7960874432d6a260181b969" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t CEGUI::Editbox::getSelectionStartIndex </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>return the current selection start point. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Index of the selection start point relative to the start of the text. If no selection is defined this function returns the position of the carat. </dd></dl>

</div>
</div>
<a class="anchor" id="aefa5996c0e14630265ddb29673aa1926"></a><!-- doxytag: member="CEGUI::Editbox::getTextIndexFromPosition" ref="aefa5996c0e14630265ddb29673aa1926" args="(const Point &amp;pt) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t CEGUI::Editbox::getTextIndexFromPosition </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1Vector2.html">Point</a> &amp;&#160;</td>
          <td class="paramname"><em>pt</em></td><td>)</td>
          <td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return the text code point index that is rendered closest to screen position <em>pt</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pt</td><td>Point object describing a position on the screen in pixels.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Code point index into the text that is rendered closest to screen position <em>pt</em>. </dd></dl>

</div>
</div>
<a class="anchor" id="a8a779ed8eeae317eaf68178074f874e2"></a><!-- doxytag: member="CEGUI::Editbox::getValidationString" ref="a8a779ed8eeae317eaf68178074f874e2" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a>&amp; CEGUI::Editbox::getValidationString </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>return the currently set validation string </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Validation is performed by means of a regular expression. If the text matches the regex, the text is said to have passed validation. If the text does not match with the regex then the text fails validation.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the current validation regex data </dd></dl>

</div>
</div>
<a class="anchor" id="a825ed5823dfda99ab5e647a3936f8aa0"></a><!-- doxytag: member="CEGUI::Editbox::hasInputFocus" ref="a825ed5823dfda99ab5e647a3936f8aa0" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool CEGUI::Editbox::hasInputFocus </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>return true if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> has input focus. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> has keyboard input focus.</li>
<li>false if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> does not have keyboard input focus. </li>
</ul>
</dd></dl>

</div>
</div>
<a class="anchor" id="aa5c6612849e31ed77183011c50126945"></a><!-- doxytag: member="CEGUI::Editbox::isReadOnly" ref="aa5c6612849e31ed77183011c50126945" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool CEGUI::Editbox::isReadOnly </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>return true if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> is read-only. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> is read only and can't be edited by the user, false if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> is not read only and may be edited by the user. </dd></dl>

</div>
</div>
<a class="anchor" id="a0b20fe61058a187f363fa9d2e2387e3d"></a><!-- doxytag: member="CEGUI::Editbox::isTextMasked" ref="a0b20fe61058a187f363fa9d2e2387e3d" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool CEGUI::Editbox::isTextMasked </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>return true if the text for the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> will be rendered masked. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> text will be rendered masked using the currently set mask code point, false if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> text will be rendered as ordinary text. </dd></dl>

</div>
</div>
<a class="anchor" id="a36c664cfd3126f5e3f99bb7c38946649"></a><!-- doxytag: member="CEGUI::Editbox::isTextValid" ref="a36c664cfd3126f5e3f99bb7c38946649" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool CEGUI::Editbox::isTextValid </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>return true if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> text is valid given the currently set validation string. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>It is possible to programmatically set 'invalid' text for the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> by calling setText. This has certain implications since if invalid text is set, whatever the user types into the box will be rejected when the input is validated.</dd>
<dd>
Validation is performed by means of a regular expression. If the text matches the regex, the text is said to have passed validation. If the text does not match with the regex then the text fails validation.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the current <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> text passes validation.</li>
<li>false if the text does not pass validation. </li>
</ul>
</dd></dl>

</div>
</div>
<a class="anchor" id="a2186c21a030ee64382d58ff97f3cd560"></a><!-- doxytag: member="CEGUI::Editbox::onCaptureLost" ref="a2186c21a030ee64382d58ff97f3cd560" args="(WindowEventArgs &amp;e)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::onCaptureLost </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;&#160;</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 this window loses capture of mouse inputs. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">e</td><td><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> object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a14d613fe66ba50dacb9ee9490b64d26e">CEGUI::Window</a>.</p>

</div>
</div>
<a class="anchor" id="ac5e07ffba56f634da8ff919ed4f8c511"></a><!-- doxytag: member="CEGUI::Editbox::onCharacter" ref="ac5e07ffba56f634da8ff919ed4f8c511" args="(KeyEventArgs &amp;e)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::onCharacter </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classCEGUI_1_1KeyEventArgs.html">KeyEventArgs</a> &amp;&#160;</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 character-key has been pressed while this window has input focus. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1KeyEventArgs.html" title="EventArgs based class that is used for objects passed to input event handlers concerning keyboard inp...">KeyEventArgs</a> object whose 'codepoint' field is set to the Unicode code point (encoded as utf32) for the character typed, and whose 'sysKeys' field represents the combination of SystemKey that were active when the event was generated. All other fields should be considered as 'junk'. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a79969475a45a04c9a8d1b5fb6ef2ccd6">CEGUI::Window</a>.</p>

</div>
</div>
<a class="anchor" id="aefe45c61a4efca45ea1a7e9b4ef50175"></a><!-- doxytag: member="CEGUI::Editbox::onKeyDown" ref="aefe45c61a4efca45ea1a7e9b4ef50175" args="(KeyEventArgs &amp;e)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::onKeyDown </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classCEGUI_1_1KeyEventArgs.html">KeyEventArgs</a> &amp;&#160;</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 key as been depressed while this window has input focus. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">e</td><td><a class="el" href="classCEGUI_1_1KeyEventArgs.html" title="EventArgs based class that is used for objects passed to input event handlers concerning keyboard inp...">KeyEventArgs</a> object whose 'scancode' field is set to the Key::Scan value representing the key that was pressed, and whose 'sysKeys' field represents the combination of SystemKey that were active when the event was generated. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#aa69218466130b226e4596428fc0eb60f">CEGUI::Window</a>.</p>

</div>
</div>
<a class="anchor" id="a7e6b7e7108fb122f2da36dab37631a9f"></a><!-- doxytag: member="CEGUI::Editbox::onMouseButtonDown" ref="a7e6b7e7108fb122f2da36dab37631a9f" args="(MouseEventArgs &amp;e)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::onMouseButtonDown </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;&#160;</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="a1586897ae008397bc70d70bacfa0a93c"></a><!-- doxytag: member="CEGUI::Editbox::onMouseButtonUp" ref="a1586897ae008397bc70d70bacfa0a93c" args="(MouseEventArgs &amp;e)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::onMouseButtonUp </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;&#160;</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 released 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#ac03b4971d121ff91d6fc771386029792">CEGUI::Window</a>.</p>

</div>
</div>
<a class="anchor" id="a66e29da45b698a19f59bbb98343fa13b"></a><!-- doxytag: member="CEGUI::Editbox::onMouseDoubleClicked" ref="a66e29da45b698a19f59bbb98343fa13b" args="(MouseEventArgs &amp;e)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::onMouseDoubleClicked </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;&#160;</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 double-clicked 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#a7e80ca1e972a2f07f630f805ce391d9a">CEGUI::Window</a>.</p>

</div>
</div>
<a class="anchor" id="a2cd492369f365f7604c6c8ebe0d2c9c6"></a><!-- doxytag: member="CEGUI::Editbox::onMouseMove" ref="a2cd492369f365f7604c6c8ebe0d2c9c6" args="(MouseEventArgs &amp;e)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::onMouseMove </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;&#160;</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 cursor has been moved 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#a6ed7a299dff48cf855256983b86c971d">CEGUI::Window</a>.</p>

</div>
</div>
<a class="anchor" id="a3207a2f5568ba33f1148b84db231dbb2"></a><!-- doxytag: member="CEGUI::Editbox::onMouseTripleClicked" ref="a3207a2f5568ba33f1148b84db231dbb2" args="(MouseEventArgs &amp;e)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::onMouseTripleClicked </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classCEGUI_1_1MouseEventArgs.html">MouseEventArgs</a> &amp;&#160;</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 triple-clicked 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#ab1001b8a1a76110974082d105dc778b2">CEGUI::Window</a>.</p>

</div>
</div>
<a class="anchor" id="ae41838821e2dbef964493041b5b3f24e"></a><!-- doxytag: member="CEGUI::Editbox::onTextChanged" ref="ae41838821e2dbef964493041b5b3f24e" args="(WindowEventArgs &amp;e)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::onTextChanged </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;&#160;</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 window's text is changed. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">e</td><td><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> object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="classCEGUI_1_1Window.html#a0733e77b1194b53838ed868c4cb7187c">CEGUI::Window</a>.</p>

</div>
</div>
<a class="anchor" id="affaf10dee771a8c92f33d7efa946f59d"></a><!-- doxytag: member="CEGUI::Editbox::onTextInvalidatedEvent" ref="affaf10dee771a8c92f33d7efa946f59d" args="(WindowEventArgs &amp;e)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void CEGUI::Editbox::onTextInvalidatedEvent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classCEGUI_1_1WindowEventArgs.html">WindowEventArgs</a> &amp;&#160;</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 something has caused the current text to now fail validation. </p>
<p>This can be caused by changing the validation string or setting a maximum length that causes the current text to be truncated. </p>

</div>
</div>
<a class="anchor" id="a7a40b48cf966f5415b40221127218434"></a><!-- doxytag: member="CEGUI::Editbox::setCaratIndex" ref="a7a40b48cf966f5415b40221127218434" args="(size_t carat_pos)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::setCaratIndex </td>
          <td>(</td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>carat_pos</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Set the current position of the carat. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">carat_pos</td><td>New index for the insert carat relative to the start of the text. If the value specified is greater than the number of characters in the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a>, the carat is positioned at the end of the text.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>

</div>
</div>
<a class="anchor" id="a07040d5f53afa4e1911da9131c0f19ea"></a><!-- doxytag: member="CEGUI::Editbox::setMaskCodePoint" ref="a07040d5f53afa4e1911da9131c0f19ea" args="(utf32 code_point)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::setMaskCodePoint </td>
          <td>(</td>
          <td class="paramtype">utf32&#160;</td>
          <td class="paramname"><em>code_point</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>set the utf32 code point used when rendering masked text. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">code_point</td><td>utf32 code point value representing the Unicode code point that should be rendered instead of the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> text when rendering in masked mode.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>

</div>
</div>
<a class="anchor" id="aa9e55cd7e7ce509408efa1d0d435efa1"></a><!-- doxytag: member="CEGUI::Editbox::setMaxTextLength" ref="aa9e55cd7e7ce509408efa1d0d435efa1" args="(size_t max_len)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::setMaxTextLength </td>
          <td>(</td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>max_len</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>set the maximum text length for this <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">max_len</td><td>The maximum number of code points (characters) that can be entered into this <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Depending on the validation string set, the actual length of text that can be entered may be less than the value set here (it will never be more).</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>

</div>
</div>
<a class="anchor" id="a172058dc75d7cdf706b80b2b05134b65"></a><!-- doxytag: member="CEGUI::Editbox::setReadOnly" ref="a172058dc75d7cdf706b80b2b05134b65" args="(bool setting)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::setReadOnly </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>setting</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Specify whether the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> is read-only. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">setting</td><td>true if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> is read only and can't be edited by the user, false if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> is not read only and may be edited by the user.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>

</div>
</div>
<a class="anchor" id="ae2381c9d2eb07ebb3eb7ed92f41e25b5"></a><!-- doxytag: member="CEGUI::Editbox::setSelection" ref="ae2381c9d2eb07ebb3eb7ed92f41e25b5" args="(size_t start_pos, size_t end_pos)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::setSelection </td>
          <td>(</td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>start_pos</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>end_pos</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Define the current selection for the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">start_pos</td><td>Index of the starting point for the selection. If this value is greater than the number of characters in the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a>, the selection start will be set to the end of the text.</td></tr>
    <tr><td class="paramname">end_pos</td><td>Index of the ending point for the selection. If this value is greater than the number of characters in the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a>, the selection end will be set to the end of the text.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>

</div>
</div>
<a class="anchor" id="afb1d819e07f7e8f19d23f01f21e125f5"></a><!-- doxytag: member="CEGUI::Editbox::setTextMasked" ref="afb1d819e07f7e8f19d23f01f21e125f5" args="(bool setting)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::setTextMasked </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>setting</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Specify whether the text for the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> will be rendered masked. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">setting</td><td><ul>
<li>true if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> text should be rendered masked using the currently set mask code point.</li>
<li>false if the <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> text should be rendered as ordinary text.</li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>

</div>
</div>
<a class="anchor" id="a02539b76ad3f188c2cf8ee7abe7672d6"></a><!-- doxytag: member="CEGUI::Editbox::setValidationString" ref="a02539b76ad3f188c2cf8ee7abe7672d6" args="(const String &amp;validation_string)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::Editbox::setValidationString </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>validation_string</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Set the text validation string. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Validation is performed by means of a regular expression. If the text matches the regex, the text is said to have passed validation. If the text does not match with the regex then the text fails validation.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">validation_string</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the validation regex data to be used.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>

</div>
</div>
<a class="anchor" id="ab004c500cadaf81973efab30ee3d445e"></a><!-- doxytag: member="CEGUI::Editbox::testClassName_impl" ref="ab004c500cadaf81973efab30ee3d445e" args="(const String &amp;class_name) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool CEGUI::Editbox::testClassName_impl </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</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><ul>
<li>true if this window was inherited from <em>class_name</em>.</li>
<li>false if not. </li>
</ul>
</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="a30a3263e943aa407da31936806130762"></a><!-- doxytag: member="CEGUI::Editbox::EventCaratMoved" ref="a30a3263e943aa407da31936806130762" 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_1Editbox.html#a30a3263e943aa407da31936806130762">CEGUI::Editbox::EventCaratMoved</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired when the text caret position / insertion point 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_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> whose current insertion point has changed. </p>

</div>
</div>
<a class="anchor" id="a7dea371061bcd085a587e8393c8f4c7b"></a><!-- doxytag: member="CEGUI::Editbox::EventEditboxFull" ref="a7dea371061bcd085a587e8393c8f4c7b" 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_1Editbox.html#a7dea371061bcd085a587e8393c8f4c7b">CEGUI::Editbox::EventEditboxFull</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired when the number of characters in the edit box reaches the currently set maximum. 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_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> that has become full. </p>

</div>
</div>
<a class="anchor" id="acc0098f35887bbfb8dda4bb50bd1b938"></a><!-- doxytag: member="CEGUI::Editbox::EventInvalidEntryAttempted" ref="acc0098f35887bbfb8dda4bb50bd1b938" 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_1Editbox.html#acc0098f35887bbfb8dda4bb50bd1b938">CEGUI::Editbox::EventInvalidEntryAttempted</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired when the user attempts to chage the text in a way that would make it invalid as regards to the validation string. 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_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> in which the users input would have invalidated the text. </p>

</div>
</div>
<a class="anchor" id="aef8aba616569086dc89e91933ce6a52c"></a><!-- doxytag: member="CEGUI::Editbox::EventMaskCodePointChanged" ref="aef8aba616569086dc89e91933ce6a52c" 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_1Editbox.html#aef8aba616569086dc89e91933ce6a52c">CEGUI::Editbox::EventMaskCodePointChanged</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired whrn the code point (character) used for masked text 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_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> whose text masking codepoint has been changed. </p>

</div>
</div>
<a class="anchor" id="a3b4a7ee738096cc8a733bc7ed99f0f4c"></a><!-- doxytag: member="CEGUI::Editbox::EventMaskedRenderingModeChanged" ref="a3b4a7ee738096cc8a733bc7ed99f0f4c" 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_1Editbox.html#a3b4a7ee738096cc8a733bc7ed99f0f4c">CEGUI::Editbox::EventMaskedRenderingModeChanged</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired when the masked rendering mode (password mode) 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_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> that has been put into or taken out of masked text (password) mode. </p>

</div>
</div>
<a class="anchor" id="ae22fd6f886a0c1cc278c36f9b5a28a41"></a><!-- doxytag: member="CEGUI::Editbox::EventMaximumTextLengthChanged" ref="ae22fd6f886a0c1cc278c36f9b5a28a41" 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_1Editbox.html#ae22fd6f886a0c1cc278c36f9b5a28a41">CEGUI::Editbox::EventMaximumTextLengthChanged</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired when the maximum allowable string length 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_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> whose maximum string length has been changed. </p>

</div>
</div>
<a class="anchor" id="a4afd04c075b11fc60c0a17d5a52d732a"></a><!-- doxytag: member="CEGUI::Editbox::EventReadOnlyModeChanged" ref="a4afd04c075b11fc60c0a17d5a52d732a" 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_1Editbox.html#a4afd04c075b11fc60c0a17d5a52d732a">CEGUI::Editbox::EventReadOnlyModeChanged</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired when the read-only mode for the edit box 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_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> whose read only setting has been changed. </p>

</div>
</div>
<a class="anchor" id="a443b42106b04ea73e6e4015f75f2c563"></a><!-- doxytag: member="CEGUI::Editbox::EventTextAccepted" ref="a443b42106b04ea73e6e4015f75f2c563" 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_1Editbox.html#a443b42106b04ea73e6e4015f75f2c563">CEGUI::Editbox::EventTextAccepted</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired when the user accepts the current text by pressing Return, Enter, or Tab. 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_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> in which the user has accepted the current text. </p>

</div>
</div>
<a class="anchor" id="a5914642dd90304932b225b07ee398601"></a><!-- doxytag: member="CEGUI::Editbox::EventTextInvalidated" ref="a5914642dd90304932b225b07ee398601" 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_1Editbox.html#a5914642dd90304932b225b07ee398601">CEGUI::Editbox::EventTextInvalidated</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired when the current text has become invalid as regards to the validation string. 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_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> whose text has become invalid. </p>

</div>
</div>
<a class="anchor" id="ab67e6cc93ac0b3849e0c2be5ed8c43a6"></a><!-- doxytag: member="CEGUI::Editbox::EventTextSelectionChanged" ref="ab67e6cc93ac0b3849e0c2be5ed8c43a6" 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_1Editbox.html#ab67e6cc93ac0b3849e0c2be5ed8c43a6">CEGUI::Editbox::EventTextSelectionChanged</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired when the current text selection 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_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> whose current text selection was changed. </p>

</div>
</div>
<a class="anchor" id="aaaccc0f8650dcc019ec13032305423c4"></a><!-- doxytag: member="CEGUI::Editbox::EventValidationStringChanged" ref="aaaccc0f8650dcc019ec13032305423c4" 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_1Editbox.html#aaaccc0f8650dcc019ec13032305423c4">CEGUI::Editbox::EventValidationStringChanged</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an &#39;event&#39; which can be subscribed to by interested parties.">Event</a> fired when the validation string 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_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> whose validation string 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&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>