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
|
<!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: CEGUIWindowRenderer.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">CEGUIWindowRenderer.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***********************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> filename: CEGUIWindowRenderer.h</span>
<a name="l00003"></a>00003 <span class="comment"> created: Jan 11 2006</span>
<a name="l00004"></a>00004 <span class="comment"> author: Tomas Lindquist Olsen</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> purpose: Defines interface for the WindowRenderer base class</span>
<a name="l00007"></a>00007 <span class="comment">*************************************************************************/</span>
<a name="l00008"></a>00008 <span class="comment">/***************************************************************************</span>
<a name="l00009"></a>00009 <span class="comment"> * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining</span>
<a name="l00012"></a>00012 <span class="comment"> * a copy of this software and associated documentation files (the</span>
<a name="l00013"></a>00013 <span class="comment"> * "Software"), to deal in the Software without restriction, including</span>
<a name="l00014"></a>00014 <span class="comment"> * without limitation the rights to use, copy, modify, merge, publish,</span>
<a name="l00015"></a>00015 <span class="comment"> * distribute, sublicense, and/or sell copies of the Software, and to</span>
<a name="l00016"></a>00016 <span class="comment"> * permit persons to whom the Software is furnished to do so, subject to</span>
<a name="l00017"></a>00017 <span class="comment"> * the following conditions:</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> * The above copyright notice and this permission notice shall be</span>
<a name="l00020"></a>00020 <span class="comment"> * included in all copies or substantial portions of the Software.</span>
<a name="l00021"></a>00021 <span class="comment"> *</span>
<a name="l00022"></a>00022 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
<a name="l00023"></a>00023 <span class="comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<a name="l00024"></a>00024 <span class="comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span>
<a name="l00025"></a>00025 <span class="comment"> * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR</span>
<a name="l00026"></a>00026 <span class="comment"> * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,</span>
<a name="l00027"></a>00027 <span class="comment"> * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR</span>
<a name="l00028"></a>00028 <span class="comment"> * OTHER DEALINGS IN THE SOFTWARE.</span>
<a name="l00029"></a>00029 <span class="comment"> ***************************************************************************/</span>
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef _CEGUIWindowRenderer_h_</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define _CEGUIWindowRenderer_h_</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "CEGUIWindow.h"</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "CEGUIProperty.h"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include <vector></span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <utility></span>
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="preprocessor">#if defined(_MSC_VER)</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(push)</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(disable : 4251)</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span>
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="comment">// Start of CEGUI namespace section</span>
<a name="l00045"></a>00045 <span class="keyword">namespace </span>CEGUI
<a name="l00046"></a>00046 {
<a name="l00051"></a><a class="code" href="classCEGUI_1_1WindowRenderer.html">00051</a> <span class="keyword">class </span>CEGUIEXPORT <a class="code" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">WindowRenderer</a>
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053 <span class="keyword">public</span>:
<a name="l00054"></a>00054 <span class="comment">/*************************************************************************</span>
<a name="l00055"></a>00055 <span class="comment"> Constructor / Destructor</span>
<a name="l00056"></a>00056 <span class="comment"> **************************************************************************/</span>
<a name="l00068"></a>00068 <a class="code" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">WindowRenderer</a>(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& name, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& class_name=<span class="stringliteral">"Window"</span>);
<a name="l00069"></a>00069
<a name="l00074"></a>00074 <span class="keyword">virtual</span> ~<a class="code" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">WindowRenderer</a>();
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="comment">/*************************************************************************</span>
<a name="l00077"></a>00077 <span class="comment"> Public interface</span>
<a name="l00078"></a>00078 <span class="comment"> **************************************************************************/</span>
<a name="l00087"></a>00087 <span class="keyword">virtual</span> <span class="keywordtype">void</span> render() = 0;
<a name="l00088"></a>00088
<a name="l00093"></a><a class="code" href="classCEGUI_1_1WindowRenderer.html#a4013c02c5afde8bd1c5c37cf6c8ca242">00093</a> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& <a class="code" href="classCEGUI_1_1WindowRenderer.html#a4013c02c5afde8bd1c5c37cf6c8ca242" title="Returns the factory type name of this window renderer.">getName</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> d_name;}
<a name="l00094"></a>00094
<a name="l00099"></a><a class="code" href="classCEGUI_1_1WindowRenderer.html#acb1a9caf8b772a39340f3a080176d662">00099</a> <a class="code" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a>* <a class="code" href="classCEGUI_1_1WindowRenderer.html#acb1a9caf8b772a39340f3a080176d662" title="Get the window this windowrenderer is attached to.">getWindow</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> d_window;}
<a name="l00100"></a>00100
<a name="l00105"></a><a class="code" href="classCEGUI_1_1WindowRenderer.html#abcec49a33064284667f01cf1a76ca41d">00105</a> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& <a class="code" href="classCEGUI_1_1WindowRenderer.html#abcec49a33064284667f01cf1a76ca41d" title="Get the "minimum" Window class this renderer requires.">getClass</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> d_class;}
<a name="l00106"></a>00106
<a name="l00111"></a>00111 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1WidgetLookFeel.html" title="Class that encapsulates look & feel information for a particular widget type.">WidgetLookFeel</a>& getLookNFeel() <span class="keyword">const</span>;
<a name="l00112"></a>00112
<a name="l00118"></a>00118 <span class="keyword">virtual</span> <a class="code" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> getUnclippedInnerRect() <span class="keyword">const</span>;
<a name="l00119"></a>00119
<a name="l00125"></a><a class="code" href="classCEGUI_1_1WindowRenderer.html#a0fe428b6653126e710bdbbf2a1c4f612">00125</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCEGUI_1_1WindowRenderer.html#a0fe428b6653126e710bdbbf2a1c4f612" title="Method called to perform extended laying out of the window's attached child windows.">performChildWindowLayout</a>() {}
<a name="l00126"></a>00126
<a name="l00132"></a>00132 <span class="keyword">virtual</span> <span class="keywordtype">void</span> getRenderingContext(<a class="code" href="structCEGUI_1_1RenderingContext.html" title="struct that holds some context relating to a RenderingSurface object.">RenderingContext</a>& ctx) <span class="keyword">const</span>;
<a name="l00133"></a>00133
<a name="l00135"></a><a class="code" href="classCEGUI_1_1WindowRenderer.html#a41c176756a8854a23bb08c539d5f3f42">00135</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCEGUI_1_1WindowRenderer.html#a41c176756a8854a23bb08c539d5f3f42" title="perform any time based updates for this WindowRenderer.">update</a>(<span class="keywordtype">float</span> <span class="comment">/*elapsed*/</span>) {}
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keyword">protected</span>:
<a name="l00138"></a>00138 <span class="comment">/*************************************************************************</span>
<a name="l00139"></a>00139 <span class="comment"> Implementation methods</span>
<a name="l00140"></a>00140 <span class="comment"> **************************************************************************/</span>
<a name="l00155"></a>00155 <span class="keywordtype">void</span> registerProperty(<a class="code" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a>* property, <span class="keyword">const</span> <span class="keywordtype">bool</span> ban_from_xml);
<a name="l00156"></a>00156
<a name="l00166"></a>00166 <span class="keywordtype">void</span> registerProperty(<a class="code" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a>* property);
<a name="l00167"></a>00167
<a name="l00172"></a>00172 <span class="keyword">virtual</span> <span class="keywordtype">void</span> onAttach();
<a name="l00173"></a>00173
<a name="l00178"></a>00178 <span class="keyword">virtual</span> <span class="keywordtype">void</span> onDetach();
<a name="l00179"></a>00179
<a name="l00184"></a><a class="code" href="classCEGUI_1_1WindowRenderer.html#a44a10d844d15621f34b3d2eaa2952303">00184</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCEGUI_1_1WindowRenderer.html#a44a10d844d15621f34b3d2eaa2952303" title="Handler called when a Look'N'Feel is assigned to our window.">onLookNFeelAssigned</a>() {}
<a name="l00185"></a>00185
<a name="l00190"></a><a class="code" href="classCEGUI_1_1WindowRenderer.html#aa930905b4e0edb070ad4cdb79a19d30c">00190</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCEGUI_1_1WindowRenderer.html#aa930905b4e0edb070ad4cdb79a19d30c" title="Handler called when a Look'N'Feel is removed/unassigned from our window.">onLookNFeelUnassigned</a>() {}
<a name="l00191"></a>00191
<a name="l00192"></a>00192 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">WindowRenderer</a>&) {}
<a name="l00193"></a>00193
<a name="l00194"></a>00194 <span class="comment">/*************************************************************************</span>
<a name="l00195"></a>00195 <span class="comment"> Implementation data</span>
<a name="l00196"></a>00196 <span class="comment"> **************************************************************************/</span>
<a name="l00197"></a><a class="code" href="classCEGUI_1_1WindowRenderer.html#a4585e9d5cfa2a053d05737e090f26d0c">00197</a> <a class="code" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a>* <a class="code" href="classCEGUI_1_1WindowRenderer.html#a4585e9d5cfa2a053d05737e090f26d0c" title="Pointer to the window this windowrenderer is assigned to.">d_window</a>;
<a name="l00198"></a><a class="code" href="classCEGUI_1_1WindowRenderer.html#a5ff05e09bb51459562088ef4896854f8">00198</a> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> <a class="code" href="classCEGUI_1_1WindowRenderer.html#a5ff05e09bb51459562088ef4896854f8" title="Name of the factory type used to create this window renderer.">d_name</a>;
<a name="l00199"></a><a class="code" href="classCEGUI_1_1WindowRenderer.html#acaf0448a9f5d32105e60399aeb57b78e">00199</a> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> <a class="code" href="classCEGUI_1_1WindowRenderer.html#acaf0448a9f5d32105e60399aeb57b78e" title="Name of the widget class that is the "minimum" requirement.">d_class</a>;
<a name="l00200"></a>00200
<a name="l00202"></a><a class="code" href="classCEGUI_1_1WindowRenderer.html#a4d3a732ee8fa45b73cf3de80b4870c10">00202</a> <span class="keyword">typedef</span> std::pair<Property*, bool> <a class="code" href="classCEGUI_1_1WindowRenderer.html#a4d3a732ee8fa45b73cf3de80b4870c10" title="type used for entries in the PropertyList.">PropertyEntry</a>;
<a name="l00204"></a><a class="code" href="classCEGUI_1_1WindowRenderer.html#a3255020111aed753a7ddf0516a78a4f3">00204</a> <span class="keyword">typedef</span> std::vector<PropertyEntry> <a class="code" href="classCEGUI_1_1WindowRenderer.html#a3255020111aed753a7ddf0516a78a4f3" title="type to use for the property list.">PropertyList</a>;
<a name="l00205"></a><a class="code" href="classCEGUI_1_1WindowRenderer.html#a9d7e072ab65f998aaf76c735f2124018">00205</a> <a class="code" href="classCEGUI_1_1WindowRenderer.html#a3255020111aed753a7ddf0516a78a4f3" title="type to use for the property list.">PropertyList</a> <a class="code" href="classCEGUI_1_1WindowRenderer.html#a9d7e072ab65f998aaf76c735f2124018" title="The list of properties that this windowrenderer will be handling.">d_properties</a>;
<a name="l00206"></a>00206
<a name="l00207"></a>00207 <span class="comment">// Window is friend so it can manipulate our 'd_window' member directly.</span>
<a name="l00208"></a>00208 <span class="comment">// We don't want users fiddling with this so no public interface.</span>
<a name="l00209"></a>00209 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a>;
<a name="l00210"></a>00210 };
<a name="l00211"></a>00211
<a name="l00216"></a><a class="code" href="classCEGUI_1_1WindowRendererFactory.html">00216</a> <span class="keyword">class </span>CEGUIEXPORT <a class="code" href="classCEGUI_1_1WindowRendererFactory.html" title="Base-class for WindowRendererFactory.">WindowRendererFactory</a>
<a name="l00217"></a>00217 {
<a name="l00218"></a>00218 <span class="keyword">public</span>:
<a name="l00226"></a><a class="code" href="classCEGUI_1_1WindowRendererFactory.html#a42ce79c3288048808bc77de82d0f2cfe">00226</a> <a class="code" href="classCEGUI_1_1WindowRendererFactory.html#a42ce79c3288048808bc77de82d0f2cfe" title="Contructor.">WindowRendererFactory</a>(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& name) : d_factoryName(name) {}
<a name="l00227"></a>00227
<a name="l00232"></a><a class="code" href="classCEGUI_1_1WindowRendererFactory.html#aaf26de825c3d1e2bf84f1f548dc88639">00232</a> <span class="keyword">virtual</span> <a class="code" href="classCEGUI_1_1WindowRendererFactory.html#aaf26de825c3d1e2bf84f1f548dc88639" title="Destructor.">~WindowRendererFactory</a>() {}
<a name="l00233"></a>00233
<a name="l00238"></a><a class="code" href="classCEGUI_1_1WindowRendererFactory.html#ac50abf624700219c497e4dfc86ff4def">00238</a> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& <a class="code" href="classCEGUI_1_1WindowRendererFactory.html#ac50abf624700219c497e4dfc86ff4def" title="Returns the type name of this window renderer factory.">getName</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> d_factoryName;}
<a name="l00239"></a>00239
<a name="l00244"></a>00244 <span class="keyword">virtual</span> <a class="code" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">WindowRenderer</a>* create() = 0;
<a name="l00245"></a>00245
<a name="l00250"></a>00250 <span class="keyword">virtual</span> <span class="keywordtype">void</span> destroy(<a class="code" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">WindowRenderer</a>* wr) = 0;
<a name="l00251"></a>00251
<a name="l00252"></a>00252 <span class="keyword">protected</span>:
<a name="l00253"></a><a class="code" href="classCEGUI_1_1WindowRendererFactory.html#a245211e3f84e99ca722454c1f0429d88">00253</a> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> <a class="code" href="classCEGUI_1_1WindowRendererFactory.html#a245211e3f84e99ca722454c1f0429d88" title="Our factory type name.">d_factoryName</a>;
<a name="l00254"></a>00254 };
<a name="l00255"></a>00255
<a name="l00256"></a>00256 } <span class="comment">// End of CEGUI namespace</span>
<a name="l00257"></a>00257
<a name="l00258"></a>00258 <span class="preprocessor">#if defined(_MSC_VER)</span>
<a name="l00259"></a>00259 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(pop)</span>
<a name="l00260"></a>00260 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00261"></a>00261 <span class="preprocessor"></span>
<a name="l00262"></a>00262 <span class="preprocessor">#endif // _CEGUIWindowRenderer_h_</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 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>
|
