~ares-developers/ares/gd03

« back to all changes in this revision

Viewing changes to Doc/class_logging_command_class.html

  • Committer: Renegade
  • Date: 2010-05-29 08:12:17 UTC
  • Revision ID: git-v1:0a1bb6321f04d723afe64d1b843dc87b4da783ec
Creating /trunk/src.

git-svn-id: svn://svn.renegadeprojects.com/ares/trunk@622 859b54a9-7a54-0410-aeb3-f8d2f1fa40fd

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3
 
<title>Ares: LoggingCommandClass Class Reference</title>
4
 
<link href="tabs.css" rel="stylesheet" type="text/css">
5
 
<link href="doxygen.css" rel="stylesheet" type="text/css">
6
 
</head><body>
7
 
<!-- Generated by Doxygen 1.5.8 -->
8
 
<script type="text/javascript">
9
 
<!--
10
 
function changeDisplayState (e){
11
 
  var num=this.id.replace(/[^[0-9]/g,'');
12
 
  var button=this.firstChild;
13
 
  var sectionDiv=document.getElementById('dynsection'+num);
14
 
  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15
 
    sectionDiv.style.display='block';
16
 
    button.src='open.gif';
17
 
  }else{
18
 
    sectionDiv.style.display='none';
19
 
    button.src='closed.gif';
20
 
  }
21
 
}
22
 
function initDynSections(){
23
 
  var divs=document.getElementsByTagName('div');
24
 
  var sectionCounter=1;
25
 
  for(var i=0;i<divs.length-1;i++){
26
 
    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27
 
      var header=divs[i];
28
 
      var section=divs[i+1];
29
 
      var button=header.firstChild;
30
 
      if (button!='IMG'){
31
 
        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32
 
        button=document.createElement('img');
33
 
        divs[i].insertBefore(button,divs[i].firstChild);
34
 
      }
35
 
      header.style.cursor='pointer';
36
 
      header.onclick=changeDisplayState;
37
 
      header.id='dynheader'+sectionCounter;
38
 
      button.src='closed.gif';
39
 
      section.id='dynsection'+sectionCounter;
40
 
      section.style.display='none';
41
 
      section.style.marginLeft='14px';
42
 
      sectionCounter++;
43
 
    }
44
 
  }
45
 
}
46
 
window.onload = initDynSections;
47
 
-->
48
 
</script>
49
 
<div class="navigation" id="top">
50
 
  <div class="tabs">
51
 
    <ul>
52
 
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
53
 
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54
 
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
55
 
      <li><a href="files.html"><span>Files</span></a></li>
56
 
      <li><a href="dirs.html"><span>Directories</span></a></li>
57
 
    <li>
58
 
      <form action="search.php" method="get">
59
 
        <table cellspacing="0" cellpadding="0" border="0">
60
 
          <tr>
61
 
            <td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
62
 
            <td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
63
 
          </tr>
64
 
        </table>
65
 
      </form>
66
 
    </li>
67
 
    </ul>
68
 
  </div>
69
 
  <div class="tabs">
70
 
    <ul>
71
 
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
72
 
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
73
 
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
74
 
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
75
 
    </ul>
76
 
  </div>
77
 
</div>
78
 
<div class="contents">
79
 
<h1>LoggingCommandClass Class Reference</h1><!-- doxytag: class="LoggingCommandClass" --><code>#include &lt;Commands/Logging.h&gt;</code>
80
 
<p>
81
 
 
82
 
<p>
83
 
<a href="class_logging_command_class-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
84
 
<tr><td></td></tr>
85
 
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
86
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_logging_command_class.html#5ffc440cbab30f26893616f77d65c6e8">LoggingCommandClass</a> ()</td></tr>
87
 
 
88
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_logging_command_class.html#731007e693c43daf8fb49e1be5bfd665">~LoggingCommandClass</a> ()</td></tr>
89
 
 
90
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_logging_command_class.html#142495fd20b27d85fa5055793864ae83">GetName</a> ()</td></tr>
91
 
 
92
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const wchar_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_logging_command_class.html#76f29122ef20ff0303dc621b1574ea1e">GetUIName</a> ()</td></tr>
93
 
 
94
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const wchar_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_logging_command_class.html#c6151e977b3aaeb8b235841b52f1c69d">GetUICategory</a> ()</td></tr>
95
 
 
96
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const wchar_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_logging_command_class.html#8d2ffcb5b3230bbb59261f286c3c1d1a">GetUIDescription</a> ()</td></tr>
97
 
 
98
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_logging_command_class.html#dec61eba4e952a91f7e77beccde11b30">Execute</a> (DWORD dwUnk)</td></tr>
99
 
 
100
 
</table>
101
 
<hr><h2>Constructor &amp; Destructor Documentation</h2>
102
 
