OpenCV  3.2.0-dev
Open Source Computer Vision
cv::viz::KeyboardEvent Class Reference

This class represents a keyboard event. More...

#include "types.hpp"

Collaboration diagram for cv::viz::KeyboardEvent:

Public Types

enum  {
  NONE = 0,
  ALT = 1,
  CTRL = 2,
  SHIFT = 4
}
 
enum  Action {
  KEY_UP = 0,
  KEY_DOWN = 1
}
 

Public Member Functions

 KeyboardEvent (Action action, const String &symbol, unsigned char code, int modifiers)
 Constructs a KeyboardEvent. More...
 

Public Attributes

Action action
 
unsigned char code
 
int modifiers
 
String symbol
 

Detailed Description

This class represents a keyboard event.

Member Enumeration Documentation

anonymous enum
Enumerator
NONE 
ALT 
CTRL 
SHIFT 
Enumerator
KEY_UP 
KEY_DOWN 

Constructor & Destructor Documentation

cv::viz::KeyboardEvent::KeyboardEvent ( Action  action,
const String symbol,
unsigned char  code,
int  modifiers 
)

Constructs a KeyboardEvent.

Parameters
actionSignals if key is pressed or released.
symbolName of the key.
codeCode of the key.
modifiersSignals if alt, ctrl or shift are pressed or their combination.

Member Data Documentation

Action cv::viz::KeyboardEvent::action
unsigned char cv::viz::KeyboardEvent::code
int cv::viz::KeyboardEvent::modifiers
String cv::viz::KeyboardEvent::symbol

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