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
|
<!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::WidgetComponent 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_1WidgetComponent.html">WidgetComponent</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::WidgetComponent Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::WidgetComponent" -->
<p>Class that encapsulates information regarding a sub-widget required for a widget.
<a href="classCEGUI_1_1WidgetComponent.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::WidgetComponent:</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_1WidgetComponent__coll__graph.gif" border="0" usemap="#CEGUI_1_1WidgetComponent_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1WidgetComponent_coll__map" id="CEGUI_1_1WidgetComponent_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="11,5,117,35"/><area shape="rect" id="node4" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component." alt="" coords="155,172,320,201"/><area shape="rect" id="node6" href="classCEGUI_1_1Dimension.html" title="Class representing some kind of dimension." alt="" coords="171,5,304,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1WidgetComponent-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="a0537636a80361030060133d268b7b38e"></a><!-- doxytag: member="CEGUI::WidgetComponent::WidgetComponent" ref="a0537636a80361030060133d268b7b38e" args="(const String &type, const String &look, const String &suffix, const String &renderer)" -->
 </td><td class="memItemRight" valign="bottom"><b>WidgetComponent</b> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &type, const <a class="el" href="classCEGUI_1_1String.html">String</a> &look, const <a class="el" href="classCEGUI_1_1String.html">String</a> &suffix, const <a class="el" href="classCEGUI_1_1String.html">String</a> &renderer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a243912918193c96b42b7292b94e8c5b7"></a><!-- doxytag: member="CEGUI::WidgetComponent::create" ref="a243912918193c96b42b7292b94e8c5b7" args="(Window &parent) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1WidgetComponent.html#a243912918193c96b42b7292b94e8c5b7">create</a> (<a class="el" href="classCEGUI_1_1Window.html">Window</a> &parent) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of this widget component adding it as a child to the given <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>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91724823f129223951026563e589868f"></a><!-- doxytag: member="CEGUI::WidgetComponent::getComponentArea" ref="a91724823f129223951026563e589868f" args="() const " -->
