1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>Crazy Eddies GUI System: FalEditbox.h Source File</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.2 -->
11
<script type="text/javascript">
12
function hasClass(ele,cls) {
13
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
16
function addClass(ele,cls) {
17
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
20
function removeClass(ele,cls) {
21
if (hasClass(ele,cls)) {
22
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
23
ele.className=ele.className.replace(reg,' ');
27
function toggleVisibility(linkObj) {
28
var base = linkObj.getAttribute('id');
29
var summary = document.getElementById(base + '-summary');
30
var content = document.getElementById(base + '-content');
31
var trigger = document.getElementById(base + '-trigger');
32
if ( hasClass(linkObj,'closed') ) {
33
summary.style.display = 'none';
34
content.style.display = 'block';
35
trigger.src = 'open.png';
36
removeClass(linkObj,'closed');
37
addClass(linkObj,'opened');
38
} else if ( hasClass(linkObj,'opened') ) {
39
summary.style.display = 'block';
40
content.style.display = 'none';
41
trigger.src = 'closed.png';
42
removeClass(linkObj,'opened');
43
addClass(linkObj,'closed');
48
<div class="navigation" id="top">
51
<li><a href="index.html"><span>Main Page</span></a></li>
52
<li><a href="pages.html"><span>Related Pages</span></a></li>
53
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
54
<li><a href="annotated.html"><span>Classes</span></a></li>
55
<li class="current"><a href="files.html"><span>Files</span></a></li>
60
<li><a href="files.html"><span>File List</span></a></li>
64
<div class="headertitle">
65
<h1>FalEditbox.h</h1> </div>
67
<div class="contents">
68
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***********************************************************************</span>
69
<a name="l00002"></a>00002 <span class="comment"> filename: FalEditbox.h</span>
70
<a name="l00003"></a>00003 <span class="comment"> created: Sat Jun 25 2005</span>
71
<a name="l00004"></a>00004 <span class="comment"> author: Paul D Turner <paul@cegui.org.uk></span>
72
<a name="l00005"></a>00005 <span class="comment">*************************************************************************/</span>
73
<a name="l00006"></a>00006 <span class="comment">/***************************************************************************</span>
74
<a name="l00007"></a>00007 <span class="comment"> * Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team</span>
75
<a name="l00008"></a>00008 <span class="comment"> *</span>
76
<a name="l00009"></a>00009 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining</span>
77
<a name="l00010"></a>00010 <span class="comment"> * a copy of this software and associated documentation files (the</span>
78
<a name="l00011"></a>00011 <span class="comment"> * "Software"), to deal in the Software without restriction, including</span>
79
<a name="l00012"></a>00012 <span class="comment"> * without limitation the rights to use, copy, modify, merge, publish,</span>
80
<a name="l00013"></a>00013 <span class="comment"> * distribute, sublicense, and/or sell copies of the Software, and to</span>
81
<a name="l00014"></a>00014 <span class="comment"> * permit persons to whom the Software is furnished to do so, subject to</span>
82
<a name="l00015"></a>00015 <span class="comment"> * the following conditions:</span>
83
<a name="l00016"></a>00016 <span class="comment"> *</span>
84
<a name="l00017"></a>00017 <span class="comment"> * The above copyright notice and this permission notice shall be</span>
85
<a name="l00018"></a>00018 <span class="comment"> * included in all copies or substantial portions of the Software.</span>
86
<a name="l00019"></a>00019 <span class="comment"> *</span>
87
<a name="l00020"></a>00020 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
88
<a name="l00021"></a>00021 <span class="comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
89
<a name="l00022"></a>00022 <span class="comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span>
90
<a name="l00023"></a>00023 <span class="comment"> * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR</span>
91
<a name="l00024"></a>00024 <span class="comment"> * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,</span>
92
<a name="l00025"></a>00025 <span class="comment"> * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR</span>
93
<a name="l00026"></a>00026 <span class="comment"> * OTHER DEALINGS IN THE SOFTWARE.</span>
94
<a name="l00027"></a>00027 <span class="comment"> ***************************************************************************/</span>
95
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef _FalEditbox_h_</span>
96
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define _FalEditbox_h_</span>
97
<a name="l00030"></a>00030 <span class="preprocessor"></span>
98
<a name="l00031"></a>00031 <span class="preprocessor">#include "FalModule.h"</span>
99
<a name="l00032"></a>00032 <span class="preprocessor">#include "../../elements/CEGUIEditbox.h"</span>
100
<a name="l00033"></a>00033 <span class="preprocessor">#include "FalEditboxProperties.h"</span>
101
<a name="l00034"></a>00034
102
<a name="l00035"></a>00035 <span class="preprocessor">#if defined(_MSC_VER)</span>
103
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(push)</span>
104
<a name="l00037"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#a7738dbfdbb8abf27b361d7be0e563557">00037</a> <span class="preprocessor"></span><span class="preprocessor"># pragma warning(disable : 4251)</span>
105
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
106
<a name="l00039"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#ac33be68164b67a24175678f9a7d59b32">00039</a> <span class="preprocessor"></span>
107
<a name="l00040"></a>00040 <span class="comment">// Start of CEGUI namespace section</span>
108
<a name="l00041"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#a27f798734caa3bc04f6be9fbd229eed7">00041</a> <span class="keyword">namespace </span>CEGUI
109
<a name="l00042"></a>00042 {
110
<a name="l00077"></a>00077 <span class="keyword">class </span>FALAGARDBASE_API FalagardEditbox : <span class="keyword">public</span> <a class="code" href="classCEGUI_1_1EditboxWindowRenderer.html" title="Base class for the EditboxWindowRenderer class.">EditboxWindowRenderer</a>
111
<a name="l00078"></a>00078 {
112
<a name="l00079"></a>00079 <span class="keyword">public</span>:
113
<a name="l00081"></a>00081 <span class="keyword">static</span> <span class="keyword">const</span> utf8 TypeName[];
114
<a name="l00083"></a>00083 <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> UnselectedTextColourPropertyName;
115
<a name="l00085"></a>00085 <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> SelectedTextColourPropertyName;
116
<a name="l00087"></a>00087 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">float</span> DefaultCaretBlinkTimeout;
117
<a name="l00088"></a>00088
118
<a name="l00093"></a>00093 FalagardEditbox(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& type);
119
<a name="l00094"></a>00094
120
<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>;
121
<a name="l00104"></a>00104
122
<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>;
123
<a name="l00114"></a>00114
124
<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>;
125
<a name="l00125"></a>00125
126
<a name="l00127"></a>00127 <span class="keywordtype">bool</span> isCaretBlinkEnabled() <span class="keyword">const</span>;
127
<a name="l00129"></a>00129 <span class="keywordtype">float</span> getCaretBlinkTimeout() <span class="keyword">const</span>;
128
<a name="l00131"></a>00131 <span class="keywordtype">void</span> setCaretBlinkEnabled(<span class="keywordtype">bool</span> enable);
129
<a name="l00133"></a>00133 <span class="keywordtype">void</span> setCaretBlinkTimeout(<span class="keywordtype">float</span> seconds);
130
<a name="l00134"></a>00134
131
<a name="l00146"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#a12049ea20a5d7dea8ec332f1c8c2017a">00146</a> <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);
132
<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>;
133
<a name="l00148"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#a411f94031aeadf1ed5a40223680934ad">00148</a>
134
<a name="l00149"></a>00149 <span class="keywordtype">void</span> render();
135
<a name="l00150"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#a4c7bda36ce6c822aee6da228afaa9df5">00150</a>
136
<a name="l00151"></a>00151 <span class="comment">// overridden from EditboxWindowRenderer base class.</span>
137
<a name="l00152"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#a812ffe0497a66c7aa4180eaec4c84cef">00152</a> <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>;
138
<a name="l00153"></a>00153 <span class="comment">// overridden from WindowRenderer class</span>
139
<a name="l00154"></a><a class="code" href="classCEGUI_1_1FalagardEditbox.html#a1f6f0200e1d0bcc46839e871d9037af9">00154</a> <span class="keywordtype">void</span> update(<span class="keywordtype">float</span> elapsed);
140
<a name="l00155"></a>00155
141
<a name="l00156"></a>00156 <span class="keyword">protected</span>:
142
<a name="l00157"></a>00157 <span class="comment">// properties</span>
143
<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;
144
<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;
145
<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;
146
<a name="l00161"></a>00161
147
<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 &amp; feel information for a particular widget type.">WidgetLookFeel</a>& wlf) <span class="keyword">const</span>;
148
<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>;
149
<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>;
150
<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,
151
<a name="l00168"></a>00168 <span class="keyword">const</span> <span class="keywordtype">float</span> text_extent,
152
<a name="l00169"></a>00169 <span class="keyword">const</span> <span class="keywordtype">float</span> caret_width,
153
<a name="l00170"></a>00170 <span class="keyword">const</span> <span class="keywordtype">float</span> extent_to_caret);
154
<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 &amp; feel information for a particular widget type.">WidgetLookFeel</a>& wlf,
155
<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,
156
<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,
157
<a name="l00174"></a>00174 <span class="keywordtype">float</span> text_offset);
158
<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 &amp; feel information for a particular widget type.">WidgetLookFeel</a>& wlf,
159
<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,
160
<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,
161
<a name="l00178"></a>00178 <span class="keywordtype">float</span> text_offset);
162
<a name="l00179"></a>00179 <span class="keywordtype">bool</span> editboxIsFocussed() <span class="keyword">const</span>;
163
<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,
164
<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,
165
<a name="l00182"></a>00182 <span class="keyword">const</span> <span class="keywordtype">float</span> text_offset,
166
<a name="l00183"></a>00183 <span class="keyword">const</span> <span class="keywordtype">float</span> extent_to_caret) <span class="keyword">const</span>;
167
<a name="l00184"></a>00184
168
<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);
169
<a name="l00186"></a>00186
170
<a name="l00188"></a>00188 <span class="keywordtype">float</span> d_lastTextOffset;
171
<a name="l00190"></a>00190 <span class="keywordtype">bool</span> d_blinkCaret;
172
<a name="l00192"></a>00192 <span class="keywordtype">float</span> d_caretBlinkTimeout;
173
<a name="l00194"></a>00194 <span class="keywordtype">float</span> d_caretBlinkElapsed;
174
<a name="l00196"></a>00196 <span class="keywordtype">bool</span> d_showCaret;
175
<a name="l00198"></a>00198 <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> d_textFormatting;
176
<a name="l00199"></a>00199 };
177
<a name="l00200"></a>00200
178
<a name="l00201"></a>00201 } <span class="comment">// End of CEGUI namespace section</span>
179
<a name="l00202"></a>00202
180
<a name="l00203"></a>00203 <span class="preprocessor">#if defined(_MSC_VER)</span>
181
<a name="l00204"></a>00204 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(pop)</span>
182
<a name="l00205"></a>00205 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
183
<a name="l00206"></a>00206 <span class="preprocessor"></span>
184
<a name="l00207"></a>00207 <span class="preprocessor">#endif // end of guard _FalEditbox_h_</span>
187
<hr class="footer"/><address class="footer"><small>Generated on Fri Nov 19 2010 12:01:20 for Crazy Eddies GUI System by 
188
<a href="http://www.doxygen.org/index.html">
189
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
added
removed
docs/FalEditbox_8h_source.html
