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
|
<!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>Irrlicht 3D Engine: irr::gui::IGUIEditBox Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Irrlicht 3D Engine
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="dynsections.js"></script>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classirr_1_1gui_1_1_i_g_u_i_edit_box.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">irr::gui::IGUIEditBox Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="irr::gui::IGUIEditBox" --><!-- doxytag: inherits="irr::gui::IGUIElement" -->
<p>Single line edit box for editing simple text.
<a href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_i_g_u_i_edit_box_8h_source.html">IGUIEditBox.h</a>></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::gui::IGUIEditBox:</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="classirr_1_1gui_1_1_i_g_u_i_edit_box.png" usemap="#irr::gui::IGUIEditBox_map" alt=""/>
<map id="irr::gui::IGUIEditBox_map" name="irr::gui::IGUIEditBox_map">
<area href="classirr_1_1gui_1_1_i_g_u_i_element.html" title="Base class of all GUI elements." alt="irr::gui::IGUIElement" shape="rect" coords="105,112,305,136"/>
<area href="classirr_1_1io_1_1_i_attribute_exchanging_object.html" title="An object which is able to serialize and deserialize its attributes into an attributes object..." alt="irr::io::IAttributeExchangingObject" shape="rect" coords="0,56,200,80"/>
<area href="classirr_1_1_i_event_receiver.html" title="Interface of an object which can receive events." alt="irr::IEventReceiver" shape="rect" coords="210,56,410,80"/>
<area href="classirr_1_1_i_reference_counted.html" title="Base class of most objects of the Irrlicht Engine." alt="irr::IReferenceCounted" shape="rect" coords="0,0,200,24"/>
</map>
</div></div>
<p><a href="classirr_1_1gui_1_1_i_g_u_i_edit_box-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a454f49d8d569bf61b45a31871cc6d301">IGUIEditBox</a> (<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">IGUIEnvironment</a> *environment, <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> *parent, <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> id, <a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>< <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> > rectangle)
<dl class="el"><dd class="mdescRight">constructor <a href="#a454f49d8d569bf61b45a31871cc6d301"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a121ab76cb2b69bbc4238921095917346">enableOverrideColor</a> (bool enable)=0
<dl class="el"><dd class="mdescRight">Sets if the text should use the override color or the color in the gui skin. <a href="#a121ab76cb2b69bbc4238921095917346"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a> * <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a50542fa7f03a48458fac258a0949d987">getActiveFont</a> () const =0
<dl class="el"><dd class="mdescRight">Get the font which is used right now for drawing. <a href="#a50542fa7f03a48458fac258a0949d987"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#ad402bf1211f1a41bf230cc587060648e">getMax</a> () const =0
<dl class="el"><dd class="mdescRight">Returns maximum amount of characters, previously set by <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a5253ed6b422e129356e56f8e2a610be5" title="Sets the maximum amount of characters which may be entered in the box.">setMax()</a>;. <a href="#ad402bf1211f1a41bf230cc587060648e"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a2390e7376b017d8f1e2e724be88fbcc3">getOverrideColor</a> () const =0
<dl class="el"><dd class="mdescRight">Gets the override color. <a href="#a2390e7376b017d8f1e2e724be88fbcc3"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a> * <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a4c5e6749a5ac390d6a10303babd845b8">getOverrideFont</a> () const =0
<dl class="el"><dd class="mdescRight">Gets the override font (if any) <a href="#a4c5e6749a5ac390d6a10303babd845b8"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1core.html#ad2e562e3219072e2f7fc7c2bba0ef0cb">core::dimension2du</a> <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#ac993c4647168460c68d56527ba213b9c">getTextDimension</a> ()=0
<dl class="el"><dd class="mdescRight">Gets the size area of the text in the edit box. <a href="#ac993c4647168460c68d56527ba213b9c"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a4ccf066d1198f3548c7d04622067917f">isAutoScrollEnabled</a> () const =0
<dl class="el"><dd class="mdescRight">Checks to see if automatic scrolling is enabled. <a href="#a4ccf066d1198f3548c7d04622067917f"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a0be3338bc094fc93c9f0e4ed842835d6">isMultiLineEnabled</a> () const =0
<dl class="el"><dd class="mdescRight">Checks if multi line editing is enabled. <a href="#a0be3338bc094fc93c9f0e4ed842835d6"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#ae62dac299d0101be9d78ed3db9a2d314">isOverrideColorEnabled</a> (void) const =0
<dl class="el"><dd class="mdescRight">Checks if an override color is enabled. <a href="#ae62dac299d0101be9d78ed3db9a2d314"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a94b093df77af7cf3e3f9853d68d2c8f2">isPasswordBox</a> () const =0
<dl class="el"><dd class="mdescRight">Returns true if the edit box is currently a password box. <a href="#a94b093df77af7cf3e3f9853d68d2c8f2"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#ad0fd4782c052341744ea9d1f61f80e01">isWordWrapEnabled</a> () const =0
<dl class="el"><dd class="mdescRight">Checks if word wrap is enabled. <a href="#ad0fd4782c052341744ea9d1f61f80e01"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#ad0a9db6da9d0594bb3b5b85a673b3e4d">setAutoScroll</a> (bool enable)=0
<dl class="el"><dd class="mdescRight">Enables or disables automatic scrolling with cursor position. <a href="#ad0a9db6da9d0594bb3b5b85a673b3e4d"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a06b1913867b10018e891969d319f376f">setDrawBackground</a> (bool draw)=0
<dl class="el"><dd class="mdescRight">Sets whether to draw the background. <a href="#a06b1913867b10018e891969d319f376f"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a37094bd4bc6b82a184bd1d7864f7ea18">setDrawBorder</a> (bool border)=0
<dl class="el"><dd class="mdescRight">Turns the border on or off. <a href="#a37094bd4bc6b82a184bd1d7864f7ea18"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a5253ed6b422e129356e56f8e2a610be5">setMax</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> max)=0
<dl class="el"><dd class="mdescRight">Sets the maximum amount of characters which may be entered in the box. <a href="#a5253ed6b422e129356e56f8e2a610be5"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a0f68dc7ddc74d8103ba3ba4d445dbf9a">setMultiLine</a> (bool enable)=0
<dl class="el"><dd class="mdescRight">Enables or disables newlines. <a href="#a0f68dc7ddc74d8103ba3ba4d445dbf9a"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#aa134d2a36c52abcb4881da0267031c47">setOverrideColor</a> (<a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> color)=0
<dl class="el"><dd class="mdescRight">Sets another color for the text. <a href="#aa134d2a36c52abcb4881da0267031c47"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a7608fe327ec860712ec87b5e1dc4aec9">setOverrideFont</a> (<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a> *font=0)=0
<dl class="el"><dd class="mdescRight">Sets another skin independent font. <a href="#a7608fe327ec860712ec87b5e1dc4aec9"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a59a0cf8090eb165fdbade6144bc19807">setPasswordBox</a> (bool passwordBox, wchar_t passwordChar=L'*')=0
<dl class="el"><dd class="mdescRight">Sets whether the edit box is a password box. Setting this to true will. <a href="#a59a0cf8090eb165fdbade6144bc19807"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#ab1e2379940983f4ff874f5143f6d7244">setTextAlignment</a> (<a class="el" href="namespaceirr_1_1gui.html#a19eb5fb40e67f108cb16aba922ddaa2d">EGUI_ALIGNMENT</a> horizontal, <a class="el" href="namespaceirr_1_1gui.html#a19eb5fb40e67f108cb16aba922ddaa2d">EGUI_ALIGNMENT</a> vertical)=0
<dl class="el"><dd class="mdescRight">Sets text justification mode. <a href="#ab1e2379940983f4ff874f5143f6d7244"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#aa020a985b38d293794b73e6e12dafd7c">setWordWrap</a> (bool enable)=0
<dl class="el"><dd class="mdescRight">Enables or disables word wrap. <a href="#aa020a985b38d293794b73e6e12dafd7c"></a><br/></dl></ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Single line edit box for editing simple text. </p>
<dl class="user"><dt><b>This element can create the following events of type EGUI_EVENT_TYPE:</b></dt><dd><ul>
<li>EGET_EDITBOX_ENTER </li>
<li>EGET_EDITBOX_CHANGED </li>
<li>EGET_EDITBOX_MARKING_CHANGED </li>
</ul>
</dd></dl>
<p>Definition at line <a class="el" href="_i_g_u_i_edit_box_8h_source.html#l00023">23</a> of file <a class="el" href="_i_g_u_i_edit_box_8h_source.html">IGUIEditBox.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a454f49d8d569bf61b45a31871cc6d301"></a><!-- doxytag: member="irr::gui::IGUIEditBox::IGUIEditBox" ref="a454f49d8d569bf61b45a31871cc6d301" args="(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect< s32 > rectangle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">irr::gui::IGUIEditBox::IGUIEditBox </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">IGUIEnvironment</a> * </td>
<td class="paramname"><em>environment</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> * </td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>< <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> > </td>
<td class="paramname"><em>rectangle</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>constructor </p>
<p>Definition at line <a class="el" href="_i_g_u_i_edit_box_8h_source.html#l00028">28</a> of file <a class="el" href="_i_g_u_i_edit_box_8h_source.html">IGUIEditBox.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a121ab76cb2b69bbc4238921095917346"></a><!-- doxytag: member="irr::gui::IGUIEditBox::enableOverrideColor" ref="a121ab76cb2b69bbc4238921095917346" args="(bool enable)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIEditBox::enableOverrideColor </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets if the text should use the override color or the color in the gui skin. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">enable,:</td><td>If set to true, the override color, which can be set with <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#aa134d2a36c52abcb4881da0267031c47" title="Sets another color for the text.">IGUIEditBox::setOverrideColor</a> is used, otherwise the EGDC_BUTTON_TEXT color of the skin. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a50542fa7f03a48458fac258a0949d987"></a><!-- doxytag: member="irr::gui::IGUIEditBox::getActiveFont" ref="a50542fa7f03a48458fac258a0949d987" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a>* irr::gui::IGUIEditBox::getActiveFont </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the font which is used right now for drawing. </p>
<p>Currently this is the override font when one is set and the font of the active skin otherwise </p>
</div>
</div>
<a class="anchor" id="ad402bf1211f1a41bf230cc587060648e"></a><!-- doxytag: member="irr::gui::IGUIEditBox::getMax" ref="ad402bf1211f1a41bf230cc587060648e" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> irr::gui::IGUIEditBox::getMax </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns maximum amount of characters, previously set by <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html#a5253ed6b422e129356e56f8e2a610be5" title="Sets the maximum amount of characters which may be entered in the box.">setMax()</a>;. </p>
</div>
</div>
<a class="anchor" id="a2390e7376b017d8f1e2e724be88fbcc3"></a><!-- doxytag: member="irr::gui::IGUIEditBox::getOverrideColor" ref="a2390e7376b017d8f1e2e724be88fbcc3" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> irr::gui::IGUIEditBox::getOverrideColor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the override color. </p>
</div>
</div>
<a class="anchor" id="a4c5e6749a5ac390d6a10303babd845b8"></a><!-- doxytag: member="irr::gui::IGUIEditBox::getOverrideFont" ref="a4c5e6749a5ac390d6a10303babd845b8" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a>* irr::gui::IGUIEditBox::getOverrideFont </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the override font (if any) </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The override font (may be 0) </dd></dl>
</div>
</div>
<a class="anchor" id="ac993c4647168460c68d56527ba213b9c"></a><!-- doxytag: member="irr::gui::IGUIEditBox::getTextDimension" ref="ac993c4647168460c68d56527ba213b9c" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceirr_1_1core.html#ad2e562e3219072e2f7fc7c2bba0ef0cb">core::dimension2du</a> irr::gui::IGUIEditBox::getTextDimension </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the size area of the text in the edit box. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The size in pixels of the text </dd></dl>
</div>
</div>
<a class="anchor" id="a4ccf066d1198f3548c7d04622067917f"></a><!-- doxytag: member="irr::gui::IGUIEditBox::isAutoScrollEnabled" ref="a4ccf066d1198f3548c7d04622067917f" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool irr::gui::IGUIEditBox::isAutoScrollEnabled </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks to see if automatic scrolling is enabled. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if automatic scrolling is enabled, false if not </dd></dl>
</div>
</div>
<a class="anchor" id="a0be3338bc094fc93c9f0e4ed842835d6"></a><!-- doxytag: member="irr::gui::IGUIEditBox::isMultiLineEnabled" ref="a0be3338bc094fc93c9f0e4ed842835d6" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool irr::gui::IGUIEditBox::isMultiLineEnabled </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks if multi line editing is enabled. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if multi-line is enabled, false otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ae62dac299d0101be9d78ed3db9a2d314"></a><!-- doxytag: member="irr::gui::IGUIEditBox::isOverrideColorEnabled" ref="ae62dac299d0101be9d78ed3db9a2d314" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool irr::gui::IGUIEditBox::isOverrideColorEnabled </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks if an override color is enabled. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the override color is enabled, false otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="a94b093df77af7cf3e3f9853d68d2c8f2"></a><!-- doxytag: member="irr::gui::IGUIEditBox::isPasswordBox" ref="a94b093df77af7cf3e3f9853d68d2c8f2" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool irr::gui::IGUIEditBox::isPasswordBox </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the edit box is currently a password box. </p>
</div>
</div>
<a class="anchor" id="ad0fd4782c052341744ea9d1f61f80e01"></a><!-- doxytag: member="irr::gui::IGUIEditBox::isWordWrapEnabled" ref="ad0fd4782c052341744ea9d1f61f80e01" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool irr::gui::IGUIEditBox::isWordWrapEnabled </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks if word wrap is enabled. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if word wrap is enabled, false otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ad0a9db6da9d0594bb3b5b85a673b3e4d"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setAutoScroll" ref="ad0a9db6da9d0594bb3b5b85a673b3e4d" args="(bool enable)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIEditBox::setAutoScroll </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enables or disables automatic scrolling with cursor position. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">enable,:</td><td>If set to true, the text will move around with the cursor position </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a06b1913867b10018e891969d319f376f"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setDrawBackground" ref="a06b1913867b10018e891969d319f376f" args="(bool draw)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIEditBox::setDrawBackground </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>draw</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets whether to draw the background. </p>
</div>
</div>
<a class="anchor" id="a37094bd4bc6b82a184bd1d7864f7ea18"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setDrawBorder" ref="a37094bd4bc6b82a184bd1d7864f7ea18" args="(bool border)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIEditBox::setDrawBorder </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>border</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Turns the border on or off. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">border,:</td><td>true if you want the border to be drawn, false if not </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5253ed6b422e129356e56f8e2a610be5"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setMax" ref="a5253ed6b422e129356e56f8e2a610be5" args="(u32 max)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIEditBox::setMax </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> </td>
<td class="paramname"><em>max</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the maximum amount of characters which may be entered in the box. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">max,:</td><td>Maximum amount of characters. If 0, the character amount is infinity. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0f68dc7ddc74d8103ba3ba4d445dbf9a"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setMultiLine" ref="a0f68dc7ddc74d8103ba3ba4d445dbf9a" args="(bool enable)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIEditBox::setMultiLine </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enables or disables newlines. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">enable,:</td><td>If set to true, the EGET_EDITBOX_ENTER event will not be fired, instead a newline character will be inserted. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa134d2a36c52abcb4881da0267031c47"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setOverrideColor" ref="aa134d2a36c52abcb4881da0267031c47" args="(video::SColor color)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIEditBox::setOverrideColor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> </td>
<td class="paramname"><em>color</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets another color for the text. </p>
<p>If set, the edit box does not use the EGDC_BUTTON_TEXT color defined in the skin, but the set color instead. You don't need to call IGUIEditBox::enableOverrrideColor(true) after this, this is done by this function. If you set a color, and you want the text displayed with the color of the skin again, call IGUIEditBox::enableOverrideColor(false); </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">color,:</td><td>New color of the text. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7608fe327ec860712ec87b5e1dc4aec9"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setOverrideFont" ref="a7608fe327ec860712ec87b5e1dc4aec9" args="(IGUIFont *font=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIEditBox::setOverrideFont </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a> * </td>
<td class="paramname"><em>font</em> = <code>0</code></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets another skin independent font. </p>
<p>If this is set to zero, the button uses the font of the skin. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">font,:</td><td>New font to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a59a0cf8090eb165fdbade6144bc19807"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setPasswordBox" ref="a59a0cf8090eb165fdbade6144bc19807" args="(bool passwordBox, wchar_t passwordChar=L'*')=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIEditBox::setPasswordBox </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>passwordBox</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wchar_t </td>
<td class="paramname"><em>passwordChar</em> = <code>L'*'</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets whether the edit box is a password box. Setting this to true will. </p>
<p>disable MultiLine, WordWrap and the ability to copy with ctrl+c or ctrl+x </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">passwordBox,:</td><td>true to enable password, false to disable </td></tr>
<tr><td class="paramname">passwordChar,:</td><td>the character that is displayed instead of letters </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab1e2379940983f4ff874f5143f6d7244"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setTextAlignment" ref="ab1e2379940983f4ff874f5143f6d7244" args="(EGUI_ALIGNMENT horizontal, EGUI_ALIGNMENT vertical)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIEditBox::setTextAlignment </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#a19eb5fb40e67f108cb16aba922ddaa2d">EGUI_ALIGNMENT</a> </td>
<td class="paramname"><em>horizontal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceirr_1_1gui.html#a19eb5fb40e67f108cb16aba922ddaa2d">EGUI_ALIGNMENT</a> </td>
<td class="paramname"><em>vertical</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets text justification mode. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">horizontal,:</td><td>EGUIA_UPPERLEFT for left justified (default), EGUIA_LOWERRIGHT for right justified, or EGUIA_CENTER for centered text. </td></tr>
<tr><td class="paramname">vertical,:</td><td>EGUIA_UPPERLEFT to align with top edge, EGUIA_LOWERRIGHT for bottom edge, or EGUIA_CENTER for centered text (default). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa020a985b38d293794b73e6e12dafd7c"></a><!-- doxytag: member="irr::gui::IGUIEditBox::setWordWrap" ref="aa020a985b38d293794b73e6e12dafd7c" args="(bool enable)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIEditBox::setWordWrap </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enables or disables word wrap. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">enable,:</td><td>If set to true, words going over one line are broken to the next line. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_i_g_u_i_edit_box_8h_source.html">IGUIEditBox.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
<li class="navelem"><a class="el" href="namespaceirr_1_1gui.html">gui</a> </li>
<li class="navelem"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_edit_box.html">IGUIEditBox</a> </li>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<li class="footer">
<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
Engine</a> Documentation © 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:43 for Irrlicht 3D Engine by
<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
</ul>
</div>
</body>
</html>
|
