Phx::LogicalInputEngine::ButtonClient Class Reference

A sub-interface of LogicalInputEngine that allows a client to retrieve the state of a logical button. More...

#include <PhxLogicalInputEngine.h>

Inheritance diagram for Phx::LogicalInputEngine::ButtonClient:

List of all members.

Public Member Functions
virtual void	listener (Listener *listener)=0
	Sets the listener that will be notified when the button state changes.
virtual ButtonState	buttonState (void) const =0
	Gets the button state for this logical button.
const String &	name (void) const
	Returns the name of this logical button.
Protected Member Functions
void	setName (const String &name)
Classes
class	Listener
	A listener that allows a client to be notified when the buttonState() attribute changes. More...

---

Detailed Description

A sub-interface of LogicalInputEngine that allows a client to retrieve the state of a logical button.

---

Member Function Documentation

virtual ButtonState Phx::LogicalInputEngine::ButtonClient::buttonState (  void   )  const [pure virtual]

Gets the button state for this logical button. Returns: The state of the logical button, or LogicalInputEngine::RELEASED if the name is not known and/or has no driver attached to it.

virtual void Phx::LogicalInputEngine::ButtonClient::listener (  Listener *  listener  )  [pure virtual]

Sets the listener that will be notified when the button state changes. Parameters: listener  The listener to be notified when buttonState() changes.

const String& Phx::LogicalInputEngine::ButtonClient::name (  void   )  const [inline]

Returns the name of this logical button. Returns: The name of this logical button.

---

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

• PhxLogicalInputEngine.h

---