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
|
<!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::Exception 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_1Exception.html">Exception</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::Exception Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::Exception" -->
<p>Root exception class used within the GUI system.
<a href="classCEGUI_1_1Exception.html#details">More...</a></p>
<p>Inherited by <a class="el" href="classCEGUI_1_1AlreadyExistsException.html">CEGUI::AlreadyExistsException</a>, <a class="el" href="classCEGUI_1_1FileIOException.html">CEGUI::FileIOException</a>, <a class="el" href="classCEGUI_1_1GenericException.html">CEGUI::GenericException</a>, <a class="el" href="classCEGUI_1_1InvalidRequestException.html">CEGUI::InvalidRequestException</a>, <a class="el" href="classCEGUI_1_1MemoryException.html">CEGUI::MemoryException</a>, <a class="el" href="classCEGUI_1_1NullObjectException.html">CEGUI::NullObjectException</a>, <a class="el" href="classCEGUI_1_1ObjectInUseException.html">CEGUI::ObjectInUseException</a>, <a class="el" href="classCEGUI_1_1RendererException.html">CEGUI::RendererException</a>, <a class="el" href="classCEGUI_1_1ScriptException.html">CEGUI::ScriptException</a>, and <a class="el" href="classCEGUI_1_1UnknownObjectException.html">CEGUI::UnknownObjectException</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::Exception:</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_1Exception__coll__graph.gif" border="0" usemap="#CEGUI_1_1Exception_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1Exception_coll__map" id="CEGUI_1_1Exception_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="17,5,124,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1Exception-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="a399a1197b60030027f596c921c1c08fe"></a><!-- doxytag: member="CEGUI::Exception::~Exception" ref="a399a1197b60030027f596c921c1c08fe" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Exception.html#a399a1197b60030027f596c921c1c08fe">~Exception</a> (void) throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <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_1Exception.html#a5dd0b78999462f789879b02d9f886ce3">getMessage</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a reference to the <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object describing the reason for the exception being thrown. <a href="#a5dd0b78999462f789879b02d9f886ce3"></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_1Exception.html#a1bdbd17f11d24915f3b75393e4cfd47e">getName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a reference to the <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the exception name (i.e. class type). <a href="#a1bdbd17f11d24915f3b75393e4cfd47e"></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_1Exception.html#ad49898b452b2f80c8857d38551ebda06">getFileName</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a reference to the <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the file where the exception occurred. <a href="#ad49898b452b2f80c8857d38551ebda06"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Exception.html#aaab0c31da43b89a1f912dc42c24558bf">getLine</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the line number where the exception occurred. <a href="#aaab0c31da43b89a1f912dc42c24558bf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a93be9477e341d800a4c6de0c38c01de8"></a><!-- doxytag: member="CEGUI::Exception::what" ref="a93be9477e341d800a4c6de0c38c01de8" args="() const " -->
const char * </td><td class="memItemRight" valign="bottom"><b>what</b> () const throw ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Exception.html#a17a2e87b9ed10c85cc8f06f3ece1dea1">Exception</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &message="", const <a class="el" href="classCEGUI_1_1String.html">String</a> &name="CEGUI::Exception", const <a class="el" href="classCEGUI_1_1String.html">String</a> &filename="", int line=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Protected constructor that prevents instantiations (users should employ derived exception classes instead) and that is responsible for logging the exception. <a href="#a17a2e87b9ed10c85cc8f06f3ece1dea1"></a><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="a0eaa12938ed9e74f7f203f3c5f7094c3"></a><!-- doxytag: member="CEGUI::Exception::d_message" ref="a0eaa12938ed9e74f7f203f3c5f7094c3" args="" -->
<a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Exception.html#a0eaa12938ed9e74f7f203f3c5f7094c3">d_message</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds the reason for the exception being thrown. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40b13d0be30903a5907680790ee03ccc"></a><!-- doxytag: member="CEGUI::Exception::d_filename" ref="a40b13d0be30903a5907680790ee03ccc" args="" -->
<a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Exception.html#a40b13d0be30903a5907680790ee03ccc">d_filename</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds the name of the file where the exception occurred. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b1ae2bbc5b948ad0b5efa9efad3cc10"></a><!-- doxytag: member="CEGUI::Exception::d_name" ref="a4b1ae2bbc5b948ad0b5efa9efad3cc10" args="" -->
<a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Exception.html#a4b1ae2bbc5b948ad0b5efa9efad3cc10">d_name</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds the class name of the exception (e.g. <a class="el" href="classCEGUI_1_1ObjectInUseException.html" title="Exception class used when some attempt to delete, remove, or otherwise invalidate some object that is...">CEGUI::ObjectInUseException</a>) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a41b3fc2b1548f6c5a19a5854775b3d51"></a><!-- doxytag: member="CEGUI::Exception::d_line" ref="a41b3fc2b1548f6c5a19a5854775b3d51" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Exception.html#a41b3fc2b1548f6c5a19a5854775b3d51">d_line</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds the line number where the exception occurred. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7686455b4cbddbbc6dda0c271132060"></a><!-- doxytag: member="CEGUI::Exception::d_what" ref="af7686455b4cbddbbc6dda0c271132060" args="" -->
<a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Exception.html#af7686455b4cbddbbc6dda0c271132060">d_what</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds the default error message. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Root exception class used within the GUI system. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a17a2e87b9ed10c85cc8f06f3ece1dea1"></a><!-- doxytag: member="CEGUI::Exception::Exception" ref="a17a2e87b9ed10c85cc8f06f3ece1dea1" args="(const String &message="", const String &name="CEGUI::Exception", const String &filename="", int line=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::Exception::Exception </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>message</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em> = <code>"CEGUI::Exception"</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>filename</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>line</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Protected constructor that prevents instantiations (users should employ derived exception classes instead) and that is responsible for logging the exception. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object describing the reason for the exception being thrown.</td></tr>
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object describing the exception class name (e.g. <a class="el" href="classCEGUI_1_1UnknownObjectException.html" title="Exception class used when a request was made for an unknown object.">CEGUI::UnknownObjectException</a>)</td></tr>
<tr><td class="paramname">filename</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the file where the exception occurred.</td></tr>
<tr><td class="paramname">line</td><td>Integer representing the line number where the exception occurred. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad49898b452b2f80c8857d38551ebda06"></a><!-- doxytag: member="CEGUI::Exception::getFileName" ref="ad49898b452b2f80c8857d38551ebda06" args="(void) 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::Exception::getFileName </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a reference to the <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the name of the file where the exception occurred. </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 containing the name of the file where the exception occurred. </dd></dl>
</div>
</div>
<a class="anchor" id="aaab0c31da43b89a1f912dc42c24558bf"></a><!-- doxytag: member="CEGUI::Exception::getLine" ref="aaab0c31da43b89a1f912dc42c24558bf" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CEGUI::Exception::getLine </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the line number where the exception occurred. </p>
<p>Integer representing the line number where the exception occurred. </p>
</div>
</div>
<a class="anchor" id="a5dd0b78999462f789879b02d9f886ce3"></a><!-- doxytag: member="CEGUI::Exception::getMessage" ref="a5dd0b78999462f789879b02d9f886ce3" args="(void) 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::Exception::getMessage </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a reference to the <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object describing the reason for the exception being thrown. </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 containing a message describing the reason for the exception. </dd></dl>
</div>
</div>
<a class="anchor" id="a1bdbd17f11d24915f3b75393e4cfd47e"></a><!-- doxytag: member="CEGUI::Exception::getName" ref="a1bdbd17f11d24915f3b75393e4cfd47e" 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::Exception::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a reference to the <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the exception name (i.e. class type). </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 containing the exception name. </dd></dl>
</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>
|
