EEditErrorToolbox Class Reference

This displays effect errors. More...

#include <eediterrortoolbox.h>

List of all members.

Public Member Functions
void	AddError (int severity, const char *msgId, const char *description)
	Adds an error to the reporter.
void	Clear ()
	Clears all current effects.
	EEditErrorToolbox ()
virtual const char *	GetName () const
	Gets the name of the toolbox.
virtual size_t	GetType () const
	Gets the toolbox type.
virtual bool	OnButtonPressed (int mouseButton, int keyModifier, pawsWidget *widget)
	Called whenever a button is pressed.
virtual bool	PostSetup ()
	This is called after the widget and all of it's children have been created.
void	ResetFilter ()
	Builds a filter based on the state of current widgets and filters the list.
void	SetLoadingEffects (bool isLoadingEffects)
	Sets whether the effects are being loaded, so that they can be handled differently if desired by the user.
virtual void	Show ()
	Makes widget visible and brings it to the front.
virtual void	Update (unsigned int elapsed)
	Updates the toobox.
virtual	~EEditErrorToolbox ()

---

Detailed Description

This displays effect errors.

Definition at line 55 of file eediterrortoolbox.h.

---

Constructor & Destructor Documentation

EEditErrorToolbox::EEditErrorToolbox

(

)

virtual EEditErrorToolbox::~EEditErrorToolbox

(

)

[virtual]

---

Member Function Documentation

void EEditErrorToolbox::AddError	(	int	severity,
		const char *	msgId,
		const char *	description
	)

Adds an error to the reporter.

Parameters:

severity	The severity of the error. Check csReport for a list of available severities.
msgId	An identifier saying where the message came from.
description	The actual error description.

void EEditErrorToolbox::Clear

(

)

Clears all current effects.

virtual const char* EEditErrorToolbox::GetName

(

)

const [virtual]

Gets the name of the toolbox.

Returns:

the toolbox name

Implements EEditToolbox.

virtual size_t EEditErrorToolbox::GetType

(

)

const [virtual]

Gets the toolbox type.

Returns:

the toolbox type

Implements EEditToolbox.

virtual bool EEditErrorToolbox::OnButtonPressed	(	int	button,
		int	keyModifier,
		pawsWidget *	widget
	)		[virtual]

Called whenever a button is pressed.

Parameters:

button	The button pressed.
keyModifier	Modifier key in effect.
widget	The widget the button belongs to.

Returns:

bool Parent's result or FALSE if no parent.

Reimplemented from pawsWidget.

virtual bool EEditErrorToolbox::PostSetup

(

)

[virtual]

This is called after the widget and all of it's children have been created.

Remarks:

This can be useful for widgets that want to get pointers to some of it's children for quick access.

Reimplemented from pawsWidget.

void EEditErrorToolbox::ResetFilter

(

)

Builds a filter based on the state of current widgets and filters the list.

void EEditErrorToolbox::SetLoadingEffects

(

bool

isLoadingEffects

)

Sets whether the effects are being loaded, so that they can be handled differently if desired by the user.

Parameters:

isLoadingEffects

True if the effects are going to be loaded, false if they are not.

virtual void EEditErrorToolbox::Show

(

)

[virtual]

Makes widget visible and brings it to the front.

Sets visible TRUE shows border if present then calls BringToTop() on itself.

Reimplemented from pawsWidget.

virtual void EEditErrorToolbox::Update

(

unsigned int

elapsed

)

[virtual]

Updates the toobox.

Parameters:

elapsed

the time elapsed in milliseconds.

Reimplemented from EEditToolbox.

---

The documentation for this class was generated from the following file:

• eedit/eediterrortoolbox.h