const <a class="el" href="classCEGUI_1_1ComponentArea.html">ComponentArea</a> & </td><td class="memItemRight" valign="bottom"><b>getComponentArea</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a1c69eb6e039c5e72c3e923b8746c7b"></a><!-- doxytag: member="CEGUI::WidgetComponent::setComponentArea" ref="a3a1c69eb6e039c5e72c3e923b8746c7b" args="(const ComponentArea &area)" -->
void </td><td class="memItemRight" valign="bottom"><b>setComponentArea</b> (const <a class="el" href="classCEGUI_1_1ComponentArea.html">ComponentArea</a> &area)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab12acf329e148b2ff3c3e374098aee60"></a><!-- doxytag: member="CEGUI::WidgetComponent::getBaseWidgetType" ref="ab12acf329e148b2ff3c3e374098aee60" args="() const " -->
const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><b>getBaseWidgetType</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6d8f52aa05ac89b9f5fe0897eb82458e"></a><!-- doxytag: member="CEGUI::WidgetComponent::setBaseWidgetType" ref="a6d8f52aa05ac89b9f5fe0897eb82458e" args="(const String &type)" -->
void </td><td class="memItemRight" valign="bottom"><b>setBaseWidgetType</b> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a622f44a09a868936f48a51428d3fff08"></a><!-- doxytag: member="CEGUI::WidgetComponent::getWidgetLookName" ref="a622f44a09a868936f48a51428d3fff08" args="() const " -->
const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><b>getWidgetLookName</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad53955f889b0a6176f6298be28b4b1d7"></a><!-- doxytag: member="CEGUI::WidgetComponent::setWidgetLookName" ref="ad53955f889b0a6176f6298be28b4b1d7" args="(const String &look)" -->
void </td><td class="memItemRight" valign="bottom"><b>setWidgetLookName</b> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &look)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade7f7a0808cef2e5da4bf025a27ec4cc"></a><!-- doxytag: member="CEGUI::WidgetComponent::getWidgetNameSuffix" ref="ade7f7a0808cef2e5da4bf025a27ec4cc" args="() const " -->
const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><b>getWidgetNameSuffix</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e655eb0370522651d2f3acdb8017105"></a><!-- doxytag: member="CEGUI::WidgetComponent::setWidgetNameSuffix" ref="a7e655eb0370522651d2f3acdb8017105" args="(const String &suffix)" -->
void </td><td class="memItemRight" valign="bottom"><b>setWidgetNameSuffix</b> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &suffix)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00a48a77ccea1e989824d4e3372d0f81"></a><!-- doxytag: member="CEGUI::WidgetComponent::getWindowRendererType" ref="a00a48a77ccea1e989824d4e3372d0f81" args="() const " -->
const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><b>getWindowRendererType</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a451ed3fdf8fbcb220da90fbff74a2dd9"></a><!-- doxytag: member="CEGUI::WidgetComponent::setWindowRendererType" ref="a451ed3fdf8fbcb220da90fbff74a2dd9" args="(const String &type)" -->
void </td><td class="memItemRight" valign="bottom"><b>setWindowRendererType</b> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23466285a5ad198f709c93250b41bac8"></a><!-- doxytag: member="CEGUI::WidgetComponent::getVerticalWidgetAlignment" ref="a23466285a5ad198f709c93250b41bac8" args="() const " -->
<a class="el" href="namespaceCEGUI.html#a6660132f5465c325fd55754ecba4832a">VerticalAlignment</a> </td><td class="memItemRight" valign="bottom"><b>getVerticalWidgetAlignment</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1afa7aeffea08d71760dfe9272eaba40"></a><!-- doxytag: member="CEGUI::WidgetComponent::setVerticalWidgetAlignment" ref="a1afa7aeffea08d71760dfe9272eaba40" args="(VerticalAlignment alignment)" -->
void </td><td class="memItemRight" valign="bottom"><b>setVerticalWidgetAlignment</b> (<a class="el" href="namespaceCEGUI.html#a6660132f5465c325fd55754ecba4832a">VerticalAlignment</a> alignment)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39f6e0312bcfd39082f924ed7a3ae1da"></a><!-- doxytag: member="CEGUI::WidgetComponent::getHorizontalWidgetAlignment" ref="a39f6e0312bcfd39082f924ed7a3ae1da" args="() const " -->
<a class="el" href="namespaceCEGUI.html#a15bee6ef970b3aab6e7355b278901195">HorizontalAlignment</a> </td><td class="memItemRight" valign="bottom"><b>getHorizontalWidgetAlignment</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa000833180722a1dd016b02ffb2f48d7"></a><!-- doxytag: member="CEGUI::WidgetComponent::setHorizontalWidgetAlignment" ref="aa000833180722a1dd016b02ffb2f48d7" args="(HorizontalAlignment alignment)" -->
void </td><td class="memItemRight" valign="bottom"><b>setHorizontalWidgetAlignment</b> (<a class="el" href="namespaceCEGUI.html#a15bee6ef970b3aab6e7355b278901195">HorizontalAlignment</a> alignment)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5b83b26b7a77029d3e179a4eae128a8"></a><!-- doxytag: member="CEGUI::WidgetComponent::addPropertyInitialiser" ref="ab5b83b26b7a77029d3e179a4eae128a8" args="(const PropertyInitialiser &initialiser)" -->
void </td><td class="memItemRight" valign="bottom"><b>addPropertyInitialiser</b> (const <a class="el" href="classCEGUI_1_1PropertyInitialiser.html">PropertyInitialiser</a> &initialiser)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82c87323852960b7b542b855f5da4a32"></a><!-- doxytag: member="CEGUI::WidgetComponent::clearPropertyInitialisers" ref="a82c87323852960b7b542b855f5da4a32" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>clearPropertyInitialisers</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a613c7dbaee2b79be2cfa88fff16ab4d1"></a><!-- doxytag: member="CEGUI::WidgetComponent::layout" ref="a613c7dbaee2b79be2cfa88fff16ab4d1" args="(const Window &owner) const " -->
void </td><td class="memItemRight" valign="bottom"><b>layout</b> (const <a class="el" href="classCEGUI_1_1Window.html">Window</a> &owner) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1WidgetComponent.html#a4195d9bc74264cc5b9595148969e59fb">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_1WidgetComponent.html" title="Class that encapsulates information regarding a sub-widget required for a widget.">WidgetComponent</a> to <em>out_stream</em>. <a href="#a4195d9bc74264cc5b9595148969e59fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1PropertyInitialiser.html">PropertyInitialiser</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1WidgetComponent.html#ab6d8c5f5324ca1aff3eb8aaccb83e41c">findPropertyInitialiser</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &propertyName) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Takes the name of a property and returns a pointer to the last <a class="el" href="classCEGUI_1_1PropertyInitialiser.html" title="Class that holds information about a property and it's required initial value.">PropertyInitialiser</a> for this property or 0 if the is no <a class="el" href="classCEGUI_1_1PropertyInitialiser.html" title="Class that holds information about a property and it's required initial value.">PropertyInitialiser</a> for this property in the <a class="el" href="classCEGUI_1_1WidgetLookFeel.html" title="Class that encapsulates look & feel information for a particular widget type.">WidgetLookFeel</a>. <a href="#ab6d8c5f5324ca1aff3eb8aaccb83e41c"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class that encapsulates information regarding a sub-widget required for a widget. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000004">Todo:</a></b></dt><dd>This is not finished in the slightest! There will be many changes here... </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab6d8c5f5324ca1aff3eb8aaccb83e41c"></a><!-- doxytag: member="CEGUI::WidgetComponent::findPropertyInitialiser" ref="ab6d8c5f5324ca1aff3eb8aaccb83e41c" args="(const String &propertyName) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1PropertyInitialiser.html">PropertyInitialiser</a>* CEGUI::WidgetComponent::findPropertyInitialiser </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>propertyName</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Takes the name of a property and returns a pointer to the last <a class="el" href="classCEGUI_1_1PropertyInitialiser.html" title="Class that holds information about a property and it's required initial value.">PropertyInitialiser</a> for this property or 0 if the is no <a class="el" href="classCEGUI_1_1PropertyInitialiser.html" title="Class that holds information about a property and it's required initial value.">PropertyInitialiser</a> for this property in the <a class="el" href="classCEGUI_1_1WidgetLookFeel.html" title="Class that encapsulates look & feel information for a particular widget type.">WidgetLookFeel</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">propertyName</td><td>The name of the property to look for. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4195d9bc74264cc5b9595148969e59fb"></a><!-- doxytag: member="CEGUI::WidgetComponent::writeXMLToStream" ref="a4195d9bc74264cc5b9595148969e59fb" args="(XMLSerializer &xml_stream) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::WidgetComponent::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_1WidgetComponent.html" title="Class that encapsulates information regarding a sub-widget required for a widget.">WidgetComponent</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>
|
