StarPeak ToolKit
About SPTK Downloads Documentation Examples Supported Platforms and Plugins

           

---

sptkEventHandler Class Reference

#include <sptkeventhandler.h>

Inheritance diagram for sptkEventHandler:

List of all members.

Public Member Functions
void	setName (std::string name)
std::string	getName ()
bool	registerGadget (sptkGadget *newGadget)
void	unregisterGadget (std::string gadgetName)
virtual void	doEvent (int eventClass, int eventType)
void	setName (std::string name)
std::string	getName ()
bool	registerGadget (sptkGadget *newGadget)
void	unregisterGadget (std::string gadgetName)
virtual void	doEvent (int eventClass, int eventType)
Protected Attributes
std::string	name

---

Detailed Description

Author:

Sven Broenstrup

---

Member Function Documentation

virtual void sptkEventHandler::doEvent (  int    eventClass, int    eventType )  [virtual]

Handle Events here. This function has to been overwritten with your Event-Handler. See documentations and examples for detailed informations. Parameters: eventClass  The class of the event, e.g. sptkButtonEventClass. eventType  The type of the event, e.g. sptkEventPressed, sptkEventChanged.

virtual void sptkEventHandler::doEvent (  int    eventClass, int    eventType )  [virtual]

Handle Events here. This function has to been overwritten with your Event-Handler. See documentations and examples for detailed informations. Parameters: eventClass  The class of the event, e.g. sptkButtonEventClass. eventType  The type of the event, e.g. sptkEventPressed, sptkEventChanged.

std::string sptkEventHandler::getName (    )

Get the name of the Handler Returns: The unique name string of the Handler.

std::string sptkEventHandler::getName (    )

Get the name of the Handler Returns: The unique name string of the Handler.

bool sptkEventHandler::registerGadget (  sptkGadget *    newGadget )

Register a new InputGadget to the EventHandler. Parameters: newGadget  The InputGadget to register. Returns: TRUE if Gadget added, FALSE if ID exists.

bool sptkEventHandler::registerGadget (  sptkGadget *    newGadget )

Register a new InputGadget to the EventHandler. Parameters: newGadget  The InputGadget to register. Returns: TRUE if Gadget added, FALSE if ID exists.

void sptkEventHandler::setName (  std::string    name )

Set the name of the Handler. Parameters: name  Unique string for the EventHandler.

void sptkEventHandler::setName (  std::string    name )

Set the name of the Handler. Parameters: name  Unique string for the EventHandler.

void sptkEventHandler::unregisterGadget (  std::string    gadgetName )

Unregister the given InputGadget from the EventHandler. Parameters: gadgetName  The ID given to the InputGadget to be removed.

void sptkEventHandler::unregisterGadget (  std::string    gadgetName )

Unregister the given InputGadget from the EventHandler. Parameters: gadgetName  The ID given to the InputGadget to be removed.

---

Member Data Documentation

std::string sptkEventHandler::name [protected]

Unique name string of EventHandler

---

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

• sptkcore/sptkeventhandler.h
• sptkui/sptkeventhandler.h