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
|
<!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: CEGUIFalComponentBase.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">CEGUIFalComponentBase.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: CEGUIFalComponentBase.h</span>
<a name="l00003"></a>00003 <span class="comment"> created: Mon Jul 18 2005</span>
<a name="l00004"></a>00004 <span class="comment"> author: Paul D Turner <paul@cegui.org.uk></span>
<a name="l00005"></a>00005 <span class="comment">*************************************************************************/</span>
<a name="l00006"></a>00006 <span class="comment">/***************************************************************************</span>
<a name="l00007"></a>00007 <span class="comment"> * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining</span>
<a name="l00010"></a>00010 <span class="comment"> * a copy of this software and associated documentation files (the</span>
<a name="l00011"></a>00011 <span class="comment"> * "Software"), to deal in the Software without restriction, including</span>
<a name="l00012"></a>00012 <span class="comment"> * without limitation the rights to use, copy, modify, merge, publish,</span>
<a name="l00013"></a>00013 <span class="comment"> * distribute, sublicense, and/or sell copies of the Software, and to</span>
<a name="l00014"></a>00014 <span class="comment"> * permit persons to whom the Software is furnished to do so, subject to</span>
<a name="l00015"></a>00015 <span class="comment"> * the following conditions:</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * The above copyright notice and this permission notice shall be</span>
<a name="l00018"></a>00018 <span class="comment"> * included in all copies or substantial portions of the Software.</span>
<a name="l00019"></a>00019 <span class="comment"> *</span>
<a name="l00020"></a>00020 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
<a name="l00021"></a>00021 <span class="comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<a name="l00022"></a>00022 <span class="comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span>
<a name="l00023"></a>00023 <span class="comment"> * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR</span>
<a name="l00024"></a>00024 <span class="comment"> * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,</span>
<a name="l00025"></a>00025 <span class="comment"> * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR</span>
<a name="l00026"></a>00026 <span class="comment"> * OTHER DEALINGS IN THE SOFTWARE.</span>
<a name="l00027"></a>00027 <span class="comment"> ***************************************************************************/</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef _CEGUIFalComponentBase_h_</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define _CEGUIFalComponentBase_h_</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "CEGUIFalDimensions.h"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "../CEGUIWindow.h"</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "../CEGUIColourRect.h"</span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="comment">// Start of CEGUI namespace section</span>
<a name="l00036"></a>00036 <span class="keyword">namespace </span>CEGUI
<a name="l00037"></a>00037 {
<a name="l00042"></a><a class="code" href="classCEGUI_1_1FalagardComponentBase.html">00042</a> <span class="keyword">class </span>CEGUIEXPORT <a class="code" href="classCEGUI_1_1FalagardComponentBase.html" title="Common base class used for renderable components within an ImagerySection.">FalagardComponentBase</a>
<a name="l00043"></a>00043 {
<a name="l00044"></a>00044 <span class="keyword">public</span>:
<a name="l00049"></a>00049 <a class="code" href="classCEGUI_1_1FalagardComponentBase.html" title="Common base class used for renderable components within an ImagerySection.">FalagardComponentBase</a>();
<a name="l00050"></a>00050
<a name="l00055"></a>00055 <span class="keyword">virtual</span> ~<a class="code" href="classCEGUI_1_1FalagardComponentBase.html" title="Common base class used for renderable components within an ImagerySection.">FalagardComponentBase</a>();
<a name="l00056"></a>00056
<a name="l00071"></a>00071 <span class="keywordtype">void</span> render(<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>& srcWindow, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">CEGUI::ColourRect</a>* modColours = 0, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a>* clipper = 0, <span class="keywordtype">bool</span> clipToDisplay = <span class="keyword">false</span>) <span class="keyword">const</span>;
<a name="l00072"></a>00072
<a name="l00090"></a>00090 <span class="keywordtype">void</span> render(<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>& srcWindow, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a>& baseRect, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">CEGUI::ColourRect</a>* modColours = 0, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a>* clipper = 0, <span class="keywordtype">bool</span> clipToDisplay = <span class="keyword">false</span>) <span class="keyword">const</span>;
<a name="l00091"></a>00091
<a name="l00099"></a>00099 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a>& getComponentArea() <span class="keyword">const</span>;
<a name="l00100"></a>00100
<a name="l00111"></a>00111 <span class="keywordtype">void</span> setComponentArea(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a>& area);
<a name="l00112"></a>00112
<a name="l00120"></a>00120 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a>& getColours() <span class="keyword">const</span>;
<a name="l00121"></a>00121
<a name="l00129"></a>00129 <span class="keywordtype">void</span> setColours(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a>& cols);
<a name="l00130"></a>00130
<a name="l00141"></a>00141 <span class="keywordtype">void</span> setColoursPropertySource(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& property);
<a name="l00142"></a>00142
<a name="l00154"></a>00154 <span class="keywordtype">void</span> setColoursPropertyIsColourRect(<span class="keywordtype">bool</span> setting = <span class="keyword">true</span>);
<a name="l00155"></a>00155
<a name="l00166"></a>00166 <span class="keywordtype">void</span> setVertFormattingPropertySource(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& property);
<a name="l00167"></a>00167
<a name="l00178"></a>00178 <span class="keywordtype">void</span> setHorzFormattingPropertySource(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& property);
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="keyword">protected</span>:
<a name="l00190"></a>00190 <span class="keywordtype">void</span> initColoursRect(<span class="keyword">const</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>& wnd, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a>* modCols, <a class="code" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a>& cr) <span class="keyword">const</span>;
<a name="l00191"></a>00191
<a name="l00196"></a>00196 <span class="keyword">virtual</span> <span class="keywordtype">void</span> render_impl(<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>& srcWindow, <a class="code" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a>& destRect, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">CEGUI::ColourRect</a>* modColours, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a>* clipper, <span class="keywordtype">bool</span> clipToDisplay) <span class="keyword">const</span> = 0;
<a name="l00197"></a>00197
<a name="l00210"></a>00210 <span class="keywordtype">bool</span> writeColoursXML(<a class="code" href="classCEGUI_1_1XMLSerializer.html" title="Class used to create XML Document.">XMLSerializer</a>& xml_stream) <span class="keyword">const</span>;
<a name="l00211"></a>00211
<a name="l00224"></a>00224 <span class="keywordtype">bool</span> writeVertFormatXML(<a class="code" href="classCEGUI_1_1XMLSerializer.html" title="Class used to create XML Document.">XMLSerializer</a>& xml_stream) <span class="keyword">const</span>;
<a name="l00225"></a>00225
<a name="l00238"></a>00238 <span class="keywordtype">bool</span> writeHorzFormatXML(<a class="code" href="classCEGUI_1_1XMLSerializer.html" title="Class used to create XML Document.">XMLSerializer</a>& xml_stream) <span class="keyword">const</span>;
<a name="l00239"></a>00239
<a name="l00240"></a>00240
<a name="l00241"></a>00241 <span class="comment">// data fields</span>
<a name="l00242"></a><a class="code" href="classCEGUI_1_1FalagardComponentBase.html#a7964b60a4f43af69e02785f526b7abff">00242</a> <a class="code" href="classCEGUI_1_1ComponentArea.html" title="Class that represents a target area for a widget or imagery component.">ComponentArea</a> <a class="code" href="classCEGUI_1_1FalagardComponentBase.html#a7964b60a4f43af69e02785f526b7abff" title="Destination area for this component.">d_area</a>;
<a name="l00243"></a><a class="code" href="classCEGUI_1_1FalagardComponentBase.html#acf436333e7719daa3996e9e6ad67252e">00243</a> <a class="code" href="classCEGUI_1_1ColourRect.html" title="Class that holds details of colours for the four corners of a rectangle.">ColourRect</a> <a class="code" href="classCEGUI_1_1FalagardComponentBase.html#acf436333e7719daa3996e9e6ad67252e" title="base colours to be applied when rendering the image component.">d_colours</a>;
<a name="l00244"></a><a class="code" href="classCEGUI_1_1FalagardComponentBase.html#afaba6493408b17d9d4a1fe8e45314057">00244</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_1FalagardComponentBase.html#afaba6493408b17d9d4a1fe8e45314057" title="name of property to fetch colours from.">d_colourPropertyName</a>;
<a name="l00245"></a><a class="code" href="classCEGUI_1_1FalagardComponentBase.html#a68923623c1a2c848ee7a7f8ccd644130">00245</a> <span class="keywordtype">bool</span> <a class="code" href="classCEGUI_1_1FalagardComponentBase.html#a68923623c1a2c848ee7a7f8ccd644130" title="true if the colour property will fetch a full ColourRect.">d_colourProperyIsRect</a>;
<a name="l00246"></a><a class="code" href="classCEGUI_1_1FalagardComponentBase.html#a254fd89bd094309001237f7b54329f70">00246</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_1FalagardComponentBase.html#a254fd89bd094309001237f7b54329f70" title="name of property to fetch vertical formatting setting from.">d_vertFormatPropertyName</a>;
<a name="l00247"></a><a class="code" href="classCEGUI_1_1FalagardComponentBase.html#ab6f5503ee1a3ebe9e0edfd6dd1309d67">00247</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_1FalagardComponentBase.html#ab6f5503ee1a3ebe9e0edfd6dd1309d67" title="name of property to fetch horizontal formatting setting from.">d_horzFormatPropertyName</a>;
<a name="l00248"></a>00248 };
<a name="l00249"></a>00249 } <span class="comment">// End of CEGUI namespace section</span>
<a name="l00250"></a>00250
<a name="l00251"></a>00251
<a name="l00252"></a>00252 <span class="preprocessor">#endif // end of guard _CEGUIFalComponentBase_h_</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:39 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>
|
