CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

iReporter Struct Reference

This is the interface for the error/message reporter plugin. More...

#include <reporter.h>

Inheritance diagram for iReporter:

iBase List of all members.

Public Methods

virtual void Report (int severity, const char *msgId, const char *description,...)=0
 Report something. More...

virtual void ReportV (int severity, const char *msgId, const char *description, va_list)=0
 Report something. More...

virtual void Clear (int severity=-1)=0
 Clear all messages in the reporter. More...

virtual void Clear (const char *mask)=0
 Clear all messages in the reporter for which the id matches with the given mask. More...

virtual csPtr< iReporterIteratorGetMessageIterator ()=0
 Get an iterator to iterate over all messages. More...

virtual void AddReporterListener (iReporterListener *listener)=0
 Add a listener that listens to new reports. More...

virtual void RemoveReporterListener (iReporterListener *listener)=0
 Remove a listener once. More...

virtual bool FindReporterListener (iReporterListener *listener)=0
 Check if the listener is already on the list. More...

void ReportError (const char *msgId, const char *description,...)
 Report error. More...

void ReportWarning (const char *msgId, const char *description,...)
 Report warning. More...

void ReportNotify (const char *msgId, const char *description,...)
 Report notification. More...

void ReportBug (const char *msgId, const char *description,...)
 Report bug. More...

void ReportDebug (const char *msgId, const char *description,...)
 Report debug. More...


Detailed Description

This is the interface for the error/message reporter plugin.

Definition at line 115 of file reporter.h.


Member Function Documentation

virtual void iReporter::AddReporterListener iReporterListener   listener [pure virtual]
 

Add a listener that listens to new reports.

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 IncRef()'ed by this function.

virtual void iReporter::Clear const char *    mask [pure virtual]
 

Clear all messages in the reporter for which the id matches with the given mask.

The mask can contain '*' or '?' wildcards. This can be used to clear all messages from some source like: Clear("crystalspace.sprite2dloader.*")

virtual void iReporter::Clear int    severity = -1 [pure virtual]
 

Clear all messages in the reporter.

If severity is -1 then all will be deleted. Otherwise only messages of the specified severity will be deleted.

virtual bool iReporter::FindReporterListener iReporterListener   listener [pure virtual]
 

Check if the listener is already on the list.

virtual csPtr<iReporterIterator> iReporter::GetMessageIterator   [pure virtual]
 

Get an iterator to iterate over all messages.

This will make a copy of all messages so that the reporter is not locked.

virtual void iReporter::RemoveReporterListener iReporterListener   listener [pure virtual]
 

Remove a listener once.

The listener will be DecRef()'ed by this function. If the listener is on the list multiple times only one occurance is removed. If the listener cannot be found on the list no DecRef() will happen.

virtual void iReporter::Report int    severity,
const char *    msgId,
const char *    description,
...   
[pure virtual]
 

Report something.

The given message string should be formed like: 'crystalspace.<source>.<type>.<detail>'. Example: 'crystalspace.sprite2dloader.parse.material'.

void iReporter::ReportBug const char *    msgId,
const char *    description,
...   
[inline]
 

Report bug.

Definition at line 217 of file reporter.h.

References ReportV.

void iReporter::ReportDebug const char *    msgId,
const char *    description,
...   
[inline]
 

Report debug.

Definition at line 229 of file reporter.h.

References ReportV.

void iReporter::ReportError const char *    msgId,
const char *    description,
...   
[inline]
 

Report error.

Definition at line 181 of file reporter.h.

References ReportV.

void iReporter::ReportNotify const char *    msgId,
const char *    description,
...   
[inline]
 

Report notification.

Definition at line 205 of file reporter.h.

References ReportV.

virtual void iReporter::ReportV int    severity,
const char *    msgId,
const char *    description,
va_list   
[pure virtual]
 

Report something.

va_list version.

Referenced by ReportBug, ReportDebug, ReportError, ReportNotify, and ReportWarning.

void iReporter::ReportWarning const char *    msgId,
const char *    description,
...   
[inline]
 

Report warning.

Definition at line 193 of file reporter.h.

References ReportV.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14