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::RenderedString 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_1RenderedString.html">RenderedString</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-types">Protected Types</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::RenderedString Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::RenderedString" -->
<p>Class representing a rendered string of entities.
<a href="classCEGUI_1_1RenderedString.html#details">More...</a></p>
<p><a href="classCEGUI_1_1RenderedString-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="a42a5a58f938ecadb5679ac19a703dc25"></a><!-- doxytag: member="CEGUI::RenderedString::RenderedString" ref="a42a5a58f938ecadb5679ac19a703dc25" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#a42a5a58f938ecadb5679ac19a703dc25">RenderedString</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76e44fad40e8d1d87425707d5e004ab6"></a><!-- doxytag: member="CEGUI::RenderedString::~RenderedString" ref="a76e44fad40e8d1d87425707d5e004ab6" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#a76e44fad40e8d1d87425707d5e004ab6">~RenderedString</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#aeb9009641cc1f7be72284cbc173382ae">draw</a> (const size_t line, <a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> &buffer, const <a class="el" href="classCEGUI_1_1Vector2.html">Vector2</a> &position, const <a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> *mod_colours, const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> *clip_rect, const float space_extra) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Draw the string to a <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a>. <a href="#aeb9009641cc1f7be72284cbc173382ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Size.html">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#a4e2b499ef1bb412c22ce0b676d35ba6d">getPixelSize</a> (const size_t line) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the pixel size of the specified line. <a href="#a4e2b499ef1bb412c22ce0b676d35ba6d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aadf84132ad7f21960b60c4877f3402db"></a><!-- doxytag: member="CEGUI::RenderedString::appendComponent" ref="aadf84132ad7f21960b60c4877f3402db" args="(const RenderedStringComponent &component)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#aadf84132ad7f21960b60c4877f3402db">appendComponent</a> (const <a class="el" href="classCEGUI_1_1RenderedStringComponent.html">RenderedStringComponent</a> &component)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">append <em>component</em> to the list of components drawn for this string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae77d7888fe4e47e1bade669adddc8e27"></a><!-- doxytag: member="CEGUI::RenderedString::clearComponents" ref="ae77d7888fe4e47e1bade669adddc8e27" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#ae77d7888fe4e47e1bade669adddc8e27">clearComponents</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">clear the list of components drawn for this string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8155dade41af901fa5ab60d92dc5ccac"></a><!-- doxytag: member="CEGUI::RenderedString::getComponentCount" ref="a8155dade41af901fa5ab60d92dc5ccac" args="() const " -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#a8155dade41af901fa5ab60d92dc5ccac">getComponentCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the number of components that make up this string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#a2a1a21368455ac52ede9b85825abd17f">split</a> (const size_t line, float split_point, <a class="el" href="classCEGUI_1_1RenderedString.html">RenderedString</a> &left)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">split the string in line <em>line</em> as close to <em>split_point</em> as possible. <a href="#a2a1a21368455ac52ede9b85825abd17f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6374de852b0179dd8782aac854a8f308"></a><!-- doxytag: member="CEGUI::RenderedString::getSpaceCount" ref="a6374de852b0179dd8782aac854a8f308" args="(const size_t line) const " -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#a6374de852b0179dd8782aac854a8f308">getSpaceCount</a> (const size_t line) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the total number of spacing characters in the specified line. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa4a045974a289ff5b658c0a282f2eae2"></a><!-- doxytag: member="CEGUI::RenderedString::appendLineBreak" ref="aa4a045974a289ff5b658c0a282f2eae2" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#aa4a045974a289ff5b658c0a282f2eae2">appendLineBreak</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">linebreak the rendered string at the present position. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f5f27f2c705b6abdb9ad7194f7b2ed0"></a><!-- doxytag: member="CEGUI::RenderedString::getLineCount" ref="a2f5f27f2c705b6abdb9ad7194f7b2ed0" args="() const " -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#a2f5f27f2c705b6abdb9ad7194f7b2ed0">getLineCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return number of lines in this string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abcf0c8ec0bc79de82bd00d7182d84a93"></a><!-- doxytag: member="CEGUI::RenderedString::RenderedString" ref="abcf0c8ec0bc79de82bd00d7182d84a93" args="(const RenderedString &other)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#abcf0c8ec0bc79de82bd00d7182d84a93">RenderedString</a> (const <a class="el" href="classCEGUI_1_1RenderedString.html">RenderedString</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cbc00cef4fc906b3bff3e37acf3b834"></a><!-- doxytag: member="CEGUI::RenderedString::operator=" ref="a7cbc00cef4fc906b3bff3e37acf3b834" args="(const RenderedString &rhs)" -->
<a class="el" href="classCEGUI_1_1RenderedString.html">RenderedString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#a7cbc00cef4fc906b3bff3e37acf3b834">operator=</a> (const <a class="el" href="classCEGUI_1_1RenderedString.html">RenderedString</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a609f2c36212c28b70b8516fe379ca0cd"></a><!-- doxytag: member="CEGUI::RenderedString::ComponentList" ref="a609f2c36212c28b70b8516fe379ca0cd" args="" -->
typedef std::vector<br class="typebreak"/>
< <a class="el" href="classCEGUI_1_1RenderedStringComponent.html">RenderedStringComponent</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#a609f2c36212c28b70b8516fe379ca0cd">ComponentList</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Collection type used to hold the string components. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa813f11a2454e5cbcc32a2b44dac83ec"></a><!-- doxytag: member="CEGUI::RenderedString::LineInfo" ref="aa813f11a2454e5cbcc32a2b44dac83ec" args="" -->
typedef std::pair< size_t, size_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#aa813f11a2454e5cbcc32a2b44dac83ec">LineInfo</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">track info for a line. first is componetn idx, second is component count. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8ac0cc20b2665dd96b49b89e231dfdab"></a><!-- doxytag: member="CEGUI::RenderedString::LineList" ref="a8ac0cc20b2665dd96b49b89e231dfdab" args="" -->
typedef std::vector< <a class="el" href="classCEGUI_1_1RenderedString.html#aa813f11a2454e5cbcc32a2b44dac83ec">LineInfo</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#a8ac0cc20b2665dd96b49b89e231dfdab">LineList</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Collection type used to hold details about the lines. <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="a0cd22b08e1097d17bb001cba7f42d02d"></a><!-- doxytag: member="CEGUI::RenderedString::cloneComponentList" ref="a0cd22b08e1097d17bb001cba7f42d02d" args="(const ComponentList &list)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#a0cd22b08e1097d17bb001cba7f42d02d">cloneComponentList</a> (const <a class="el" href="classCEGUI_1_1RenderedString.html#a609f2c36212c28b70b8516fe379ca0cd">ComponentList</a> &list)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Make this object's component list a clone of <em>list</em>. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8806a71bb8821a95d8116a96017aacd0"></a><!-- doxytag: member="CEGUI::RenderedString::clearComponentList" ref="a8806a71bb8821a95d8116a96017aacd0" args="(ComponentList &list)" -->
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#a8806a71bb8821a95d8116a96017aacd0">clearComponentList</a> (<a class="el" href="classCEGUI_1_1RenderedString.html#a609f2c36212c28b70b8516fe379ca0cd">ComponentList</a> &list)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free components in the given ComponentList and clear the list. <br/></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="a7e5a1336fb0c326b1b4e075f9ef16591"></a><!-- doxytag: member="CEGUI::RenderedString::d_components" ref="a7e5a1336fb0c326b1b4e075f9ef16591" args="" -->
<a class="el" href="classCEGUI_1_1RenderedString.html#a609f2c36212c28b70b8516fe379ca0cd">ComponentList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#a7e5a1336fb0c326b1b4e075f9ef16591">d_components</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1RenderedStringComponent.html" title="Base class representing a part of a rendered string. The 'part' represented may be a text string...">RenderedStringComponent</a> objects that comprise this <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1734841abc75097e022aeeb4458fd0de"></a><!-- doxytag: member="CEGUI::RenderedString::d_lines" ref="a1734841abc75097e022aeeb4458fd0de" args="" -->
<a class="el" href="classCEGUI_1_1RenderedString.html#a8ac0cc20b2665dd96b49b89e231dfdab">LineList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedString.html#a1734841abc75097e022aeeb4458fd0de">d_lines</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">lines that make up this string. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class representing a rendered string of entities. </p>
<p>Here 'string' does not refer solely to a text string, rather a string of any renderable items. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aeb9009641cc1f7be72284cbc173382ae"></a><!-- doxytag: member="CEGUI::RenderedString::draw" ref="aeb9009641cc1f7be72284cbc173382ae" args="(const size_t line, GeometryBuffer &buffer, const Vector2 &position, const ColourRect *mod_colours, const Rect *clip_rect, const float space_extra) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::RenderedString::draw </td>
<td>(</td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>line</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> & </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Vector2.html">Vector2</a> & </td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> * </td>
<td class="paramname"><em>mod_colours</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> * </td>
<td class="paramname"><em>clip_rect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float </td>
<td class="paramname"><em>space_extra</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draw the string to a <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">line</td><td>The line of the <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a> to draw.</td></tr>
<tr><td class="paramname">buffer</td><td><a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> object that is to receive the geometry resulting from the draw operations.</td></tr>
<tr><td class="paramname">position</td><td><a class="el" href="classCEGUI_1_1Vector2.html" title="Class used as a two dimensional vector (aka a Point)">Vector2</a> describing the position where the <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a> is to be drawn. Note that this is not the final onscreen position, but the position as offset from the top-left corner of the entity represented by the <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a>.</td></tr>
<tr><td class="paramname">mod_colours</td><td>Pointer to a <a class="el" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a> describing colour values that are to be modulated with the any stored colour values to calculate the final colour values to be used. This may be 0 if no modulated colours are required. NB: Each specific component will decide if and how it will apply the modulated colours.</td></tr>
<tr><td class="paramname">clip_rect</td><td>Pointer to a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object that describes a clipping rectangle that should be used when drawing the <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a>. This may be 0 if no clipping is required.</td></tr>
<tr><td class="paramname">space_extra</td><td>float value indicating additional padding value to be applied to space characters in the string.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1InvalidRequestException.html" title="Exception class used when some impossible request was made of the system.">InvalidRequestException</a></td><td>thrown if <em>line</em> is out of range. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4e2b499ef1bb412c22ce0b676d35ba6d"></a><!-- doxytag: member="CEGUI::RenderedString::getPixelSize" ref="a4e2b499ef1bb412c22ce0b676d35ba6d" args="(const size_t line) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Size.html">Size</a> CEGUI::RenderedString::getPixelSize </td>
<td>(</td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>line</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return the pixel size of the specified line. </p>
<p>Return the pixel size of a specified line for the <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">line</td><td>The line number whose size is to be returned.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> object describing the size of the rendered output of the specified line of this <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a>, in pixels.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1InvalidRequestException.html" title="Exception class used when some impossible request was made of the system.">InvalidRequestException</a></td><td>thrown if <em>line</em> is out of range. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2a1a21368455ac52ede9b85825abd17f"></a><!-- doxytag: member="CEGUI::RenderedString::split" ref="a2a1a21368455ac52ede9b85825abd17f" args="(const size_t line, float split_point, RenderedString &left)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::RenderedString::split </td>
<td>(</td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>line</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>split_point</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1RenderedString.html">RenderedString</a> & </td>
<td class="paramname"><em>left</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>split the string in line <em>line</em> as close to <em>split_point</em> as possible. </p>
<p>The <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a> <em>left</em> will receive the left portion of the split, while the right portion of the split will remain in this <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">line</td><td>The line number on which the split is to occur.</td></tr>
<tr><td class="paramname">split_point</td><td>float value specifying the pixel location where the split should occur. The actual split will occur as close to this point as possible, though preferring a shorter 'left' portion when the split can not be made exactly at the requested point.</td></tr>
<tr><td class="paramname">left</td><td><a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a> object that will receieve the left portion of the split. Any existing content in the <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a> is replaced.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1InvalidRequestException.html" title="Exception class used when some impossible request was made of the system.">InvalidRequestException</a></td><td>thrown if <em>line</em> is out of range. </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>
|