<a class="anchor" name="5ffc440cbab30f26893616f77d65c6e8"></a><!-- doxytag: member="LoggingCommandClass::LoggingCommandClass" ref="5ffc440cbab30f26893616f77d65c6e8" args="()" -->
103
 
<div class="memitem">
104
 
<div class="memproto">
105
 
      <table class="memname">
106
 
        <tr>
107
 
          <td class="memname">LoggingCommandClass::LoggingCommandClass           </td>
108
 
          <td>(</td>
109
 
          <td class="paramname">          </td>
110
 
          <td>&nbsp;)&nbsp;</td>
111
 
          <td><code> [inline]</code></td>
112
 
        </tr>
113
 
      </table>
114
 
</div>
115
 
<div class="memdoc">
116
 
 
117
 
<p>
118
 
<div class="fragment"><pre class="fragment"><a name="l00011"></a>00011 {}
119
 
</pre></div>
120
 
<p>
121
 
 
122
 
</div>
123
 
</div><p>
124
 
<a class="anchor" name="731007e693c43daf8fb49e1be5bfd665"></a><!-- doxytag: member="LoggingCommandClass::~LoggingCommandClass" ref="731007e693c43daf8fb49e1be5bfd665" args="()" -->
125
 
<div class="memitem">
126
 
<div class="memproto">
127
 
      <table class="memname">
128
 
        <tr>
129
 
          <td class="memname">virtual LoggingCommandClass::~LoggingCommandClass           </td>
130
 
          <td>(</td>
131
 
          <td class="paramname">          </td>
132
 
          <td>&nbsp;)&nbsp;</td>
133
 
          <td><code> [inline, virtual]</code></td>
134
 
        </tr>
135
 
      </table>
136
 
</div>
137
 
<div class="memdoc">
138
 
 
139
 
<p>
140
 
<div class="fragment"><pre class="fragment"><a name="l00014"></a>00014 {}
141
 
</pre></div>
142
 
<p>
143
 
 
144
 
</div>
145
 
</div><p>
146
 
<hr><h2>Member Function Documentation</h2>
147
 
<a class="anchor" name="dec61eba4e952a91f7e77beccde11b30"></a><!-- doxytag: member="LoggingCommandClass::Execute" ref="dec61eba4e952a91f7e77beccde11b30" args="(DWORD dwUnk)" -->
148
 
<div class="memitem">
149
 
<div class="memproto">
150
 
      <table class="memname">
151
 
        <tr>
152
 
          <td class="memname">virtual void LoggingCommandClass::Execute           </td>
153
 
          <td>(</td>
154
 
          <td class="paramtype">DWORD&nbsp;</td>
155
 
          <td class="paramname"> <em>dwUnk</em>          </td>
156
 
          <td>&nbsp;)&nbsp;</td>
157
 
          <td><code> [inline, virtual]</code></td>
158
 
        </tr>
159
 
      </table>
160
 
</div>
161
 
<div class="memdoc">
162
 
 
163
 
<p>
164
 
<div class="fragment"><pre class="fragment"><a name="l00030"></a>00030         {
165
 
<a name="l00031"></a>00031                 <span class="keywordflow">if</span>(<a class="code" href="class_debug.html#a0ec4107880adada173eb96ccd9a81e1">Debug::bLog</a>) {
166
 
<a name="l00032"></a>00032                         <a class="code" href="class_debug.html#05f6859d43f1f38f2e45b770e93443fc">Debug::LogFileClose</a>(666);
167
 
<a name="l00033"></a>00033                         <a class="code" href="class_debug.html#a0ec4107880adada173eb96ccd9a81e1">Debug::bLog</a> = <span class="keyword">false</span>;
168
 
<a name="l00034"></a>00034                         MessageListClass::PrintMessage(L<span class="stringliteral">"Debug logging OFF"</span>);
169
 
<a name="l00035"></a>00035                 } <span class="keywordflow">else</span> {
170
 
<a name="l00036"></a>00036                         <a class="code" href="class_debug.html#3bdacc0c9ae25e0546849a639aeb8780">Debug::LogFileOpen</a>();
171
 
<a name="l00037"></a>00037                         <a class="code" href="class_debug.html#a0ec4107880adada173eb96ccd9a81e1">Debug::bLog</a> = <span class="keyword">true</span>;
172
 
<a name="l00038"></a>00038                         MessageListClass::PrintMessage(L<span class="stringliteral">"Debug logging ON"</span>);
173
 
<a name="l00039"></a>00039                 }
174
 
<a name="l00040"></a>00040         }
175
 
</pre></div>
176
 
<p>
177
 
 
178
 
</div>
179
 
</div><p>
180
 
<a class="anchor" name="142495fd20b27d85fa5055793864ae83"></a><!-- doxytag: member="LoggingCommandClass::GetName" ref="142495fd20b27d85fa5055793864ae83" args="()" -->
181
 
