- Your Widget Set For OpenGL
Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | Related Pages

ufo::UActionEvent Class Reference

This event is used for many synchronous messages which indicate an action like in button, check boxes etc. More...

#include <uactionevent.hpp>

Inheritance diagram for ufo::UActionEvent:

ufo::UEvent ufo::UObject ufo::UCollectable List of all members.

Public Member Functions

 UActionEvent (UObject *source, Type type, UMod_t modifiers, const std::string &actionCommand)
UMod_t getModifiers ()
const std::string & getActionCommand ()
void revoke ()
bool isRevoked () const

Protected Member Functions

virtual std::ostream & paramString (std::ostream &os) const

Detailed Description

This event is used for many synchronous messages which indicate an action like in button, check boxes etc.

Author:
Johannes Schmidt


Constructor & Destructor Documentation

ufo::UActionEvent::UActionEvent UObject source,
Type  type,
UMod_t  modifiers,
const std::string &  actionCommand
[inline]
 

Creates a new action event.

Parameters:
source The emitting object
type The event type (should be UEvent::Action)
modifiers Mouse and keyboard modifiers
actionCommand A string describing this action


Member Function Documentation

const std::string& ufo::UActionEvent::getActionCommand  )  [inline]
 

Returns:
A string describing this action

UMod_t ufo::UActionEvent::getModifiers  )  [inline]
 

Returns:
Mouse and keyboard modifiers which where pressed at the time this event was fired.

bool ufo::UActionEvent::isRevoked  )  const [inline]
 

Returns:
True if this event has been revoked.

virtual std::ostream& ufo::UActionEvent::paramString std::ostream &  os  )  const [protected, virtual]
 

Prints some useful internal data to the ostream os. This method is meant only for debugging purposes.

Reimplemented from ufo::UEvent.

void ufo::UActionEvent::revoke  )  [inline]
 

Tries to revoke this action. The library or application might revoke its action.


The documentation for this class was generated from the following file:
The libUFO Project - written by Johannes Schmidt