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: CEGUI::RenderedStringWidgetComponent 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_1RenderedStringWidgetComponent.html">RenderedStringWidgetComponent</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::RenderedStringWidgetComponent Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::RenderedStringWidgetComponent" --><!-- doxytag: inherits="CEGUI::RenderedStringComponent" -->
<p><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> component that moves a widget to appear as part of the string.
<a href="classCEGUI_1_1RenderedStringWidgetComponent.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::RenderedStringWidgetComponent:</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_1RenderedStringWidgetComponent__inherit__graph.gif" border="0" usemap="#CEGUI_1_1RenderedStringWidgetComponent_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1RenderedStringWidgetComponent_inherit__map" id="CEGUI_1_1RenderedStringWidgetComponent_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1RenderedStringComponent.html" title="Base class representing a part of a rendered string. The 'part' represented may be a text string..." alt="" coords="25,5,255,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::RenderedStringWidgetComponent:</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_1RenderedStringWidgetComponent__coll__graph.gif" border="0" usemap="#CEGUI_1_1RenderedStringWidgetComponent_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1RenderedStringWidgetComponent_coll__map" id="CEGUI_1_1RenderedStringWidgetComponent_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1RenderedStringComponent.html" title="Base class representing a part of a rendered string. The 'part' represented may be a text string..." alt="" coords="5,181,235,211"/><area shape="rect" id="node4" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle." alt="" coords="181,5,283,35"/><area shape="rect" id="node6" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv..." alt="" coords="259,181,379,211"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1RenderedStringWidgetComponent-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="a21f7ecd991d87a4e528fbab9dd8d2b33"></a><!-- doxytag: member="CEGUI::RenderedStringWidgetComponent::RenderedStringWidgetComponent" ref="a21f7ecd991d87a4e528fbab9dd8d2b33" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWidgetComponent.html#a21f7ecd991d87a4e528fbab9dd8d2b33">RenderedStringWidgetComponent</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="a04d919822398f243afb87c3229c42c20"></a><!-- doxytag: member="CEGUI::RenderedStringWidgetComponent::RenderedStringWidgetComponent" ref="a04d919822398f243afb87c3229c42c20" args="(const String &widget_name)" -->
 </td><td class="memItemRight" valign="bottom"><b>RenderedStringWidgetComponent</b> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &widget_name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5b3aed13d53e8d3d203920cf2c14df2"></a><!-- doxytag: member="CEGUI::RenderedStringWidgetComponent::RenderedStringWidgetComponent" ref="aa5b3aed13d53e8d3d203920cf2c14df2" args="(Window *widget)" -->
 </td><td class="memItemRight" valign="bottom"><b>RenderedStringWidgetComponent</b> (<a class="el" href="classCEGUI_1_1Window.html">Window</a> *widget)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e4bf6a6f76a1a59a1486b9102d17a80"></a><!-- doxytag: member="CEGUI::RenderedStringWidgetComponent::setWindow" ref="a3e4bf6a6f76a1a59a1486b9102d17a80" args="(const String &widget_name)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWidgetComponent.html#a3e4bf6a6f76a1a59a1486b9102d17a80">setWindow</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &widget_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the window to be controlled by this component. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace1c599b2c479a468ea57b2e3d708109"></a><!-- doxytag: member="CEGUI::RenderedStringWidgetComponent::setWindow" ref="ace1c599b2c479a468ea57b2e3d708109" args="(Window *widget)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWidgetComponent.html#ace1c599b2c479a468ea57b2e3d708109">setWindow</a> (<a class="el" href="classCEGUI_1_1Window.html">Window</a> *widget)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the window to be controlled by this component. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a526d44c9bdb50856e991d3757b8c901b"></a><!-- doxytag: member="CEGUI::RenderedStringWidgetComponent::getWindow" ref="a526d44c9bdb50856e991d3757b8c901b" args="() const " -->
