Odyssey::TriggerInputCombo Class Reference

This combo combines the "and" combo with a one-shot trigger. More...

#include <InputCombo.h>

Inheritance diagram for Odyssey::TriggerInputCombo:

Odyssey::InputCombo List of all members.

Public Member Functions

 TriggerInputCombo ()
void addActionWindow (const String &openAction, const String &closeAction)
 Adds a new input event window to this combo.
void removeActionWindow (size_t index)
 Removes the indexed window from the combo.
void clearActionWindows ()
 Removes all the action windows from this combo.
void setTrigger (const String &name)
 This sets the trigger event name.
const StringgetTrigger () const
 This retrieves the current trigger event.
void onEvent (const String &action)
 The callback for this combo's action mapping.

Classes

class  InputWindow

Detailed Description

This combo combines the "and" combo with a one-shot trigger.

This class is a combo controller that is triggered during a special "and" condition, where windows of events must coincide with a specific trigger event. This combo is similar to the AndInputCombo, except the notion of the special trigger event which does not act like the normal event "windows" but is a once-shot trigger.


Constructor & Destructor Documentation

Odyssey::TriggerInputCombo::TriggerInputCombo  ) 
 


Member Function Documentation

void Odyssey::TriggerInputCombo::addActionWindow const String openAction,
const String closeAction
 

Adds a new input event window to this combo.

void Odyssey::TriggerInputCombo::clearActionWindows  ) 
 

Removes all the action windows from this combo.

const String& Odyssey::TriggerInputCombo::getTrigger  )  const
 

This retrieves the current trigger event.

void Odyssey::TriggerInputCombo::onEvent const String action  )  [virtual]
 

The callback for this combo's action mapping.

This is the callable target that get notified when an action from this combo's action map is invoked. It is in this overrideable that the logic for combo invocation is made. If the combo should be invoked, onCombo needs to be called.

Parameters:
action the name of the action invoked
See also:
onCombo

Reimplemented from Odyssey::InputCombo.

void Odyssey::TriggerInputCombo::removeActionWindow size_t  index  ) 
 

Removes the indexed window from the combo.

void Odyssey::TriggerInputCombo::setTrigger const String name  ) 
 

This sets the trigger event name.


The documentation for this class was generated from the following file:
Generated on Sun Jan 7 01:18:52 2007 for Odyssey Meta-Engine by  doxygen 1.4.6-NO