EEditLoadEffectToolbox Class Reference

This allows you to load an effect. More...

#include <eeditloadeffecttoolbox.h>

List of all members.

Public Member Functions
	EEditLoadEffectToolbox ()
void	FillList (psEffectManager *effectManager)
	Fills the load effect list with the names of the effects.
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 void	OnListAction (pawsListBox *selected, int status)
	Called whenever an item in a child list box is selected.
virtual bool	PostSetup ()
	This is called after the widget and all of it's children have been created.
void	SelectEffect (const csString &effectName)
	Selects the given effect and highlights it in the list.
virtual void	Update (unsigned int elapsed)
	Updates the toobox.
virtual	~EEditLoadEffectToolbox ()

---

Detailed Description

This allows you to load an effect.

Definition at line 36 of file eeditloadeffecttoolbox.h.

---

Constructor & Destructor Documentation

EEditLoadEffectToolbox::EEditLoadEffectToolbox

(

)

virtual EEditLoadEffectToolbox::~EEditLoadEffectToolbox

(

)

[virtual]

---

Member Function Documentation

void EEditLoadEffectToolbox::FillList

(

psEffectManager *

effectManager

)

Fills the load effect list with the names of the effects.

Parameters:

effectManager

a pointer to a valid effect manager

virtual const char* EEditLoadEffectToolbox::GetName

(

)

const [virtual]

Gets the name of the toolbox.

Returns:

the toolbox name

Implements EEditToolbox.

virtual size_t EEditLoadEffectToolbox::GetType

(

)

const [virtual]

Gets the toolbox type.

Returns:

the toolbox type

Implements EEditToolbox.

virtual bool EEditLoadEffectToolbox::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 void EEditLoadEffectToolbox::OnListAction	(	pawsListBox *	selected,
		int	status
	)		[virtual]

Called whenever an item in a child list box is selected.

Parameters:

selected	The listbox that has the item selected.
status	From listbox when a row is selected.

Reimplemented from pawsWidget.

virtual bool EEditLoadEffectToolbox::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 EEditLoadEffectToolbox::SelectEffect

(

const csString &

effectName

)

Selects the given effect and highlights it in the list.

Parameters:

effectName

the name of the effect to select.

virtual void EEditLoadEffectToolbox::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/eeditloadeffecttoolbox.h