CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iInputBinder Struct Reference

Bind an input event to a pointer to a variable, so that that variable will reflect the state of a given key, button or axis. More...

#include <binder.h>

Inheritance diagram for iInputBinder:

iBase csInputBinder List of all members.

Public Methods

virtual iEventHandlerQueryHandler ()=0
 Get a pointer to the embedded iEventHander This class can be registered with the event queue: EventQueue->RegisterListener(InputBinder->QueryHandler (), CSMASK_Input);. More...

virtual void Bind (iEvent &, iInputBinderBoolean *, bool toggle=false)=0
 Bind a bool to a keyboard key or mouse or joystick button status. More...

virtual void Bind (iEvent &, iInputBinderPosition *)=0
 Bind two int's to the x and y axes of a mouse or joystick. More...

virtual bool Unbind (iEvent &)=0
 Remove a binding. More...

virtual bool UnbindAll ()=0
 Remove all bindings. More...


Detailed Description

Bind an input event to a pointer to a variable, so that that variable will reflect the state of a given key, button or axis.

Definition at line 60 of file iutil/binder.h.


Member Function Documentation

virtual void iInputBinder::Bind iEvent  ,
iInputBinderPosition  
[pure virtual]
 

Bind two int's to the x and y axes of a mouse or joystick.

Implemented in csInputBinder.

virtual void iInputBinder::Bind iEvent  ,
iInputBinderBoolean  ,
bool    toggle = false
[pure virtual]
 

Bind a bool to a keyboard key or mouse or joystick button status.

If toggle is true, one press activates and the second deactivates. Otherwise, keydown activates and keyup deactivates.

Implemented in csInputBinder.

virtual iEventHandler* iInputBinder::QueryHandler   [pure virtual]
 

Get a pointer to the embedded iEventHander This class can be registered with the event queue: EventQueue->RegisterListener(InputBinder->QueryHandler (), CSMASK_Input);.

Implemented in csInputBinder.

virtual bool iInputBinder::Unbind iEvent   [pure virtual]
 

Remove a binding.

Implemented in csInputBinder.

virtual bool iInputBinder::UnbindAll   [pure virtual]
 

Remove all bindings.

Implemented in csInputBinder.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14