iReporter Struct Reference
[Utilities]
This is the interface for the error/message reporter plugin.
More...
#include <reporter.h>
Inheritance diagram for iReporter:

Public Methods | |
virtual void | Report (int severity, const char *msgId, const char *description,...)=0 |
Report something. | |
virtual void | ReportV (int severity, const char *msgId, const char *description, va_list)=0 |
Report something. | |
virtual void | Clear (int severity=-1)=0 |
Clear all messages in the reporter. | |
virtual void | Clear (const char *mask)=0 |
Clear all messages in the reporter for which the id matches with the given mask. | |
virtual csPtr< iReporterIterator > | GetMessageIterator ()=0 |
Get an iterator to iterate over all messages. | |
virtual void | AddReporterListener (iReporterListener *listener)=0 |
Add a listener that listens to new reports. | |
virtual void | RemoveReporterListener (iReporterListener *listener)=0 |
Remove a listener once. | |
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.
Definition at line 124 of file reporter.h.
Member Function Documentation
|
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. |
|
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.*") |
|
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. |
|
Check if the listener is already on the list.
|
|
Get an iterator to iterate over all messages. This will make a copy of all messages so that the reporter is not locked. |
|
Remove a listener once. The listener will be DecRef()'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 DecRef() will happen. |
|
Report something. The given message ID should be formed like: 'crystalspace.<source>.<type>.<detail>'. Example: 'crystalspace.sprite2dloader.parse.material'. |
|
Report something. va_list version. |
The documentation for this struct was generated from the following file:
- ivaria/reporter.h
Generated for Crystal Space by doxygen 1.2.18