#include <OgreActionEvent.h>
Inheritance diagram for Ogre::ActionEvent:
Public Types | |
enum | { AE_ACTION_FIRST = 1001, AE_ACTION_LAST = 1001 } |
enum | { AE_ACTION_PERFORMED = AE_ACTION_FIRST } |
This event id indicates that a meaningful action occured. More... | |
enum | { SHIFT_MASK = 1 << 0, CTRL_MASK = 1 << 1, META_MASK = 1 << 2, ALT_MASK = 1 << 3, BUTTON0_MASK = 1 << 4, BUTTON1_MASK = 1 << 5, BUTTON2_MASK = 1 << 6, BUTTON3_MASK = 1 << 7, BUTTON_ANY_MASK = 0x1111 << 4 } |
Public Methods | |
ActionEvent (ActionTarget *source, int id, Real when, int modifiers, const String &actionCommand) | |
Constructs a ActionEvent object with the specified source GuiElement, type, modifiers, coordinates, and click count. More... | |
const String & | getActionCommand () const |
Returns the command string associated with this action. More... | |
String | paramString () |
Returns a parameter string identifying this action event. More... | |
void | consume () |
Consumes this event so that it will not be processed in the default manner by the source which originated it. More... | |
int | getModifiers () |
Returns the modifiers flag for this event. More... | |
Real | getWhen () |
Returns the timestamp of when this event occurred. More... | |
bool | isAltDown () |
Returns whether or not the Alt modifier is down on this event. More... | |
bool | isConsumed () |
Returns whether or not this event has been consumed. More... | |
bool | isControlDown () |
Returns whether or not the Control modifier is down on this event. More... | |
bool | isMetaDown () |
Returns whether or not the Meta modifier is down on this event. More... | |
bool | isShiftDown () |
Returns whether or not the Shift modifier is down on this event. More... | |
bool | isEventBetween (int start, int end) |
int | getID () |
EventTarget * | getSource () |
Protected Attributes | |
String | mActionCommand |
The nonlocalized string that gives more details of what actually caused the event. More... | |
Real | mWhen |
Not implemented yet. More... | |
int | mModifiers |
The state of the modifier keys at the time the input event was fired. More... | |
EventTarget * | mSource |
The target to process the event. More... | |
int | mId |
The ID of the event. More... | |
bool | mConsumed |
whether the event has been consumed. More... |
|
|
|
This event id indicates that a meaningful action occured.
|
|
|
Constructs a ActionEvent object with the specified source GuiElement, type, modifiers, coordinates, and click count.
|
|
Consumes this event so that it will not be processed in the default manner by the source which originated it.
|
|
Returns the command string associated with this action. This string allows a "modal" component to specify one of several commands, depending on its state. For example, a single button might toggle between "show details" and "hide details". The source object and the event would be the same in each case, but the command string would identify the intended action.
|
|
|
|
Returns the modifiers flag for this event.
|
|
|
|
Returns the timestamp of when this event occurred. Not implemented yet |
|
Returns whether or not the Alt modifier is down on this event.
|
|
Returns whether or not this event has been consumed.
|
|
Returns whether or not the Control modifier is down on this event.
|
|
|
|
Returns whether or not the Meta modifier is down on this event.
|
|
Returns whether or not the Shift modifier is down on this event.
|
|
Returns a parameter string identifying this action event. This method is useful for event-logging and for debugging.
|
|
The nonlocalized string that gives more details of what actually caused the event. This information is very specific to the component that fired it. |
|
whether the event has been consumed.
|
|
The ID of the event.
|
|
The state of the modifier keys at the time the input event was fired.
|
|
The target to process the event. This is ususally found by the dispatcher |
|
Not implemented yet.
|
Copyright © 2002 by The OGRE Team