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
|
<!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::Logger 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_1Logger.html">Logger</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::Logger Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::Logger" --><!-- doxytag: inherits="Singleton< Logger >" -->
<p>Abstract class that defines the interface of a logger object for the GUI system. The default implementation of this interface is the <a class="el" href="classCEGUI_1_1DefaultLogger.html" title="Default implementation for the Logger class. If you want to redirect CEGUI logs to some place other t...">DefaultLogger</a> class; if you want to perform special logging, derive your own class from <a class="el" href="classCEGUI_1_1Logger.html" title="Abstract class that defines the interface of a logger object for the GUI system. The default implemen...">Logger</a> and initialize a object of that type before you create the <a class="el" href="classCEGUI_1_1System.html" title="The System class is the CEGUI class that provides access to all other elements in this system...">CEGUI::System</a> singleton.
<a href="classCEGUI_1_1Logger.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"/> Inheritance diagram for CEGUI::Logger:</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_1Logger__inherit__graph.gif" border="0" usemap="#CEGUI_1_1Logger_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1Logger_inherit__map" id="CEGUI_1_1Logger_inherit__map">
<area shape="rect" id="node5" href="classCEGUI_1_1DefaultLogger.html" title="Default implementation for the Logger class. If you want to redirect CEGUI logs to some place other t..." alt="" coords="23,160,177,189"/><area shape="rect" id="node2" href="classCEGUI_1_1Singleton.html" title="CEGUI::Singleton\< Logger \>" alt="" coords="5,5,195,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::Logger:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1Logger__coll__graph.gif" border="0" usemap="#CEGUI_1_1Logger_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1Logger_coll__map" id="CEGUI_1_1Logger_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Singleton.html" title="CEGUI::Singleton\< Logger \>" alt="" coords="5,101,195,131"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1Logger-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="a90c67322f8deca350d99a46c16a5d1ce"></a><!-- doxytag: member="CEGUI::Logger::Logger" ref="a90c67322f8deca350d99a46c16a5d1ce" args="(void)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Logger.html#a90c67322f8deca350d99a46c16a5d1ce">Logger</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for <a class="el" href="classCEGUI_1_1Logger.html" title="Abstract class that defines the interface of a logger object for the GUI system. The default implemen...">Logger</a> object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6d50f244e86ee0568dc3c6fdd0f0faae"></a><!-- doxytag: member="CEGUI::Logger::~Logger" ref="a6d50f244e86ee0568dc3c6fdd0f0faae" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Logger.html#a6d50f244e86ee0568dc3c6fdd0f0faae">~Logger</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1Logger.html" title="Abstract class that defines the interface of a logger object for the GUI system. The default implemen...">Logger</a> object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Logger.html#a344d26a56b472555fd067bb41c516560">setLoggingLevel</a> (<a class="el" href="namespaceCEGUI.html#a9e0443bad079b8ad1a6dd35f85595add">LoggingLevel</a> level)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the level of logging information that will get out to the log file. <a href="#a344d26a56b472555fd067bb41c516560"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCEGUI.html#a9e0443bad079b8ad1a6dd35f85595add">LoggingLevel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Logger.html#a23c7f782218abe541c0416f00a643ef4">getLoggingLevel</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the current logging level setting <a href="#a23c7f782218abe541c0416f00a643ef4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Logger.html#ab276945c19fc14ba8e2498e74eb23e63">logEvent</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &message, <a class="el" href="namespaceCEGUI.html#a9e0443bad079b8ad1a6dd35f85595add">LoggingLevel</a> level=Standard)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an event to the log. <a href="#ab276945c19fc14ba8e2498e74eb23e63"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Logger.html#ae4c43f9f8358672af7614a0665d23a0d">setLogFilename</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &filename, bool append=false)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the log file where all subsequent log entries should be written. The interpretation of file name may differ depending on the concrete logger implementation. <a href="#ae4c43f9f8358672af7614a0665d23a0d"></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="a12efcb2eb288384cf02b671bda1d6a61"></a><!-- doxytag: member="CEGUI::Logger::d_level" ref="a12efcb2eb288384cf02b671bda1d6a61" args="" -->
<a class="el" href="namespaceCEGUI.html#a9e0443bad079b8ad1a6dd35f85595add">LoggingLevel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Logger.html#a12efcb2eb288384cf02b671bda1d6a61">d_level</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds current logging level. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract class that defines the interface of a logger object for the GUI system. The default implementation of this interface is the <a class="el" href="classCEGUI_1_1DefaultLogger.html" title="Default implementation for the Logger class. If you want to redirect CEGUI logs to some place other t...">DefaultLogger</a> class; if you want to perform special logging, derive your own class from <a class="el" href="classCEGUI_1_1Logger.html" title="Abstract class that defines the interface of a logger object for the GUI system. The default implemen...">Logger</a> and initialize a object of that type before you create the <a class="el" href="classCEGUI_1_1System.html" title="The System class is the CEGUI class that provides access to all other elements in this system...">CEGUI::System</a> singleton. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a23c7f782218abe541c0416f00a643ef4"></a><!-- doxytag: member="CEGUI::Logger::getLoggingLevel" ref="a23c7f782218abe541c0416f00a643ef4" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceCEGUI.html#a9e0443bad079b8ad1a6dd35f85595add">LoggingLevel</a> CEGUI::Logger::getLoggingLevel </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 current logging level setting </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the LoggingLevel enumerated values specifying the current level of logging </dd></dl>
</div>
</div>
<a class="anchor" id="ab276945c19fc14ba8e2498e74eb23e63"></a><!-- doxytag: member="CEGUI::Logger::logEvent" ref="ab276945c19fc14ba8e2498e74eb23e63" args="(const String &message, LoggingLevel level=Standard)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::Logger::logEvent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceCEGUI.html#a9e0443bad079b8ad1a6dd35f85595add">LoggingLevel</a> </td>
<td class="paramname"><em>level</em> = <code>Standard</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add an event to the log. </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 containing the message to be added to the event log.</td></tr>
<tr><td class="paramname">level</td><td>LoggingLevel for this message. If <em>level</em> is greater than the current set logging level, the message is not logged.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1DefaultLogger.html#a26e839dd678f2393948c9f7dc53109cd">CEGUI::DefaultLogger</a>.</p>
</div>
</div>
<a class="anchor" id="ae4c43f9f8358672af7614a0665d23a0d"></a><!-- doxytag: member="CEGUI::Logger::setLogFilename" ref="ae4c43f9f8358672af7614a0665d23a0d" args="(const String &filename, bool append=false)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::Logger::setLogFilename </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>append</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the name of the log file where all subsequent log entries should be written. The interpretation of file name may differ depending on the concrete logger implementation. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>When this is called, and the log file is created, any cached log entries are flushed to the log file.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>Name of the file to put log messages.</td></tr>
<tr><td class="paramname">append</td><td><ul>
<li>true if events should be added to the end of the current file.</li>
<li>false if the current contents of the file should be discarded. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classCEGUI_1_1DefaultLogger.html#a1614c39f224f9096367666d48c01f7ea">CEGUI::DefaultLogger</a>.</p>
</div>
</div>
<a class="anchor" id="a344d26a56b472555fd067bb41c516560"></a><!-- doxytag: member="CEGUI::Logger::setLoggingLevel" ref="a344d26a56b472555fd067bb41c516560" args="(LoggingLevel level)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Logger::setLoggingLevel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCEGUI.html#a9e0443bad079b8ad1a6dd35f85595add">LoggingLevel</a> </td>
<td class="paramname"><em>level</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the level of logging information that will get out to the log file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">level</td><td>One of the LoggingLevel enumerated values that specified the level of logging information required.</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: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>
|
