<!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: iReporter 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>iReporter Struct Reference<br>
<small>
[<a class="el" href="group__util.html">Utilities</a>]</small>
</h1><!-- doxytag: class="iReporter" --><!-- doxytag: inherits="iBase" -->This is the interface for the error/message reporter plugin.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="reporter_8h-source.html">ivaria/reporter.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iReporter:</div>
<div class="dynsection">
<p><center><img src="structiReporter__inherit__graph.png" border="0" usemap="#iReporter__inherit__map" alt="Inheritance graph"></center>
<map name="iReporter__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="17,7,73,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiReporter-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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiReporter.html#c6f04751de87b5cd6a13529b1b80861a">AddReporterListener</a> (<a class="el" href="structiReporterListener.html">iReporterListener</a> *listener)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a listener that listens to new reports. <a href="#c6f04751de87b5cd6a13529b1b80861a"></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="structiReporter.html#59c0b3203d63d2132ad6433406853961">Clear</a> (const char *mask)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear all messages in the reporter for which the id matches with the given mask. <a href="#59c0b3203d63d2132ad6433406853961"></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="structiReporter.html#a16ce85b931efdb88ef6ba3a209d6548">Clear</a> (int severity=-1)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear all messages in the reporter. <a href="#a16ce85b931efdb88ef6ba3a209d6548"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiReporter.html#a8d18b234c6fc5b6af2e3fba348b8d34">FindReporterListener</a> (<a class="el" href="structiReporterListener.html">iReporterListener</a> *listener)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the listener is already on the list. <a href="#a8d18b234c6fc5b6af2e3fba348b8d34"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a><br>
< <a class="el" href="structiReporterIterator.html">iReporterIterator</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiReporter.html#8861dd39863a1f1d1531125198a9055d">GetMessageIterator</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an iterator to iterate over all messages. <a href="#8861dd39863a1f1d1531125198a9055d"></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="structiReporter.html#784851566d0a759bfe1e4ca88bf80e51">RemoveReporterListener</a> (<a class="el" href="structiReporterListener.html">iReporterListener</a> *listener)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a listener once. <a href="#784851566d0a759bfe1e4ca88bf80e51"></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="structiReporter.html#c69491145b9f53ade1e115c2e3de27ec">Report</a> (int severity, const char *msgId, const char *description,...)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Report something. <a href="#c69491145b9f53ade1e115c2e3de27ec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__util.html#ge885c8e8a7f209ac94e3c84182d94256">ReportBug</a> (const char *msgId, const char *description,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Report bug. <a href="group__util.html#ge885c8e8a7f209ac94e3c84182d94256"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__util.html#gcf49b887e43029be87ae19fa4636bb9e">ReportDebug</a> (const char *msgId, const char *description,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Report debug. <a href="group__util.html#gcf49b887e43029be87ae19fa4636bb9e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__util.html#g64c3e8fa49ffa59a8c718aa3ed0e41d8">ReportError</a> (const char *msgId, const char *description,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Report error. <a href="group__util.html#g64c3e8fa49ffa59a8c718aa3ed0e41d8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__util.html#ga1f4821fb3e9c01dcd8249365f95c925">ReportNotify</a> (const char *msgId, const char *description,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Report notification. <a href="group__util.html#ga1f4821fb3e9c01dcd8249365f95c925"></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="structiReporter.html#9e24f850784a35be6d05137b164b8daa">ReportV</a> (int severity, const char *msgId, const char *description, va_list)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Report something. <a href="#9e24f850784a35be6d05137b164b8daa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__util.html#g62a94a4871469e1d7074336fe0a0ba2d">ReportWarning</a> (const char *msgId, const char *description,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Report warning. <a href="group__util.html#g62a94a4871469e1d7074336fe0a0ba2d"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is the interface for the error/message reporter plugin.
<p>
Note. This plugin does not actually print out or display messages in any way. The reporter simply collects messages and sends them out to interested partners. Typically the standard reporter listener (<a class="el" href="structiStandardReporterListener.html" title="Interface to control the settings of the reporter listener plugin.">iStandardReporterListener</a>) is such a plugin. It will print out the messages that arrive on the reporter.<p>
Main creators of instances implementing this interface:<ul>
<li>Reporter plugin (crystalspace.utilities.reporter)</li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="iutil_2objreg_8h.html#2a09063f1dabdde133a6269016f6a3da">CS_QUERY_REGISTRY()</a></li></ul>
<p>
Main users of this interface:<ul>
<li>Entire <a class="el" href="namespaceCS.html" title="Main namespace for CrystalSpace.">CS</a> and application.</li><li><a class="el" href="classcsReporterHelper.html" title="Helper class for csReport().">csReporterHelper</a> </li></ul>
<p>Definition at line <a class="el" href="reporter_8h-source.html#l00152">152</a> of file <a class="el" href="reporter_8h-source.html">reporter.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c6f04751de87b5cd6a13529b1b80861a"></a><!-- doxytag: member="iReporter::AddReporterListener" ref="c6f04751de87b5cd6a13529b1b80861a" args="(iReporterListener *listener)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iReporter::AddReporterListener </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiReporterListener.html">iReporterListener</a> * </td>
<td class="paramname"> <em>listener</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a listener that listens to new reports.
<p>
Listeners can optionally remove reports too. This function does not check if the listener is already there and will add it again if so. The listener will be <a class="el" href="structiBase.html#426a2763702fbbc33a213f849042284a" title="Increment the number of references to this object.">IncRef()</a>'ed by this function.
</div>
</div><p>
<a class="anchor" name="59c0b3203d63d2132ad6433406853961"></a><!-- doxytag: member="iReporter::Clear" ref="59c0b3203d63d2132ad6433406853961" args="(const char *mask)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iReporter::Clear </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>mask</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear all messages in the reporter for which the id matches with the given mask.
<p>
The mask can contain '*' or '?' wildcards. This can be used to clear all messages from some source like: Clear("crystalspace.sprite2dloader.*")
</div>
</div><p>
<a class="anchor" name="a16ce85b931efdb88ef6ba3a209d6548"></a><!-- doxytag: member="iReporter::Clear" ref="a16ce85b931efdb88ef6ba3a209d6548" args="(int severity=-1)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iReporter::Clear </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>severity</em> = <code>-1</code> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear all messages in the reporter.
<p>
If severity is -1 then all will be deleted. Otherwise only messages of the specified severity will be deleted.
</div>
</div><p>
<a class="anchor" name="a8d18b234c6fc5b6af2e3fba348b8d34"></a><!-- doxytag: member="iReporter::FindReporterListener" ref="a8d18b234c6fc5b6af2e3fba348b8d34" args="(iReporterListener *listener)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iReporter::FindReporterListener </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiReporterListener.html">iReporterListener</a> * </td>
<td class="paramname"> <em>listener</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the listener is already on the list.
<p>
</div>
</div><p>
<a class="anchor" name="8861dd39863a1f1d1531125198a9055d"></a><!-- doxytag: member="iReporter::GetMessageIterator" ref="8861dd39863a1f1d1531125198a9055d" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiReporterIterator.html">iReporterIterator</a>> iReporter::GetMessageIterator </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 an iterator to iterate over all messages.
<p>
This will make a copy of all messages so that the reporter is not locked.
</div>
</div><p>
<a class="anchor" name="784851566d0a759bfe1e4ca88bf80e51"></a><!-- doxytag: member="iReporter::RemoveReporterListener" ref="784851566d0a759bfe1e4ca88bf80e51" args="(iReporterListener *listener)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iReporter::RemoveReporterListener </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiReporterListener.html">iReporterListener</a> * </td>
<td class="paramname"> <em>listener</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a listener once.
<p>
The listener will be <a class="el" href="structiBase.html#3a44d46ca155e6ab0c0179db01011bb0" title="Decrement the reference count.">DecRef()</a>'ed by this function. If the listener is on the list multiple times only one occurrence is removed. If the listener cannot be found on the list no <a class="el" href="structiBase.html#3a44d46ca155e6ab0c0179db01011bb0" title="Decrement the reference count.">DecRef()</a> will happen.
</div>
</div><p>
<a class="anchor" name="c69491145b9f53ade1e115c2e3de27ec"></a><!-- doxytag: member="iReporter::Report" ref="c69491145b9f53ade1e115c2e3de27ec" args="(int severity, const char *msgId, const char *description,...)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iReporter::Report </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">const char * </td>
<td class="paramname"> <em>msgId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>description</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</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>
Report something.
<p>
The given message ID should be formed like: 'crystalspace.{source}.{type}.{detail}'. Example: 'crystalspace.sprite2dloader.parse.material'. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__util.html">Notes about string formatting in Crystal Space</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="9e24f850784a35be6d05137b164b8daa"></a><!-- doxytag: member="iReporter::ReportV" ref="9e24f850784a35be6d05137b164b8daa" args="(int severity, const char *msgId, const char *description, va_list)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iReporter::ReportV </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">const char * </td>
<td class="paramname"> <em>msgId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>description</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list </td>
<td class="paramname"></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>
Report something.
<p>
va_list version. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__util.html">Notes about string formatting in Crystal Space</a> </dd></dl>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="reporter_8h-source.html">reporter.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
>
3538
