MessageInterpreter.CompositeMessageInterpreter Class Reference
Detailed Description
A CompositeMessageInterpreter is a message interpreter that can forward received messages on to other message receivers.
#include
<class_message_interpreter_1_1_composite_message_interpreter.h>
Public Member Functions |
|
| __init__ () | |
| deactivate () | |
| Abstract - to be implemented by the
subclasses. |
|
| wantsMessage () | |
| If processMessage were to be called at this
point would this interpreter handle it? |
|
| processMessage () | |
| Abstract - to be implemented by the
subclasses. |
|
| onChildReceiverAdded () | |
| onChildReceiverRemoved () | |
Member Function Documentation
| MessageInterpreter.CompositeMessageInterpreter.__init__ | ( | ) |
| MessageInterpreter.CompositeMessageInterpreter.deactivate | ( | ) |
Abstract - to be implemented by the subclasses.
Performs the operations necessary to place this interpreter into a passive state. Ensure that this base class implementation is called by the subclass implementation.
Reimplemented from MessageInterpreter.MessageInterpreter.
Reimplemented in DialogInterpreter.DialogInterpreter, ManipulatorInterpreter.ManipulatorInterpreter, ObjectPatchesInterpreter.ObjectPatchesInterpreter, and ScriptInterpreter.ScriptInterpreter.
| MessageInterpreter.CompositeMessageInterpreter.wantsMessage | ( | ) |
If processMessage were to be called at this point would this interpreter handle it?
Reimplemented from MessageInterpreter.MessageInterpreter.
| MessageInterpreter.CompositeMessageInterpreter.processMessage | ( | ) |
Abstract - to be implemented by the subclasses.
The default implementation should be sufficient for most intepreters. Returns True if the message was processed; False otherwise. Note, no message processing occurs if the interpreter is deactivated.
The signature of a message handler method should be:
def methodName( self, message )
where message.id == methodName
Reimplemented from MessageInterpreter.MessageInterpreter.
| MessageInterpreter.CompositeMessageInterpreter.onChildReceiverAdded | ( | ) |
Reimplemented in DialogInterpreter.DialogInterpreter.
| MessageInterpreter.CompositeMessageInterpreter.onChildReceiverRemoved | ( | ) |
Reimplemented in DialogInterpreter.DialogInterpreter.