const <a class="el" href="classCEGUI_1_1Window.html">Window</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWidgetComponent.html#a526d44c9bdb50856e991d3757b8c901b">getWindow</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the window currently controlled by this component <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20fa4f359b3d290439a74e10a8de066b"></a><!-- doxytag: member="CEGUI::RenderedStringWidgetComponent::draw" ref="a20fa4f359b3d290439a74e10a8de066b" args="(GeometryBuffer &buffer, const Vector2 &position, const ColourRect *mod_colours, const Rect *clip_rect, const float vertical_space, const float space_extra) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWidgetComponent.html#a20fa4f359b3d290439a74e10a8de066b">draw</a> (<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 vertical_space, const float space_extra) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">draw the component. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34b9fe8cdee78ce0b0fc5956183f0dec"></a><!-- doxytag: member="CEGUI::RenderedStringWidgetComponent::getPixelSize" ref="a34b9fe8cdee78ce0b0fc5956183f0dec" args="() const " -->
<a class="el" href="classCEGUI_1_1Size.html">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWidgetComponent.html#a34b9fe8cdee78ce0b0fc5956183f0dec">getPixelSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the pixel size of the rendered component. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12da8d5a16a5202107e0235c3940b991"></a><!-- doxytag: member="CEGUI::RenderedStringWidgetComponent::canSplit" ref="a12da8d5a16a5202107e0235c3940b991" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWidgetComponent.html#a12da8d5a16a5202107e0235c3940b991">canSplit</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return whether the component can be split <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1RenderedStringWidgetComponent.html">RenderedStringWidgetComponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWidgetComponent.html#a8dbd95833cd84b6f394e53874bdd57ca">split</a> (float split_point, bool first_component)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">split the component as close to split_point as possible, returning a new <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> of the same type as '*this' holding the left side of the split, and leaving the right side of the split in this object. <a href="#a8dbd95833cd84b6f394e53874bdd57ca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5cce32e5dcdaea36f46b76653c626da3"></a><!-- doxytag: member="CEGUI::RenderedStringWidgetComponent::clone" ref="a5cce32e5dcdaea36f46b76653c626da3" args="() const " -->
<a class="el" href="classCEGUI_1_1RenderedStringWidgetComponent.html">RenderedStringWidgetComponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWidgetComponent.html#a5cce32e5dcdaea36f46b76653c626da3">clone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">clone this component. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9a7bf69bbcd7cccfdcdd0abd231c35a"></a><!-- doxytag: member="CEGUI::RenderedStringWidgetComponent::getSpaceCount" ref="ae9a7bf69bbcd7cccfdcdd0abd231c35a" args="() const " -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWidgetComponent.html#ae9a7bf69bbcd7cccfdcdd0abd231c35a">getSpaceCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the total number of spacing characters in the string. <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="aca48667097f535a7f279cac0a13252ed"></a><!-- doxytag: member="CEGUI::RenderedStringWidgetComponent::d_window" ref="aca48667097f535a7f279cac0a13252ed" args="" -->
<a class="el" href="classCEGUI_1_1Window.html">Window</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWidgetComponent.html#aca48667097f535a7f279cac0a13252ed">d_window</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">pointer to the window controlled by this component. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> component that moves a widget to appear as part of the string. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8dbd95833cd84b6f394e53874bdd57ca"></a><!-- doxytag: member="CEGUI::RenderedStringWidgetComponent::split" ref="a8dbd95833cd84b6f394e53874bdd57ca" args="(float split_point, bool first_component)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1RenderedStringWidgetComponent.html">RenderedStringWidgetComponent</a>* CEGUI::RenderedStringWidgetComponent::split </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">bool </td>
<td class="paramname"><em>first_component</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>split the component as close to split_point as possible, returning a new <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> of the same type as '*this' holding the left side of the split, and leaving the right side of the split in this object. </p>
<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 the <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> does not support being split. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classCEGUI_1_1RenderedStringComponent.html#a3d601347fb579d736877083ea0362a98">CEGUI::RenderedStringComponent</a>.</p>
</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>
|
