<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: iStandardReporterListener Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iStandardReporterListener Struct Reference</h1><!-- doxytag: class="iStandardReporterListener" --><!-- doxytag: inherits="iBase" -->Interface to control the settings of the reporter listener plugin.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="stdrep_8h-source.html">ivaria/stdrep.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iStandardReporterListener:</div>
<div class="dynsection">
<p><center><img src="structiStandardReporterListener__inherit__graph.png" border="0" usemap="#iStandardReporterListener__inherit__map" alt="Inheritance graph"></center>
<map name="iStandardReporterListener__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="73,7,129,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiStandardReporterListener-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiStandardReporterListener.html#82bdaa6db9ede4d4894f9cdae33b8c84">GetDebugFile</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the debug file name (or null if a debug file is not used). <a href="#82bdaa6db9ede4d4894f9cdae33b8c84"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiStandardReporterListener.html#24e580956ddca9f43ea28c838fd9fb1e">RemoveMessages</a> (int severity, bool remove)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Control if this reporter listener should remove messages of a certain severity. <a href="#24e580956ddca9f43ea28c838fd9fb1e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiStandardReporterListener.html#d639337d27f4ed45940b6fa3c3c085a6">SetDebugFile</a> (const char *filename, bool append=false)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the debug file to use (standard filename). <a href="#d639337d27f4ed45940b6fa3c3c085a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiStandardReporterListener.html#c1454a53534c5cee569b5179980c5dc8">SetDefaults</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set useful defaults for output console, native window manager, reporter (will use <a class="el" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a> to query for those). <a href="#c1454a53534c5cee569b5179980c5dc8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiStandardReporterListener.html#1cce7f274ddbc457314156c7948ff2cf">SetMessageDestination</a> (int severity, bool do_stdout, bool do_stderr, bool do_console, bool do_alert, bool do_debug, bool do_popup=false)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Control where some type of message (severity level from the reporter plugin: CS_REPORTER_. <a href="#1cce7f274ddbc457314156c7948ff2cf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiStandardReporterListener.html#105ea697713e2d403d1ad44d80320606">SetNativeWindowManager</a> (<a class="el" href="structiNativeWindowManager.html">iNativeWindowManager</a> *wm)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the native window manager to use. <a href="#105ea697713e2d403d1ad44d80320606"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiStandardReporterListener.html#102dc3c7deec10e4a4b74c38dac03e77">SetOutputConsole</a> (<a class="el" href="structiConsoleOutput.html">iConsoleOutput</a> *console)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the output console to use. <a href="#102dc3c7deec10e4a4b74c38dac03e77"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiStandardReporterListener.html#ec99db96c4b429d699a31b93b2c231cc">SetReporter</a> (<a class="el" href="structiReporter.html">iReporter</a> *rep)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the reporter to use. <a href="#ec99db96c4b429d699a31b93b2c231cc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiStandardReporterListener.html#4973040e680ac9e048187d3d1e8fcb34">ShowMessageID</a> (int severity, bool showid)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Control if the reporter should show message id as well. <a href="#4973040e680ac9e048187d3d1e8fcb34"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Interface to control the settings of the reporter listener plugin.
<p>
Main creators of instances implementing this interface:<ul>
<li>Standard Reporter Listener plugin (crystalspace.utilities.stdrep)</li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="iutil_2objreg_8h.html#ee5a756951eeb09857882b549a563261" title="Query an interface from the registry.">csQueryRegistry()</a> </li></ul>
<p>Definition at line <a class="el" href="stdrep_8h-source.html#l00041">41</a> of file <a class="el" href="stdrep_8h-source.html">stdrep.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="82bdaa6db9ede4d4894f9cdae33b8c84"></a><!-- doxytag: member="iStandardReporterListener::GetDebugFile" ref="82bdaa6db9ede4d4894f9cdae33b8c84" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iStandardReporterListener::GetDebugFile </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the debug file name (or null if a debug file is not used).
<p>
</div>
</div><p>
<a class="anchor" name="24e580956ddca9f43ea28c838fd9fb1e"></a><!-- doxytag: member="iStandardReporterListener::RemoveMessages" ref="24e580956ddca9f43ea28c838fd9fb1e" args="(int severity, bool remove)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iStandardReporterListener::RemoveMessages </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>severity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>remove</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Control if this reporter listener should remove messages of a certain severity.
<p>
By default all messages are removed.
</div>
</div><p>
<a class="anchor" name="d639337d27f4ed45940b6fa3c3c085a6"></a><!-- doxytag: member="iStandardReporterListener::SetDebugFile" ref="d639337d27f4ed45940b6fa3c3c085a6" args="(const char *filename, bool append=false)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iStandardReporterListener::SetDebugFile </td>
<td>(</td>
<td class="paramtype">const char * </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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the debug file to use (standard filename).
<p>
If append is true the debug file name is appended to instead of a new one created.
</div>
</div><p>
<a class="anchor" name="c1454a53534c5cee569b5179980c5dc8"></a><!-- doxytag: member="iStandardReporterListener::SetDefaults" ref="c1454a53534c5cee569b5179980c5dc8" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iStandardReporterListener::SetDefaults </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set useful defaults for output console, native window manager, reporter (will use <a class="el" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a> to query for those).
<p>
The debug file will be 'debug.txt'
</div>
</div><p>
<a class="anchor" name="1cce7f274ddbc457314156c7948ff2cf"></a><!-- doxytag: member="iStandardReporterListener::SetMessageDestination" ref="1cce7f274ddbc457314156c7948ff2cf" args="(int severity, bool do_stdout, bool do_stderr, bool do_console, bool do_alert, bool do_debug, bool do_popup=false)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iStandardReporterListener::SetMessageDestination </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>severity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>do_stdout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>do_stderr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>do_console</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>do_alert</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>do_debug</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>do_popup</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Control where some type of message (severity level from the reporter plugin: CS_REPORTER_.
<p>
..) will go to. Several of these flags can be on at the same time or none if you just want to ignore some message.
</div>
</div><p>
<a class="anchor" name="105ea697713e2d403d1ad44d80320606"></a><!-- doxytag: member="iStandardReporterListener::SetNativeWindowManager" ref="105ea697713e2d403d1ad44d80320606" args="(iNativeWindowManager *wm)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iStandardReporterListener::SetNativeWindowManager </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiNativeWindowManager.html">iNativeWindowManager</a> * </td>
<td class="paramname"> <em>wm</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the native window manager to use.
<p>
</div>
</div><p>
<a class="anchor" name="102dc3c7deec10e4a4b74c38dac03e77"></a><!-- doxytag: member="iStandardReporterListener::SetOutputConsole" ref="102dc3c7deec10e4a4b74c38dac03e77" args="(iConsoleOutput *console)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iStandardReporterListener::SetOutputConsole </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiConsoleOutput.html">iConsoleOutput</a> * </td>
<td class="paramname"> <em>console</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the output console to use.
<p>
</div>
</div><p>
<a class="anchor" name="ec99db96c4b429d699a31b93b2c231cc"></a><!-- doxytag: member="iStandardReporterListener::SetReporter" ref="ec99db96c4b429d699a31b93b2c231cc" args="(iReporter *rep)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iStandardReporterListener::SetReporter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiReporter.html">iReporter</a> * </td>
<td class="paramname"> <em>rep</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the reporter to use.
<p>
</div>
</div><p>
<a class="anchor" name="4973040e680ac9e048187d3d1e8fcb34"></a><!-- doxytag: member="iStandardReporterListener::ShowMessageID" ref="4973040e680ac9e048187d3d1e8fcb34" args="(int severity, bool showid)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iStandardReporterListener::ShowMessageID </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>severity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>showid</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Control if the reporter should show message id as well.
<p>
By default this is only done for fatal, bug, and debug severity levels.
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="stdrep_8h-source.html">stdrep.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
3804
