Google

Main Page   Class Hierarchy   Compound List   File List   Compound 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 int GetMessageCount () const=0
 Give the number of reported messages currently registered.

virtual int GetMessageSeverity (int idx) const=0
 Get message severity. More...

virtual const char* GetMessageId (int idx) const=0
 Get message id. More...

virtual const char* GetMessageDescription (int idx) const=0
 Get message description. 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.

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

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

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

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

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


Detailed Description

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


Member Function Documentation

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.

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.*")

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.

const char * iReporter::GetMessageDescription ( int idx ) const [pure virtual]
 

Get message description.

Returns NULL if message doesn't exist.

const char * iReporter::GetMessageId ( int idx ) const [pure virtual]
 

Get message id.

Returns NULL if message doesn't exist.

int iReporter::GetMessageSeverity ( int idx ) const [pure virtual]
 

Get message severity.

Returns -1 if message doesn't exist.

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.

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::ReportV ( int severity,
const char * msgId,
const char * description,
va_list ) [pure virtual]
 

Report something.

va_list version.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000