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
|
<!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::ComponentArea 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_1ComponentArea.html">ComponentArea</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::ComponentArea Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::ComponentArea" -->
<p>Class that represents a target area for a widget or imagery component.
<a href="classCEGUI_1_1ComponentArea.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::ComponentArea:</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_1ComponentArea__coll__graph.gif" border="0" usemap="#CEGUI_1_1ComponentArea_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1ComponentArea_coll__map" id="CEGUI_1_1ComponentArea_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Dimension.html" title="Class representing some kind of dimension." alt="" coords="5,101,139,131"/><area shape="rect" id="node4" href="classCEGUI_1_1BaseDim.html" title="Abstract interface for a generic 'dimension' class." alt="" coords="9,5,135,35"/><area shape="rect" id="node7" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="164,101,271,131"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1ComponentArea-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="el" href="classCEGUI_1_1Rect.html">Rect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComponentArea.html#abde46aada1bc73c574fdbaea5a76c515">getPixelRect</a> (const <a class="el" href="classCEGUI_1_1Window.html">Window</a> &wnd) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> describing the absolute pixel area represented by this <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a>. <a href="#abde46aada1bc73c574fdbaea5a76c515"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Rect.html">Rect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComponentArea.html#a737a4de9f7228058197acb9294ff25e4">getPixelRect</a> (const <a class="el" href="classCEGUI_1_1Window.html">Window</a> &wnd, const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> &container) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> describing the absolute pixel area represented by this <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a>. <a href="#a737a4de9f7228058197acb9294ff25e4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComponentArea.html#a58472fbfa1deb5c0b4ab68cfcf9435ae">writeXMLToStream</a> (<a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> &xml_stream) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes an xml representation of this <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a> to <em>out_stream</em>. <a href="#a58472fbfa1deb5c0b4ab68cfcf9435ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComponentArea.html#a2b5ebbc49b04a12efb998e4bb8f97b8c">isAreaFetchedFromProperty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether this <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a> fetches it's area via a property on the target window. <a href="#a2b5ebbc49b04a12efb998e4bb8f97b8c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComponentArea.html#aebef0f74f3d3b2a4f29eda2820925554">getAreaPropertySource</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the property that will be used to determine the pixel area for this <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a>. <a href="#aebef0f74f3d3b2a4f29eda2820925554"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComponentArea.html#aa064db887a78e4d73e44abd94028c9c8">setAreaPropertySource</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &property)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the property that will be used to determine the pixel area for this <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a>. <a href="#aa064db887a78e4d73e44abd94028c9c8"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45f7ff493e3adb554827cd2221330f84"></a><!-- doxytag: member="CEGUI::ComponentArea::d_left" ref="a45f7ff493e3adb554827cd2221330f84" args="" -->
<a class="el" href="classCEGUI_1_1Dimension.html">Dimension</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComponentArea.html#a45f7ff493e3adb554827cd2221330f84">d_left</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Left edge of the area. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad5553a39ee57f6279176a5f55a9c1cbf"></a><!-- doxytag: member="CEGUI::ComponentArea::d_top" ref="ad5553a39ee57f6279176a5f55a9c1cbf" args="" -->
<a class="el" href="classCEGUI_1_1Dimension.html">Dimension</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComponentArea.html#ad5553a39ee57f6279176a5f55a9c1cbf">d_top</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Top edge of the area. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c090d3b8eddf840b298cf70d5891cbf"></a><!-- doxytag: member="CEGUI::ComponentArea::d_right_or_width" ref="a8c090d3b8eddf840b298cf70d5891cbf" args="" -->
<a class="el" href="classCEGUI_1_1Dimension.html">Dimension</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComponentArea.html#a8c090d3b8eddf840b298cf70d5891cbf">d_right_or_width</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Either the right edge or the width of the area. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7e5eb1b31bfcea6a6da43d170e76a5f"></a><!-- doxytag: member="CEGUI::ComponentArea::d_bottom_or_height" ref="af7e5eb1b31bfcea6a6da43d170e76a5f" args="" -->
<a class="el" href="classCEGUI_1_1Dimension.html">Dimension</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1ComponentArea.html#af7e5eb1b31bfcea6a6da43d170e76a5f">d_bottom_or_height</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Either the bototm edge or the height of the area. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class that represents a target area for a widget or imagery component. </p>
<p>This is essentially a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> built out of <a class="el" href="classCEGUI_1_1Dimension.html" title="Class representing some kind of dimension.">Dimension</a> objects. Of note is that what would normally be the 'right' and 'bottom' edges may alternatively represent width and height depending upon what the assigned Dimension(s) represent. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aebef0f74f3d3b2a4f29eda2820925554"></a><!-- doxytag: member="CEGUI::ComponentArea::getAreaPropertySource" ref="aebef0f74f3d3b2a4f29eda2820925554" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::ComponentArea::getAreaPropertySource </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the name of the property that will be used to determine the pixel area for this <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a>. </p>
<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 holding the name of a Propery. </dd></dl>
</div>
</div>
<a class="anchor" id="abde46aada1bc73c574fdbaea5a76c515"></a><!-- doxytag: member="CEGUI::ComponentArea::getPixelRect" ref="abde46aada1bc73c574fdbaea5a76c515" args="(const Window &wnd) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Rect.html">Rect</a> CEGUI::ComponentArea::getPixelRect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Window.html">Window</a> & </td>
<td class="paramname"><em>wnd</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> describing the absolute pixel area represented by this <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">wnd</td><td><a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> object to be used when calculating final pixel area.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing the pixels area represented by this <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a> when using <em>wnd</em> as a reference for calculating the final pixel dimensions. </dd></dl>
</div>
</div>
<a class="anchor" id="a737a4de9f7228058197acb9294ff25e4"></a><!-- doxytag: member="CEGUI::ComponentArea::getPixelRect" ref="a737a4de9f7228058197acb9294ff25e4" args="(const Window &wnd, const Rect &container) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Rect.html">Rect</a> CEGUI::ComponentArea::getPixelRect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Window.html">Window</a> & </td>
<td class="paramname"><em>wnd</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>container</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> describing the absolute pixel area represented by this <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">wnd</td><td><a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> object to be used when calculating final pixel area.</td></tr>
<tr><td class="paramname">container</td><td><a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object to be used as a base or container when converting relative dimensions.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing the pixels area represented by this <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a> when using <em>wnd</em> and <em>container</em> as a reference for calculating the final pixel dimensions. </dd></dl>
</div>
</div>
<a class="anchor" id="a2b5ebbc49b04a12efb998e4bb8f97b8c"></a><!-- doxytag: member="CEGUI::ComponentArea::isAreaFetchedFromProperty" ref="a2b5ebbc49b04a12efb998e4bb8f97b8c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::ComponentArea::isAreaFetchedFromProperty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether this <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a> fetches it's area via a property on the target window. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the area comes via a Propery.</li>
<li>false if the area is defined explicitly via the <a class="el" href="classCEGUI_1_1Dimension.html" title="Class representing some kind of dimension.">Dimension</a> fields. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="aa064db887a78e4d73e44abd94028c9c8"></a><!-- doxytag: member="CEGUI::ComponentArea::setAreaPropertySource" ref="aa064db887a78e4d73e44abd94028c9c8" args="(const String &property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ComponentArea::setAreaPropertySource </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>property</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the name of the property that will be used to determine the pixel area for this <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">property</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of a Propery. The property should access a <a class="el" href="classCEGUI_1_1URect.html" title="Area rectangle class built using unified dimensions (UDims).">URect</a> type property.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a58472fbfa1deb5c0b4ab68cfcf9435ae"></a><!-- doxytag: member="CEGUI::ComponentArea::writeXMLToStream" ref="a58472fbfa1deb5c0b4ab68cfcf9435ae" args="(XMLSerializer &xml_stream) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::ComponentArea::writeXMLToStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> & </td>
<td class="paramname"><em>xml_stream</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes an xml representation of this <a class="el" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a> to <em>out_stream</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">xml_stream</td><td>Stream where xml data should be output.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 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>
|
