SOFA API  6a688117
Open source framework for multi-physics simuation
sofa::core::objectmodel::GUIEvent Class Reference

#include <GUIEvent.h>

This event notifies about GUI interaction. More...

Inheritance diagram for sofa::core::objectmodel::GUIEvent:

Detailed Description

This event notifies about GUI interaction.

Public Member Functions

 GUIEvent (const char *controlID, const char *valueName, const char *value)
 Constructor. More...
 
 ~GUIEvent () override
 Destructor. More...
 
const std::string getControlID (void) const
 Get the emitter control ID. More...
 
const std::string getValueName (void) const
 Get the value name. More...
 
const std::string getValue (void) const
 Get the value. More...
 
- Public Member Functions inherited from sofa::core::objectmodel::Event
 Event ()
 
virtual ~Event ()
 
void setHandled ()
 Tag the event as handled, i.e. the event needs not be propagated further. More...
 
bool isHandled () const
 Returns true of the event has been handled. More...
 
virtual const char * getClassName () const
 
virtual size_t getEventTypeIndex () const =0
 

Static Public Member Functions

static const char * GetClassName ()
 
- Static Public Member Functions inherited from sofa::core::objectmodel::Event
static const char * GetClassName ()
 
static size_t getEventTypeCount ()
 

Additional Inherited Members

- Protected Attributes inherited from sofa::core::objectmodel::Event
bool m_handled
 
- Static Protected Attributes inherited from sofa::core::objectmodel::Event
static size_t s_lastEventTypeIndex = 0
 storing the last given id More...
 

Constructor details

sofa::core::objectmodel::GUIEvent::GUIEvent ( const char *  controlID,
const char *  valueName,
const char *  value 
)

Constructor.

sofa::core::objectmodel::GUIEvent::~GUIEvent ( )
override

Destructor.

Function details

static const char* sofa::core::objectmodel::GUIEvent::GetClassName ( )
inlinestatic
const std::string sofa::core::objectmodel::GUIEvent::getControlID ( void  ) const
inline

Get the emitter control ID.

const std::string sofa::core::objectmodel::GUIEvent::getValue ( void  ) const
inline

Get the value.

const std::string sofa::core::objectmodel::GUIEvent::getValueName ( void  ) const
inline

Get the value name.