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
|
<!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: FalEditbox.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">FalEditbox.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***********************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> filename: FalEditbox.h</span>
<a name="l00003"></a>00003 <span class="comment"> created: Sat Jun 25 2005</span>
<a name="l00004"></a>00004 <span class="comment"> author: Paul D Turner <paul@cegui.org.uk></span>
<a name="l00005"></a>00005 <span class="comment">*************************************************************************/</span>
<a name="l00006"></a>00006 <span class="comment">/***************************************************************************</span>
<a name="l00007"></a>00007 <span class="comment"> * Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining</span>
<a name="l00010"></a>00010 <span class="comment"> * a copy of this software and associated documentation files (the</span>
<a name="l00011"></a>00011 <span class="comment"> * "Software"), to deal in the Software without restriction, including</span>
<a name="l00012"></a>00012 <span class="comment"> * without limitation the rights to use, copy, modify, merge, publish,</span>
<a name="l00013"></a>00013 <span class="comment"> * distribute, sublicense, and/or sell copies of the Software, and to</span>
<a name="l00014"></a>00014 <span class="comment"> * permit persons to whom the Software is furnished to do so, subject to</span>
<a name="l00015"></a>00015 <span class="comment"> * the following conditions:</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * The above copyright notice and this permission notice shall be</span>
<a name="l00018"></a>00018 <span class="comment"> * included in all copies or substantial portions of the Software.</span>
<a name="l00019"></a>00019 <span class="comment"> *</span>
<a name="l00020"></a>00020 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
<a name="l00021"></a>00021 <span class="comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<a name="l00022"></a>00022 <span class="comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span>
<a name="l00023"></a>00023 <span class="comment"> * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR</span>
<a name="l00024"></a>00024 <span class="comment"> * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,</span>
<a name="l00025"></a>00025 <span class="comment"> * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR</span>
<a name="l00026"></a>00026 <span class="comment"> * OTHER DEALINGS IN THE SOFTWARE.</span>
<a name="l00027"></a>00027 <span class="comment"> ***************************************************************************/</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef _FalEditbox_h_</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define _FalEditbox_h_</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "FalModule.h"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "../../elements/CEGUIEditbox.h"</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "FalEditboxProperties.h"</span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="preprocessor">#if defined(_MSC_VER)</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(push)</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(disable : 4251)</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>
<a name="l00040"></a>00040 <span class="comment">// Start of CEGUI namespace section</span>
<a name="l00041"></a>00041 <span class="keyword">namespace </span>CEGUI
<a name="l00042"></a>00042 {
<a name="l00077"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html">00077</a> <span class="keyword">class </span>FALAGARDBASE_API <a class="code" href="classCEGUI_1_1FalagardEditbox.html" title="Editbox class for the FalagardBase module.">FalagardEditbox</a> : <span class="keyword">public</span> <a class="code" href="classCEGUI_1_1EditboxWindowRenderer.html" title="Base class for the EditboxWindowRenderer class.">EditboxWindowRenderer</a>
<a name="l00078"></a>00078 {
<a name="l00079"></a>00079 <span class="keyword">public</span>:
<a name="l00081"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#a7738dbfdbb8abf27b361d7be0e563557">00081</a> <span class="keyword">static</span> <span class="keyword">const</span> utf8 TypeName[];
<a name="l00083"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#ac33be68164b67a24175678f9a7d59b32">00083</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> <a class="code" href="classCEGUI_1_1FalagardEditbox.html#ac33be68164b67a24175678f9a7d59b32" title="Name of property to access for unselected text colour.">UnselectedTextColourPropertyName</a>;
<a name="l00085"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#a27f798734caa3bc04f6be9fbd229eed7">00085</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> <a class="code" href="classCEGUI_1_1FalagardEditbox.html#a27f798734caa3bc04f6be9fbd229eed7" title="Name of property to access for selected text colour.">SelectedTextColourPropertyName</a>;
<a name="l00087"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#a296cd4dad03b3d007fc78997602dafd6">00087</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">float</span> <a class="code" href="classCEGUI_1_1FalagardEditbox.html#a296cd4dad03b3d007fc78997602dafd6" title="The default timeout (in seconds) used when blinking the caret.">DefaultCaretBlinkTimeout</a>;
<a name="l00088"></a>00088
<a name="l00093"></a>00093 <a class="code" href="classCEGUI_1_1FalagardEditbox.html" title="Editbox class for the FalagardBase module.">FalagardEditbox</a>(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& type);
<a name="l00094"></a>00094
<a name="l00103"></a>00103 <a class="code" href="classCEGUI_1_1colour.html" title="Class representing colour values within the system.">colour</a> getUnselectedTextColour() <span class="keyword">const</span>;
<a name="l00104"></a>00104
<a name="l00113"></a>00113 <a class="code" href="classCEGUI_1_1colour.html" title="Class representing colour values within the system.">colour</a> getSelectedTextColour() <span class="keyword">const</span>;
<a name="l00114"></a>00114
<a name="l00124"></a>00124 <a class="code" href="classCEGUI_1_1colour.html" title="Class representing colour values within the system.">colour</a> getOptionalPropertyColour(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& propertyName) <span class="keyword">const</span>;
<a name="l00125"></a>00125
<a name="l00127"></a>00127 <span class="keywordtype">bool</span> isCaretBlinkEnabled() <span class="keyword">const</span>;
<a name="l00129"></a>00129 <span class="keywordtype">float</span> getCaretBlinkTimeout() <span class="keyword">const</span>;
<a name="l00131"></a>00131 <span class="keywordtype">void</span> setCaretBlinkEnabled(<span class="keywordtype">bool</span> enable);
<a name="l00133"></a>00133 <span class="keywordtype">void</span> setCaretBlinkTimeout(<span class="keywordtype">float</span> seconds);
<a name="l00134"></a>00134
<a name="l00146"></a>00146 <span class="keywordtype">void</span> setTextFormatting(<span class="keyword">const</span> <a class="code" href="namespaceCEGUI.html#a379719d009ffa73a87100bb8b0b6fe5b" title="Enumeration of possible values to indicate the horizontal formatting to be used for a text component...">HorizontalTextFormatting</a> format);
<a name="l00147"></a>00147 <a class="code" href="namespaceCEGUI.html#a379719d009ffa73a87100bb8b0b6fe5b" title="Enumeration of possible values to indicate the horizontal formatting to be used for a text component...">HorizontalTextFormatting</a> getTextFormatting() <span class="keyword">const</span>;
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="keywordtype">void</span> render();
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="comment">// overridden from EditboxWindowRenderer base class.</span>
<a name="l00152"></a>00152 <span class="keywordtype">size_t</span> getTextIndexFromPosition(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Vector2.html" title="Class used as a two dimensional vector (aka a Point)">Point</a>& pt) <span class="keyword">const</span>;
<a name="l00153"></a>00153 <span class="comment">// overridden from WindowRenderer class</span>
<a name="l00154"></a>00154 <span class="keywordtype">void</span> update(<span class="keywordtype">float</span> elapsed);
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <span class="keyword">protected</span>:
<a name="l00157"></a>00157 <span class="comment">// properties</span>
<a name="l00158"></a>00158 <span class="keyword">static</span> <a class="code" href="classCEGUI_1_1FalagardEditboxProperties_1_1BlinkCaret.html" title="Property to access the setting that controls whether the caret will blink.">FalagardEditboxProperties::BlinkCaret</a> d_blinkCaretProperty;
<a name="l00159"></a>00159 <span class="keyword">static</span> <a class="code" href="classCEGUI_1_1FalagardEditboxProperties_1_1BlinkCaretTimeout.html" title="Property to access the setting that controls the speed at which the caret blinks when the caret blink...">FalagardEditboxProperties::BlinkCaretTimeout</a> d_blinkCaretTimeoutProperty;
<a name="l00160"></a>00160 <span class="keyword">static</span> <a class="code" href="classCEGUI_1_1FalagardEditboxProperties_1_1TextFormatting.html" title="Property to access the horizontal formatting mode setting.">FalagardEditboxProperties::TextFormatting</a> d_textFormattingProperty;
<a name="l00161"></a>00161
<a name="l00163"></a>00163 <span class="keywordtype">void</span> renderBaseImagery(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1WidgetLookFeel.html" title="Class that encapsulates look & feel information for a particular widget type.">WidgetLookFeel</a>& wlf) <span class="keyword">const</span>;
<a name="l00165"></a>00165 <span class="keywordtype">void</span> setupVisualString(<a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& visual) <span class="keyword">const</span>;
<a name="l00166"></a>00166 <span class="keywordtype">size_t</span> getCaretIndex(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& visual_string) <span class="keyword">const</span>;
<a name="l00167"></a>00167 <span class="keywordtype">float</span> calculateTextOffset(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a>& text_area,
<a name="l00168"></a>00168 <span class="keyword">const</span> <span class="keywordtype">float</span> text_extent,
<a name="l00169"></a>00169 <span class="keyword">const</span> <span class="keywordtype">float</span> caret_width,
<a name="l00170"></a>00170 <span class="keyword">const</span> <span class="keywordtype">float</span> extent_to_caret);
<a name="l00171"></a>00171 <span class="keywordtype">void</span> renderTextNoBidi(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1WidgetLookFeel.html" title="Class that encapsulates look & feel information for a particular widget type.">WidgetLookFeel</a>& wlf,
<a name="l00172"></a>00172 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& text,
<a name="l00173"></a>00173 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a>& text_area,
<a name="l00174"></a>00174 <span class="keywordtype">float</span> text_offset);
<a name="l00175"></a>00175 <span class="keywordtype">void</span> renderTextBidi(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1WidgetLookFeel.html" title="Class that encapsulates look & feel information for a particular widget type.">WidgetLookFeel</a>& wlf,
<a name="l00176"></a>00176 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& text,
<a name="l00177"></a>00177 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a>& text_area,
<a name="l00178"></a>00178 <span class="keywordtype">float</span> text_offset);
<a name="l00179"></a>00179 <span class="keywordtype">bool</span> editboxIsFocussed() <span class="keyword">const</span>;
<a name="l00180"></a>00180 <span class="keywordtype">void</span> renderCaret(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1ImagerySection.html" title="Class that encapsulates a re-usable collection of imagery specifications.">ImagerySection</a>& imagery,
<a name="l00181"></a>00181 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a>& text_area,
<a name="l00182"></a>00182 <span class="keyword">const</span> <span class="keywordtype">float</span> text_offset,
<a name="l00183"></a>00183 <span class="keyword">const</span> <span class="keywordtype">float</span> extent_to_caret) <span class="keyword">const</span>;
<a name="l00184"></a>00184
<a name="l00185"></a>00185 <span class="keywordtype">bool</span> isUnsupportedFormat(<span class="keyword">const</span> <a class="code" href="namespaceCEGUI.html#a379719d009ffa73a87100bb8b0b6fe5b" title="Enumeration of possible values to indicate the horizontal formatting to be used for a text component...">HorizontalTextFormatting</a> format);
<a name="l00186"></a>00186
<a name="l00188"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#af62ced0f9dbbc1ba4ca62ad20da3e7fe">00188</a> <span class="keywordtype">float</span> <a class="code" href="classCEGUI_1_1FalagardEditbox.html#af62ced0f9dbbc1ba4ca62ad20da3e7fe" title="x rendering offset used last time we drew the widget.">d_lastTextOffset</a>;
<a name="l00190"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#a12049ea20a5d7dea8ec332f1c8c2017a">00190</a> <span class="keywordtype">bool</span> <a class="code" href="classCEGUI_1_1FalagardEditbox.html#a12049ea20a5d7dea8ec332f1c8c2017a" title="true if the caret imagery should blink.">d_blinkCaret</a>;
<a name="l00192"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#a411f94031aeadf1ed5a40223680934ad">00192</a> <span class="keywordtype">float</span> <a class="code" href="classCEGUI_1_1FalagardEditbox.html#a411f94031aeadf1ed5a40223680934ad" title="time-out in seconds used for blinking the caret.">d_caretBlinkTimeout</a>;
<a name="l00194"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#a4c7bda36ce6c822aee6da228afaa9df5">00194</a> <span class="keywordtype">float</span> <a class="code" href="classCEGUI_1_1FalagardEditbox.html#a4c7bda36ce6c822aee6da228afaa9df5" title="current time elapsed since last caret blink state change.">d_caretBlinkElapsed</a>;
<a name="l00196"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#a812ffe0497a66c7aa4180eaec4c84cef">00196</a> <span class="keywordtype">bool</span> <a class="code" href="classCEGUI_1_1FalagardEditbox.html#a812ffe0497a66c7aa4180eaec4c84cef" title="true if caret should be shown.">d_showCaret</a>;
<a name="l00198"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#a1f6f0200e1d0bcc46839e871d9037af9">00198</a> <a class="code" href="namespaceCEGUI.html#a379719d009ffa73a87100bb8b0b6fe5b" title="Enumeration of possible values to indicate the horizontal formatting to be used for a text component...">HorizontalTextFormatting</a> <a class="code" href="classCEGUI_1_1FalagardEditbox.html#a1f6f0200e1d0bcc46839e871d9037af9" title="horizontal formatting. Only supports left, right, and centred.">d_textFormatting</a>;
<a name="l00199"></a>00199 };
<a name="l00200"></a>00200
<a name="l00201"></a>00201 } <span class="comment">// End of CEGUI namespace section</span>
<a name="l00202"></a>00202
<a name="l00203"></a>00203 <span class="preprocessor">#if defined(_MSC_VER)</span>
<a name="l00204"></a>00204 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(pop)</span>
<a name="l00205"></a>00205 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00206"></a>00206 <span class="preprocessor"></span>
<a name="l00207"></a>00207 <span class="preprocessor">#endif // end of guard _FalEditbox_h_</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 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>
|