<div class="memitem">
182
 
<div class="memproto">
183
 
      <table class="memname">
184
 
        <tr>
185
 
          <td class="memname">virtual const char* LoggingCommandClass::GetName           </td>
186
 
          <td>(</td>
187
 
          <td class="paramname">          </td>
188
 
          <td>&nbsp;)&nbsp;</td>
189
 
          <td><code> [inline, virtual]</code></td>
190
 
        </tr>
191
 
      </table>
192
 
</div>
193
 
<div class="memdoc">
194
 
 
195
 
<p>
196
 
<div class="fragment"><pre class="fragment"><a name="l00018"></a>00018         { <span class="keywordflow">return</span> <span class="stringliteral">"Toggle DEBUG.TXT logging"</span>; }
197
 
</pre></div>
198
 
<p>
199
 
 
200
 
</div>
201
 
</div><p>
202
 
<a class="anchor" name="c6151e977b3aaeb8b235841b52f1c69d"></a><!-- doxytag: member="LoggingCommandClass::GetUICategory" ref="c6151e977b3aaeb8b235841b52f1c69d" args="()" -->
203
 
<div class="memitem">
204
 
<div class="memproto">
205
 
      <table class="memname">
206
 
        <tr>
207
 
          <td class="memname">virtual const wchar_t* LoggingCommandClass::GetUICategory           </td>
208
 
          <td>(</td>
209
 
          <td class="paramname">          </td>
210
 
          <td>&nbsp;)&nbsp;</td>
211
 
          <td><code> [inline, virtual]</code></td>
212
 
        </tr>
213
 
      </table>
214
 
</div>
215
 
<div class="memdoc">
216
 
 
217
 
<p>
218
 
<div class="fragment"><pre class="fragment"><a name="l00024"></a>00024                 { <span class="keywordflow">return</span> L<span class="stringliteral">"Development"</span>; }
219
 
</pre></div>
220
 
<p>
221
 
 
222
 
</div>
223
 
</div><p>
224
 
<a class="anchor" name="8d2ffcb5b3230bbb59261f286c3c1d1a"></a><!-- doxytag: member="LoggingCommandClass::GetUIDescription" ref="8d2ffcb5b3230bbb59261f286c3c1d1a" args="()" -->
225
 
<div class="memitem">
226
 
<div class="memproto">
227
 
      <table class="memname">
228
 
        <tr>
229
 
          <td class="memname">virtual const wchar_t* LoggingCommandClass::GetUIDescription           </td>
230
 
          <td>(</td>
231
 
          <td class="paramname">          </td>
232
 
          <td>&nbsp;)&nbsp;</td>
233
 
          <td><code> [inline, virtual]</code></td>
234
 
        </tr>
235
 
      </table>
236
 
</div>
237
 
<div class="memdoc">
238
 
 
239
 
<p>
240
 
<div class="fragment"><pre class="fragment"><a name="l00027"></a>00027                 { <span class="keywordflow">return</span> L<span class="stringliteral">"Toggles the logging of extra data to the DEBUG.TXT log file"</span>; }
241
 
</pre></div>
242
 
<p>
243
 
 
244
 
</div>
245
 
</div><p>
246
 
<a class="anchor" name="76f29122ef20ff0303dc621b1574ea1e"></a><!-- doxytag: member="LoggingCommandClass::GetUIName" ref="76f29122ef20ff0303dc621b1574ea1e" args="()" -->
247
 
<div class="memitem">
248
 
<div class="memproto">
249
 
      <table class="memname">
250
 
        <tr>
251
 
          <td class="memname">virtual const wchar_t* LoggingCommandClass::GetUIName           </td>
252
 
          <td>(</td>
253
 
          <td class="paramname">          </td>
254
 
          <td>&nbsp;)&nbsp;</td>
255
 
          <td><code> [inline, virtual]</code></td>
256
 
        </tr>
257
 
      </table>
258
 
</div>
259
 
<div class="memdoc">
260
 
 
261
 
<p>
262
 
<div class="fragment"><pre class="fragment"><a name="l00021"></a>00021         { <span class="keywordflow">return</span> L<span class="stringliteral">"Toggle DEBUG.TXT logging"</span>; }
263
 
</pre></div>
264
 
<p>
265
 
 
266
 
</div>
267
 
</div><p>
268
 
<hr>The documentation for this class was generated from the following file:<ul>
269
 
<li>Commands/<a class="el" href="_logging_8h.html">Logging.h</a></ul>
270
 
</div>
271
 
<hr size="1"><address style="text-align: right;"><small>Generated on Tue May 18 03:51:10 2010 for Ares by&nbsp;
272
 
<a href="http://www.doxygen.org/index.html">
273
 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
274
 
</body>
275
 
</html>