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
|
<!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::FalagardEditbox Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1FalagardEditbox.html">FalagardEditbox</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pro-static-attribs">Static Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::FalagardEditbox Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::FalagardEditbox" --><!-- doxytag: inherits="CEGUI::EditboxWindowRenderer" -->
<p><a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> class for the FalagardBase module.
<a href="classCEGUI_1_1FalagardEditbox.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::FalagardEditbox:</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_1FalagardEditbox__inherit__graph.gif" border="0" usemap="#CEGUI_1_1FalagardEditbox_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1FalagardEditbox_inherit__map" id="CEGUI_1_1FalagardEditbox_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1EditboxWindowRenderer.html" title="Base class for the EditboxWindowRenderer class." alt="" coords="5,83,221,112"/><area shape="rect" id="node4" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object." alt="" coords="27,5,200,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::FalagardEditbox:</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_1FalagardEditbox__coll__graph.gif" border="0" usemap="#CEGUI_1_1FalagardEditbox_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1FalagardEditbox_coll__map" id="CEGUI_1_1FalagardEditbox_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1EditboxWindowRenderer.html" title="Base class for the EditboxWindowRenderer class." alt="" coords="59,5,275,35"/><area shape="rect" id="node4" href="classCEGUI_1_1FalagardEditboxProperties_1_1TextFormatting.html" title="Property to access the horizontal formatting mode setting." alt="" coords="5,59,328,88"/><area shape="rect" id="node6" href="classCEGUI_1_1FalagardEditboxProperties_1_1BlinkCaret.html" title="Property to access the setting that controls whether the caret will blink." alt="" coords="20,112,313,141"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1FalagardEditbox-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a291f2a9d167b003e73fe86eebec95e0b"></a><!-- doxytag: member="CEGUI::FalagardEditbox::FalagardEditbox" ref="a291f2a9d167b003e73fe86eebec95e0b" args="(const String &type)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a291f2a9d167b003e73fe86eebec95e0b">FalagardEditbox</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1colour.html">colour</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#ada98aa92402782506b018df2aba572f8">getUnselectedTextColour</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the colour to be used for rendering <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> text oustside of the selected region. <a href="#ada98aa92402782506b018df2aba572f8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1colour.html">colour</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#aee677879c7bb1f8678828807508a52e4">getSelectedTextColour</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the colour to be used for rendering <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> text falling within the selected region. <a href="#aee677879c7bb1f8678828807508a52e4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1colour.html">colour</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#ae8c24e13b7ba93cd77bfe6abc1d81e07">getOptionalPropertyColour</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &propertyName) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a colour object fetched from the named property if it exists, else a default colour (black). <a href="#ae8c24e13b7ba93cd77bfe6abc1d81e07"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03fd85c5b52f8f03e69e16570880c239"></a><!-- doxytag: member="CEGUI::FalagardEditbox::isCaretBlinkEnabled" ref="a03fd85c5b52f8f03e69e16570880c239" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a03fd85c5b52f8f03e69e16570880c239">isCaretBlinkEnabled</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return whether the blinking caret is enabled. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3180d64052cb94b62513e95911eeafb9"></a><!-- doxytag: member="CEGUI::FalagardEditbox::getCaretBlinkTimeout" ref="a3180d64052cb94b62513e95911eeafb9" args="() const " -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a3180d64052cb94b62513e95911eeafb9">getCaretBlinkTimeout</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the caret blink timeout period (only used if blink is enabled). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2078228778e84bd2e903dfb53fc4064b"></a><!-- doxytag: member="CEGUI::FalagardEditbox::setCaretBlinkEnabled" ref="a2078228778e84bd2e903dfb53fc4064b" args="(bool enable)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a2078228778e84bd2e903dfb53fc4064b">setCaretBlinkEnabled</a> (bool enable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set whether the blinking caret is enabled. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63cba832a48b1d8917a5343246e5aa6d"></a><!-- doxytag: member="CEGUI::FalagardEditbox::setCaretBlinkTimeout" ref="a63cba832a48b1d8917a5343246e5aa6d" args="(float seconds)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a63cba832a48b1d8917a5343246e5aa6d">setCaretBlinkTimeout</a> (float seconds)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the caret blink timeout period (only used if blink is enabled). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a29520ee6e681eac6d516a7aa93e2b82e">setTextFormatting</a> (const <a class="el" href="namespaceCEGUI.html#a379719d009ffa73a87100bb8b0b6fe5b">HorizontalTextFormatting</a> format)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the horizontal text formatting to be used from now onwards. <a href="#a29520ee6e681eac6d516a7aa93e2b82e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a366563ead5fd3d4e686456bb05ae4c65"></a><!-- doxytag: member="CEGUI::FalagardEditbox::getTextFormatting" ref="a366563ead5fd3d4e686456bb05ae4c65" args="() const " -->
<a class="el" href="namespaceCEGUI.html#a379719d009ffa73a87100bb8b0b6fe5b">HorizontalTextFormatting</a> </td><td class="memItemRight" valign="bottom"><b>getTextFormatting</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a2008a922ea050422b737068bf5534e97">render</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Populate render cache. <a href="#a2008a922ea050422b737068bf5534e97"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a3ef9686132633abdc8d7f4a5c61def3e">getTextIndexFromPosition</a> (const <a class="el" href="classCEGUI_1_1Vector2.html">Point</a> &pt) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the text code point index that is rendered closest to screen position <em>pt</em>. <a href="#a3ef9686132633abdc8d7f4a5c61def3e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeeae64de5dba9045ef994d81c6da78e5"></a><!-- doxytag: member="CEGUI::FalagardEditbox::update" ref="aeeae64de5dba9045ef994d81c6da78e5" args="(float elapsed)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#aeeae64de5dba9045ef994d81c6da78e5">update</a> (float elapsed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">perform any time based updates for this <a class="el" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">WindowRenderer</a>. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7738dbfdbb8abf27b361d7be0e563557"></a><!-- doxytag: member="CEGUI::FalagardEditbox::TypeName" ref="a7738dbfdbb8abf27b361d7be0e563557" args="[]" -->
static const utf8 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a7738dbfdbb8abf27b361d7be0e563557">TypeName</a> []</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">type name for this widget. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac33be68164b67a24175678f9a7d59b32"></a><!-- doxytag: member="CEGUI::FalagardEditbox::UnselectedTextColourPropertyName" ref="ac33be68164b67a24175678f9a7d59b32" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#ac33be68164b67a24175678f9a7d59b32">UnselectedTextColourPropertyName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name of property to access for unselected text colour. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27f798734caa3bc04f6be9fbd229eed7"></a><!-- doxytag: member="CEGUI::FalagardEditbox::SelectedTextColourPropertyName" ref="a27f798734caa3bc04f6be9fbd229eed7" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a27f798734caa3bc04f6be9fbd229eed7">SelectedTextColourPropertyName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name of property to access for selected text colour. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a296cd4dad03b3d007fc78997602dafd6"></a><!-- doxytag: member="CEGUI::FalagardEditbox::DefaultCaretBlinkTimeout" ref="a296cd4dad03b3d007fc78997602dafd6" args="" -->
static const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a296cd4dad03b3d007fc78997602dafd6">DefaultCaretBlinkTimeout</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The default timeout (in seconds) used when blinking the caret. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a417556e2543f9d4d7b67037b76d01f5a"></a><!-- doxytag: member="CEGUI::FalagardEditbox::renderBaseImagery" ref="a417556e2543f9d4d7b67037b76d01f5a" args="(const WidgetLookFeel &wlf) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a417556e2543f9d4d7b67037b76d01f5a">renderBaseImagery</a> (const <a class="el" href="classCEGUI_1_1WidgetLookFeel.html">WidgetLookFeel</a> &wlf) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">helper to draw the base imagery (container and what have you) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c01d44645718b5871dde817ffe44083"></a><!-- doxytag: member="CEGUI::FalagardEditbox::setupVisualString" ref="a7c01d44645718b5871dde817ffe44083" args="(String &visual) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a7c01d44645718b5871dde817ffe44083">setupVisualString</a> (<a class="el" href="classCEGUI_1_1String.html">String</a> &visual) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">helper to set 'visual' to the string we will render (part of) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b0129120e1f6108154c50dff7b80457"></a><!-- doxytag: member="CEGUI::FalagardEditbox::getCaretIndex" ref="a6b0129120e1f6108154c50dff7b80457" args="(const String &visual_string) const " -->
size_t </td><td class="memItemRight" valign="bottom"><b>getCaretIndex</b> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &visual_string) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adeb6ca0798af9b9594a4955bb3737805"></a><!-- doxytag: member="CEGUI::FalagardEditbox::calculateTextOffset" ref="adeb6ca0798af9b9594a4955bb3737805" args="(const Rect &text_area, const float text_extent, const float caret_width, const float extent_to_caret)" -->
float </td><td class="memItemRight" valign="bottom"><b>calculateTextOffset</b> (const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> &text_area, const float text_extent, const float caret_width, const float extent_to_caret)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4fd10ed89cd3cc976e340a694938c33"></a><!-- doxytag: member="CEGUI::FalagardEditbox::renderTextNoBidi" ref="ab4fd10ed89cd3cc976e340a694938c33" args="(const WidgetLookFeel &wlf, const String &text, const Rect &text_area, float text_offset)" -->
void </td><td class="memItemRight" valign="bottom"><b>renderTextNoBidi</b> (const <a class="el" href="classCEGUI_1_1WidgetLookFeel.html">WidgetLookFeel</a> &wlf, const <a class="el" href="classCEGUI_1_1String.html">String</a> &text, const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> &text_area, float text_offset)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26e62830d152bdbea2cf074b2b17e114"></a><!-- doxytag: member="CEGUI::FalagardEditbox::renderTextBidi" ref="a26e62830d152bdbea2cf074b2b17e114" args="(const WidgetLookFeel &wlf, const String &text, const Rect &text_area, float text_offset)" -->
void </td><td class="memItemRight" valign="bottom"><b>renderTextBidi</b> (const <a class="el" href="classCEGUI_1_1WidgetLookFeel.html">WidgetLookFeel</a> &wlf, const <a class="el" href="classCEGUI_1_1String.html">String</a> &text, const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> &text_area, float text_offset)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94d044b8cddab83724fd71c41c1dd20a"></a><!-- doxytag: member="CEGUI::FalagardEditbox::editboxIsFocussed" ref="a94d044b8cddab83724fd71c41c1dd20a" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><b>editboxIsFocussed</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc4cad3f29ae20e2fc6e1379a49ed15e"></a><!-- doxytag: member="CEGUI::FalagardEditbox::renderCaret" ref="abc4cad3f29ae20e2fc6e1379a49ed15e" args="(const ImagerySection &imagery, const Rect &text_area, const float text_offset, const float extent_to_caret) const " -->
void </td><td class="memItemRight" valign="bottom"><b>renderCaret</b> (const <a class="el" href="classCEGUI_1_1ImagerySection.html">ImagerySection</a> &imagery, const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> &text_area, const float text_offset, const float extent_to_caret) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26d73e8f5f20adfc4404c194f50f9541"></a><!-- doxytag: member="CEGUI::FalagardEditbox::isUnsupportedFormat" ref="a26d73e8f5f20adfc4404c194f50f9541" args="(const HorizontalTextFormatting format)" -->
bool </td><td class="memItemRight" valign="bottom"><b>isUnsupportedFormat</b> (const <a class="el" href="namespaceCEGUI.html#a379719d009ffa73a87100bb8b0b6fe5b">HorizontalTextFormatting</a> format)</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="af62ced0f9dbbc1ba4ca62ad20da3e7fe"></a><!-- doxytag: member="CEGUI::FalagardEditbox::d_lastTextOffset" ref="af62ced0f9dbbc1ba4ca62ad20da3e7fe" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#af62ced0f9dbbc1ba4ca62ad20da3e7fe">d_lastTextOffset</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">x rendering offset used last time we drew the widget. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12049ea20a5d7dea8ec332f1c8c2017a"></a><!-- doxytag: member="CEGUI::FalagardEditbox::d_blinkCaret" ref="a12049ea20a5d7dea8ec332f1c8c2017a" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a12049ea20a5d7dea8ec332f1c8c2017a">d_blinkCaret</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if the caret imagery should blink. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a411f94031aeadf1ed5a40223680934ad"></a><!-- doxytag: member="CEGUI::FalagardEditbox::d_caretBlinkTimeout" ref="a411f94031aeadf1ed5a40223680934ad" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a411f94031aeadf1ed5a40223680934ad">d_caretBlinkTimeout</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">time-out in seconds used for blinking the caret. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4c7bda36ce6c822aee6da228afaa9df5"></a><!-- doxytag: member="CEGUI::FalagardEditbox::d_caretBlinkElapsed" ref="a4c7bda36ce6c822aee6da228afaa9df5" args="" -->
float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a4c7bda36ce6c822aee6da228afaa9df5">d_caretBlinkElapsed</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">current time elapsed since last caret blink state change. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a812ffe0497a66c7aa4180eaec4c84cef"></a><!-- doxytag: member="CEGUI::FalagardEditbox::d_showCaret" ref="a812ffe0497a66c7aa4180eaec4c84cef" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a812ffe0497a66c7aa4180eaec4c84cef">d_showCaret</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true if caret should be shown. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f6f0200e1d0bcc46839e871d9037af9"></a><!-- doxytag: member="CEGUI::FalagardEditbox::d_textFormatting" ref="a1f6f0200e1d0bcc46839e871d9037af9" args="" -->
<a class="el" href="namespaceCEGUI.html#a379719d009ffa73a87100bb8b0b6fe5b">HorizontalTextFormatting</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardEditbox.html#a1f6f0200e1d0bcc46839e871d9037af9">d_textFormatting</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">horizontal formatting. Only supports left, right, and centred. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab867afcd077f64a1c604c30f5250b689"></a><!-- doxytag: member="CEGUI::FalagardEditbox::d_blinkCaretProperty" ref="ab867afcd077f64a1c604c30f5250b689" args="" -->
static <br class="typebreak"/>
<a class="el" href="classCEGUI_1_1FalagardEditboxProperties_1_1BlinkCaret.html">FalagardEditboxProperties::BlinkCaret</a> </td><td class="memItemRight" valign="bottom"><b>d_blinkCaretProperty</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1fde30af6e10a3c1963501b13424cb89"></a><!-- doxytag: member="CEGUI::FalagardEditbox::d_blinkCaretTimeoutProperty" ref="a1fde30af6e10a3c1963501b13424cb89" args="" -->
static <br class="typebreak"/>
<a class="el" href="classCEGUI_1_1FalagardEditboxProperties_1_1BlinkCaretTimeout.html">FalagardEditboxProperties::BlinkCaretTimeout</a> </td><td class="memItemRight" valign="bottom"><b>d_blinkCaretTimeoutProperty</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9857b873475521967124c885b5a747e0"></a><!-- doxytag: member="CEGUI::FalagardEditbox::d_textFormattingProperty" ref="a9857b873475521967124c885b5a747e0" args="" -->
static <br class="typebreak"/>
<a class="el" href="classCEGUI_1_1FalagardEditboxProperties_1_1TextFormatting.html">FalagardEditboxProperties::TextFormatting</a> </td><td class="memItemRight" valign="bottom"><b>d_textFormattingProperty</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> class for the FalagardBase module. </p>
<p>This class requires LookNFeel to be assigned. The LookNFeel should provide the following:</p>
<p>States:</p>
<ul>
<li>Enabled: Rendering for when the editbox is in enabled and is in read-write mode.</li>
<li>ReadOnly: Rendering for when the editbox is in enabled and is in read-only mode.</li>
<li>Disabled: Rendering for when the editbox is disabled.</li>
<li>ActiveSelection: additional state rendered for text selection (the imagery in this section is rendered within the selection area.)</li>
<li>InactiveSelection: additional state rendered for text selection (the imagery in this section is rendered within the selection area.)</li>
</ul>
<p>NamedAreas:</p>
<ul>
<li>TextArea: area where text, selection, and carat imagery will appear.</li>
</ul>
<p>PropertyDefinitions (optional)</p>
<ul>
<li>NormalTextColour: property that accesses a colour value to be used to render normal unselected text. If this property is not defined, the colour defaults to black.</li>
<li>SelectedTextColour: property that accesses a colour value to be used to render selected text. If this property is not defined, the colour defaults to black.</li>
</ul>
<p>Imagery Sections:</p>
<ul>
<li>Carat </li>
</ul>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae8c24e13b7ba93cd77bfe6abc1d81e07"></a><!-- doxytag: member="CEGUI::FalagardEditbox::getOptionalPropertyColour" ref="ae8c24e13b7ba93cd77bfe6abc1d81e07" args="(const String &propertyName) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1colour.html">colour</a> CEGUI::FalagardEditbox::getOptionalPropertyColour </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>propertyName</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a colour object fetched from the named property if it exists, else a default colour (black). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">propertyName</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the property to be accessed if it exists. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aee677879c7bb1f8678828807508a52e4"></a><!-- doxytag: member="CEGUI::FalagardEditbox::getSelectedTextColour" ref="aee677879c7bb1f8678828807508a52e4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1colour.html">colour</a> CEGUI::FalagardEditbox::getSelectedTextColour </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return the colour to be used for rendering <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> text falling within the selected region. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>colour value describing the colour to be used. </dd></dl>
</div>
</div>
<a class="anchor" id="a3ef9686132633abdc8d7f4a5c61def3e"></a><!-- doxytag: member="CEGUI::FalagardEditbox::getTextIndexFromPosition" ref="a3ef9686132633abdc8d7f4a5c61def3e" args="(const Point &pt) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t CEGUI::FalagardEditbox::getTextIndexFromPosition </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Vector2.html">Point</a> & </td>
<td class="paramname"><em>pt</em></td><td>)</td>
<td> const<code> [virtual]</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>
<p>Implements <a class="el" href="classCEGUI_1_1EditboxWindowRenderer.html#afd64062e7b27254abc2c243d271e5526">CEGUI::EditboxWindowRenderer</a>.</p>
</div>
</div>
<a class="anchor" id="ada98aa92402782506b018df2aba572f8"></a><!-- doxytag: member="CEGUI::FalagardEditbox::getUnselectedTextColour" ref="ada98aa92402782506b018df2aba572f8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1colour.html">colour</a> CEGUI::FalagardEditbox::getUnselectedTextColour </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return the colour to be used for rendering <a class="el" href="classCEGUI_1_1Editbox.html" title="Base class for an Editbox widget.">Editbox</a> text oustside of the selected region. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>colour value describing the colour to be used. </dd></dl>
</div>
</div>
<a class="anchor" id="a2008a922ea050422b737068bf5534e97"></a><!-- doxytag: member="CEGUI::FalagardEditbox::render" ref="a2008a922ea050422b737068bf5534e97" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardEditbox::render </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Populate render cache. </p>
<p>This method must be implemented by all window renderers and should perform the rendering operations needed for this widget. Normally using the Falagard API... </p>
<p>Implements <a class="el" href="classCEGUI_1_1WindowRenderer.html#aafeb7dd00fe1e81f640fac257946ee66">CEGUI::WindowRenderer</a>.</p>
</div>
</div>
<a class="anchor" id="a29520ee6e681eac6d516a7aa93e2b82e"></a><!-- doxytag: member="CEGUI::FalagardEditbox::setTextFormatting" ref="a29520ee6e681eac6d516a7aa93e2b82e" args="(const HorizontalTextFormatting format)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardEditbox::setTextFormatting </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceCEGUI.html#a379719d009ffa73a87100bb8b0b6fe5b">HorizontalTextFormatting</a> </td>
<td class="paramname"><em>format</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the horizontal text formatting to be used from now onwards. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>Specifies the formatting to use. Currently can only be one of the following HorizontalTextFormatting values:<ul>
<li>HTF_LEFT_ALIGNED (default)</li>
<li>HTF_RIGHT_ALIGNED</li>
<li>HTF_CENTRE_ALIGNED </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
