class cv::viz::KeyboardEvent

Overview

This class represents a keyboard event. More…

#include <types.hpp>

class KeyboardEvent
{
public:
    // enums

    enum
    {
        NONE  = 0,
        ALT   = 1,
        CTRL  = 2,
        SHIFT = 4,
    };

    enum Action;

    // fields

    Action action;
    unsigned char code;
    int modifiers;
    String symbol;

    // construction

    KeyboardEvent(
        Action action,
        const String& symbol,
        unsigned char code,
        int modifiers
        );
};

Detailed Documentation

This class represents a keyboard event.

Construction

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.