cv::viz::KeyboardEvent Class Reference

This class represents a keyboard event. More...

#include <opencv2/viz/types.hpp>

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.

Public Attributes
Action	action
unsigned char	code
int	modifiers
String	symbol

Detailed Description

This class represents a keyboard event.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
NONE
ALT
CTRL
SHIFT

Action

enum cv::viz::KeyboardEvent::Action

Enumerator
KEY_UP
KEY_DOWN

Constructor & Destructor Documentation

KeyboardEvent()

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

Constructs a KeyboardEvent.

Parameters

action	Signals if key is pressed or released.
symbol	Name of the key.
code	Code of the key.
modifiers	Signals if alt, ctrl or shift are pressed or their combination.

Member Data Documentation

action

Action cv::viz::KeyboardEvent::action

code

unsigned char cv::viz::KeyboardEvent::code

modifiers

int cv::viz::KeyboardEvent::modifiers

symbol

String cv::viz::KeyboardEvent::symbol

---

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

• opencv2/viz/types.hpp