JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | List of all members
KeyListener Class Referenceabstract

Receives callbacks when keys are pressed. More...

Inherited by KeyPressMappingSet.

Public Member Functions

virtual ~KeyListener ()
 Destructor.
 
virtual bool keyPressed (const KeyPress &key, Component *originatingComponent)=0
 Called to indicate that a key has been pressed.
 
virtual bool keyStateChanged (bool isKeyDown, Component *originatingComponent)
 Called when any key is pressed or released.
 

Detailed Description

Receives callbacks when keys are pressed.

You can add a key listener to a component to be informed when that component gets key events. See the Component::addListener method for more details.

See Also
KeyPress, Component::addKeyListener, KeyPressMappingSet

Constructor & Destructor Documentation

virtual KeyListener::~KeyListener ( )
virtual

Destructor.

Member Function Documentation

virtual bool KeyListener::keyPressed ( const KeyPress key,
Component originatingComponent 
)
pure virtual

Called to indicate that a key has been pressed.

If your implementation returns true, then the key event is considered to have been consumed, and will not be passed on to any other components. If it returns false, then the key will be passed to other components that might want to use it.

Parameters
keythe keystroke, including modifier keys
originatingComponentthe component that received the key event
See Also
keyStateChanged, Component::keyPressed

Implemented in KeyPressMappingSet.

virtual bool KeyListener::keyStateChanged ( bool  isKeyDown,
Component originatingComponent 
)
virtual

Called when any key is pressed or released.

When this is called, classes that might be interested in the state of one or more keys can use KeyPress::isKeyCurrentlyDown() to check whether their key has changed.

If your implementation returns true, then the key event is considered to have been consumed, and will not be passed on to any other components. If it returns false, then the key will be passed to other components that might want to use it.

Parameters
originatingComponentthe component that received the key event
isKeyDowntrue if a key is being pressed, false if one is being released
See Also
KeyPress, Component::keyStateChanged

Reimplemented in KeyPressMappingSet.


The documentation for this class was generated from the following file: