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
|
<!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::TextUtils 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_1TextUtils.html">TextUtils</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::TextUtils Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::TextUtils" -->
<p>Text utility support class. This class is all static members. You do not create instances of this class.
<a href="classCEGUI_1_1TextUtils.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"/> Collaboration diagram for CEGUI::TextUtils:</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_1TextUtils__coll__graph.gif" border="0" usemap="#CEGUI_1_1TextUtils_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1TextUtils_coll__map" id="CEGUI_1_1TextUtils_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="15,5,121,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1TextUtils-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextUtils.html#aa749a941513ac205707a5bdaeb22aa58">getNextWord</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &str, <a class="el" href="classCEGUI_1_1String.html#a4fd79b6226fe39b69c6a6a624d2d2728">String::size_type</a> start_idx=0, const <a class="el" href="classCEGUI_1_1String.html">String</a> &delimiters=<a class="el" href="classCEGUI_1_1TextUtils.html#af0075ef271a4f6aead39dae5e7356d6f">DefaultWhitespace</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return a <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the the next word in a <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>. <a href="#aa749a941513ac205707a5bdaeb22aa58"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCEGUI_1_1String.html#a4fd79b6226fe39b69c6a6a624d2d2728">String::size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextUtils.html#a52d6f3e51aab00405bf2caa30658a7b9">getWordStartIdx</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &str, <a class="el" href="classCEGUI_1_1String.html#a4fd79b6226fe39b69c6a6a624d2d2728">String::size_type</a> idx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the index of the first character of the word at <em>idx</em>. <a href="#a52d6f3e51aab00405bf2caa30658a7b9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCEGUI_1_1String.html#a4fd79b6226fe39b69c6a6a624d2d2728">String::size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextUtils.html#ad842bf8a013b9eda9f2fd6f129a41035">getNextWordStartIdx</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &str, <a class="el" href="classCEGUI_1_1String.html#a4fd79b6226fe39b69c6a6a624d2d2728">String::size_type</a> idx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the index of the first character of the word after the word at <em>idx</em>. <a href="#ad842bf8a013b9eda9f2fd6f129a41035"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextUtils.html#af24f024c0d01e29f97f6eb48dd8a2418">trimLeadingChars</a> (<a class="el" href="classCEGUI_1_1String.html">String</a> &str, const <a class="el" href="classCEGUI_1_1String.html">String</a> &chars)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Trim all characters from the set specified in <em>chars</em> from the begining of <em>str</em>. <a href="#af24f024c0d01e29f97f6eb48dd8a2418"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1TextUtils.html#ab537aea261cd4484f05311dc7107213d">trimTrailingChars</a> (<a class="el" href="classCEGUI_1_1String.html">String</a> &str, const <a class="el" href="classCEGUI_1_1String.html">String</a> &chars)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Trim all characters from the set specified in <em>chars</em> from the end of <em>str</em>. <a href="#ab537aea261cd4484f05311dc7107213d"></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="af0075ef271a4f6aead39dae5e7356d6f"></a><!-- doxytag: member="CEGUI::TextUtils::DefaultWhitespace" ref="af0075ef271a4f6aead39dae5e7356d6f" 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_1TextUtils.html#af0075ef271a4f6aead39dae5e7356d6f">DefaultWhitespace</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The default set of whitespace. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9e41487a98c2414cbe81689f5fedfef"></a><!-- doxytag: member="CEGUI::TextUtils::DefaultAlphanumerical" ref="ab9e41487a98c2414cbe81689f5fedfef" 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_1TextUtils.html#ab9e41487a98c2414cbe81689f5fedfef">DefaultAlphanumerical</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">default set of alphanumericals. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e1a137062fa0741a8746fa5f79676c0"></a><!-- doxytag: member="CEGUI::TextUtils::DefaultWrapDelimiters" ref="a8e1a137062fa0741a8746fa5f79676c0" 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_1TextUtils.html#a8e1a137062fa0741a8746fa5f79676c0">DefaultWrapDelimiters</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The default set of word-wrap delimiters. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Text utility support class. This class is all static members. You do not create instances of this class. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa749a941513ac205707a5bdaeb22aa58"></a><!-- doxytag: member="CEGUI::TextUtils::getNextWord" ref="aa749a941513ac205707a5bdaeb22aa58" args="(const String &str, String::size_type start_idx=0, const String &delimiters=DefaultWhitespace)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCEGUI_1_1String.html">String</a> CEGUI::TextUtils::getNextWord </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1String.html#a4fd79b6226fe39b69c6a6a624d2d2728">String::size_type</a> </td>
<td class="paramname"><em>start_idx</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>delimiters</em> = <code><a class="el" href="classCEGUI_1_1TextUtils.html#af0075ef271a4f6aead39dae5e7356d6f">DefaultWhitespace</a></code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return a <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the the next word in a <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>. </p>
<p>This method returns a <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the the word, starting at index <em>start_idx</em>, of <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> <em>str</em> as delimited by the code points specified in string <em>delimiters</em> (or the ends of the input string).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the input data.</td></tr>
<tr><td class="paramname">start_idx</td><td>index into <em>str</em> where the search for the next word is to begin. Defaults to start of <em>str</em>.</td></tr>
<tr><td class="paramname">delimiters</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the set of delimiter code points to be used when determining the start and end points of a word in string <em>str</em>. Defaults to whitespace.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the next <em>delimiters</em> delimited word from <em>str</em>, starting at index <em>start_idx</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="ad842bf8a013b9eda9f2fd6f129a41035"></a><!-- doxytag: member="CEGUI::TextUtils::getNextWordStartIdx" ref="ad842bf8a013b9eda9f2fd6f129a41035" args="(const String &str, String::size_type idx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCEGUI_1_1String.html#a4fd79b6226fe39b69c6a6a624d2d2728">String::size_type</a> CEGUI::TextUtils::getNextWordStartIdx </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1String.html#a4fd79b6226fe39b69c6a6a624d2d2728">String::size_type</a> </td>
<td class="paramname"><em>idx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the index of the first character of the word after the word at <em>idx</em>. </p>
<p>/note This currently uses DefaultWhitespace and DefaultAlphanumerical to determine groupings for what constitutes a 'word'.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing text.</td></tr>
<tr><td class="paramname">idx</td><td>Index into <em>str</em> where search is to begin.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Index into <em>str</em> which marks the begining of the word at after the word at index <em>idx</em>. If <em>idx</em> is within the last word, then the return is the last index in <em>str</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="a52d6f3e51aab00405bf2caa30658a7b9"></a><!-- doxytag: member="CEGUI::TextUtils::getWordStartIdx" ref="a52d6f3e51aab00405bf2caa30658a7b9" args="(const String &str, String::size_type idx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCEGUI_1_1String.html#a4fd79b6226fe39b69c6a6a624d2d2728">String::size_type</a> CEGUI::TextUtils::getWordStartIdx </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1String.html#a4fd79b6226fe39b69c6a6a624d2d2728">String::size_type</a> </td>
<td class="paramname"><em>idx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the index of the first character of the word at <em>idx</em>. </p>
<p>/note This currently uses DefaultWhitespace and DefaultAlphanumerical to determine groupings for what constitutes a 'word'.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing text.</td></tr>
<tr><td class="paramname">idx</td><td>Index into <em>str</em> where search for start of word is to begin.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Index into <em>str</em> which marks the begining of the word at index <em>idx</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="af24f024c0d01e29f97f6eb48dd8a2418"></a><!-- doxytag: member="CEGUI::TextUtils::trimLeadingChars" ref="af24f024c0d01e29f97f6eb48dd8a2418" args="(String &str, const String &chars)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void CEGUI::TextUtils::trimLeadingChars </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>chars</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Trim all characters from the set specified in <em>chars</em> from the begining of <em>str</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object to be trimmed.</td></tr>
<tr><td class="paramname">chars</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the set of code points to be trimmed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab537aea261cd4484f05311dc7107213d"></a><!-- doxytag: member="CEGUI::TextUtils::trimTrailingChars" ref="ab537aea261cd4484f05311dc7107213d" args="(String &str, const String &chars)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void CEGUI::TextUtils::trimTrailingChars </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>chars</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Trim all characters from the set specified in <em>chars</em> from the end of <em>str</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object to be trimmed.</td></tr>
<tr><td class="paramname">chars</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the set of code points to be trimmed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
