Public Types | Public Member Functions | Public Attributes | List of all members
gazebo::common::KeyEvent Class Reference

Generic description of a keyboard event. More...

#include <common/common.hh>

Public Types

enum  EventType { NO_EVENT, PRESS, RELEASE }
 Key event types enumeration. More...
 

Public Member Functions

 KeyEvent ()
 Constructor. More...
 

Public Attributes

bool alt
 Was alt held during this key event? More...
 
bool control
 Was control held during this key event? More...
 
int key
 The raw value of the key pressed. More...
 
bool shift
 Was shift held during this key event? More...
 
std::string text
 Formatted string of the key pressed (could be uppercase). More...
 
EventType type
 Event type. More...
 

Detailed Description

Generic description of a keyboard event.

Member Enumeration Documentation

Key event types enumeration.

Enumerator
NO_EVENT 
PRESS 
RELEASE 

Constructor & Destructor Documentation

gazebo::common::KeyEvent::KeyEvent ( )

Constructor.

Member Data Documentation

bool gazebo::common::KeyEvent::alt

Was alt held during this key event?

bool gazebo::common::KeyEvent::control

Was control held during this key event?

int gazebo::common::KeyEvent::key

The raw value of the key pressed.

bool gazebo::common::KeyEvent::shift

Was shift held during this key event?

std::string gazebo::common::KeyEvent::text

Formatted string of the key pressed (could be uppercase).

EventType gazebo::common::KeyEvent::type

Event type.


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