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
|
<!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::DefaultLogger 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_1DefaultLogger.html">DefaultLogger</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::DefaultLogger Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::DefaultLogger" --><!-- doxytag: inherits="CEGUI::Logger" -->
<p>Default implementation for the <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> class. If you want to redirect <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> logs to some place other than a text file, implement your own <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> implementation and create a object of the <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> type before creating 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_1DefaultLogger.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::DefaultLogger:</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_1DefaultLogger__inherit__graph.gif" border="0" usemap="#CEGUI_1_1DefaultLogger_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1DefaultLogger_inherit__map" id="CEGUI_1_1DefaultLogger_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Logger.html" title="Abstract class that defines the interface of a logger object for the GUI system. The default implemen..." alt="" coords="44,83,156,112"/><area shape="rect" id="node4" 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::DefaultLogger:</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_1DefaultLogger__coll__graph.gif" border="0" usemap="#CEGUI_1_1DefaultLogger_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1DefaultLogger_coll__map" id="CEGUI_1_1DefaultLogger_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Logger.html" title="Abstract class that defines the interface of a logger object for the GUI system. The default implemen..." alt="" coords="123,5,235,35"/><area shape="rect" id="node4" href="classCEGUI_1_1Singleton.html" title="CEGUI::Singleton\< Logger \>" alt="" coords="184,101,373,131"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1DefaultLogger-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="a1e17bc03469879f17db977e9fd930f9d"></a><!-- doxytag: member="CEGUI::DefaultLogger::DefaultLogger" ref="a1e17bc03469879f17db977e9fd930f9d" args="(void)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1DefaultLogger.html#a1e17bc03469879f17db977e9fd930f9d">DefaultLogger</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for <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> object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a888ef67e03bce2f0be08e50531ac334b"></a><!-- doxytag: member="CEGUI::DefaultLogger::~DefaultLogger" ref="a888ef67e03bce2f0be08e50531ac334b" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1DefaultLogger.html#a888ef67e03bce2f0be08e50531ac334b">~DefaultLogger</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <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> object. <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_1DefaultLogger.html#a26e839dd678f2393948c9f7dc53109cd">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)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an event to the log. <a href="#a26e839dd678f2393948c9f7dc53109cd"></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_1DefaultLogger.html#a1614c39f224f9096367666d48c01f7ea">setLogFilename</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &filename, bool append=false)</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. <a href="#a1614c39f224f9096367666d48c01f7ea"></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="a0112dad8eaf1fca4d247b5714f7bc588"></a><!-- doxytag: member="CEGUI::DefaultLogger::d_ostream" ref="a0112dad8eaf1fca4d247b5714f7bc588" args="" -->
std::ofstream </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1DefaultLogger.html#a0112dad8eaf1fca4d247b5714f7bc588">d_ostream</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stream used to implement the logger. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab43ab4c45e33dd4aa5fe655ae38f95f6"></a><!-- doxytag: member="CEGUI::DefaultLogger::d_cache" ref="ab43ab4c45e33dd4aa5fe655ae38f95f6" args="" -->
std::vector< std::pair< <a class="el" href="classCEGUI_1_1String.html">String</a>, <br class="typebreak"/>
<a class="el" href="namespaceCEGUI.html#a9e0443bad079b8ad1a6dd35f85595add">LoggingLevel</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1DefaultLogger.html#ab43ab4c45e33dd4aa5fe655ae38f95f6">d_cache</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to cache log entries before log file is created. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94a98293fafe1dbeb92896dff0c79dd1"></a><!-- doxytag: member="CEGUI::DefaultLogger::d_workstream" ref="a94a98293fafe1dbeb92896dff0c79dd1" args="" -->
std::ostringstream </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1DefaultLogger.html#a94a98293fafe1dbeb92896dff0c79dd1">d_workstream</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to build log entry strings. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35eabb1810abb40a7b8a84cd17dd0440"></a><!-- doxytag: member="CEGUI::DefaultLogger::d_caching" ref="a35eabb1810abb40a7b8a84cd17dd0440" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1DefaultLogger.html#a35eabb1810abb40a7b8a84cd17dd0440">d_caching</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">true while log entries are beign cached (prior to logfile creation) <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Default implementation for the <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> class. If you want to redirect <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> logs to some place other than a text file, implement your own <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> implementation and create a object of the <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> type before creating 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="a26e839dd678f2393948c9f7dc53109cd"></a><!-- doxytag: member="CEGUI::DefaultLogger::logEvent" ref="a26e839dd678f2393948c9f7dc53109cd" args="(const String &message, LoggingLevel level=Standard)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::DefaultLogger::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> [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>Implements <a class="el" href="classCEGUI_1_1Logger.html#ab276945c19fc14ba8e2498e74eb23e63">CEGUI::Logger</a>.</p>
</div>
</div>
<a class="anchor" id="a1614c39f224f9096367666d48c01f7ea"></a><!-- doxytag: member="CEGUI::DefaultLogger::setLogFilename" ref="a1614c39f224f9096367666d48c01f7ea" args="(const String &filename, bool append=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::DefaultLogger::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> [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. </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>Implements <a class="el" href="classCEGUI_1_1Logger.html#ae4c43f9f8358672af7614a0665d23a0d">CEGUI::Logger</a>.</p>
</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>
|
