libsuit  0.1.1
SFML User Interface Toolkit
Public Member Functions | List of all members
ui::KeyControl Class Reference

A key control. More...

#include <ui/Control.h>

Inheritance diagram for ui::KeyControl:
Inheritance graph
[legend]

Public Member Functions

 KeyControl (sf::Keyboard::Key key)
 Construct a key control. More...
 
virtual void update (const sf::Event &event) override
 Update the state of the control thanks to an event. More...
 
- Public Member Functions inherited from ui::Control
 Control (std::string name, std::string controller_name)
 Construct a control with a name and its controller name. More...
 
virtual ~Control ()
 Destroy the control. More...
 
bool isActive ()
 Tell whether the control is active. More...
 
void setActive (bool active=true)
 Change the active state of the control. More...
 
void reset ()
 Desactivate the control. More...
 

Detailed Description

A key control.

Constructor & Destructor Documentation

ui::KeyControl::KeyControl ( sf::Keyboard::Key  key)

Construct a key control.

Parameters
keythe key of the keyboard.

Member Function Documentation

virtual void ui::KeyControl::update ( const sf::Event &  event)
overridevirtual

Update the state of the control thanks to an event.

Parameters
eventthe event to update the control.
See also
Action::update()

Implements ui::Control.