Represent an event. It can be key press event, a terminal resize, or more ... More...

#include <event.hpp>

Public Member Functions
bool	operator== (const Event &other) const

bool	operator!= (const Event &other) const

bool	operator< (const Event &other) const

const std::string &	input () const

bool	is_character () const

std::string	character () const

bool	is_mouse () const

struct Mouse &	mouse ()

bool	is_cursor_position () const

int	cursor_x () const

int	cursor_y () const

bool	is_cursor_shape () const

int	cursor_shape () const

std::string	DebugString () const
	Return a string representation of the event.

Static Public Member Functions
static Event	Character (std::string)
	An event corresponding to a given typed character.

static Event	Character (char)
	An event corresponding to a given typed character.

static Event	Character (wchar_t)
	An event corresponding to a given typed character.

static Event	Special (std::string)
	An custom event whose meaning is defined by the user of the library.

static Event	Mouse (std::string, Mouse mouse)
	An event corresponding to a given typed character.

static Event	CursorPosition (std::string, int x, int y)

static Event	CursorShape (std::string, int shape)
	An event corresponding to a terminal DCS (Device Control String).

Public Attributes
ScreenInteractive *	screen_ = nullptr

Static Public Attributes
static const Event	ArrowLeft = Event::Special("\x1B[D")

static const Event	ArrowRight = Event::Special("\x1B[C")

static const Event	ArrowUp = Event::Special("\x1B[A")

static const Event	ArrowDown = Event::Special("\x1B[B")

static const Event	ArrowLeftCtrl = Event::Special("\x1B[1;5D")

static const Event	ArrowRightCtrl = Event::Special("\x1B[1;5C")

static const Event	ArrowUpCtrl = Event::Special("\x1B[1;5A")

static const Event	ArrowDownCtrl = Event::Special("\x1B[1;5B")

static const Event	Backspace = Event::Special({127})

static const Event	Delete = Event::Special("\x1B[3~")

static const Event	Return = Event::Special({10})

static const Event	Escape = Event::Special("\x1B")

static const Event	Tab = Event::Special({9})

static const Event	TabReverse = Event::Special({27, 91, 90})

static const Event	Insert = Event::Special("\x1B[2~")

static const Event	Home = Event::Special({27, 91, 72})

static const Event	End = Event::Special({27, 91, 70})

static const Event	PageUp = Event::Special({27, 91, 53, 126})

static const Event	PageDown = Event::Special({27, 91, 54, 126})

static const Event	F1 = Event::Special("\x1BOP")

static const Event	F2 = Event::Special("\x1BOQ")

static const Event	F3 = Event::Special("\x1BOR")

static const Event	F4 = Event::Special("\x1BOS")

static const Event	F5 = Event::Special("\x1B[15~")

static const Event	F6 = Event::Special("\x1B[17~")

static const Event	F7 = Event::Special("\x1B[18~")

static const Event	F8 = Event::Special("\x1B[19~")

static const Event	F9 = Event::Special("\x1B[20~")

static const Event	F10 = Event::Special("\x1B[21~")

static const Event	F11 = Event::Special("\x1B[23~")

static const Event	F12 = Event::Special("\x1B[24~")

static const Event	a = Event::Character("a")

static const Event	A = Event::Character("A")

static const Event	CtrlA = Event::Special("\x01")

static const Event	AltA = Event::Special("\x1b""a")

static const Event	CtrlAltA = Event::Special("\x1b\x01")

static const Event	b = Event::Character("b")

static const Event	B = Event::Character("B")

static const Event	CtrlB = Event::Special("\x02")

static const Event	AltB = Event::Special("\x1b""b")

static const Event	CtrlAltB = Event::Special("\x1b\x02")

static const Event	c = Event::Character("c")

static const Event	C = Event::Character("C")

static const Event	CtrlC = Event::Special("\x03")

static const Event	AltC = Event::Special("\x1b""c")

static const Event	CtrlAltC = Event::Special("\x1b\x03")

static const Event	d = Event::Character("d")

static const Event	D = Event::Character("D")

static const Event	CtrlD = Event::Special("\x04")

static const Event	AltD = Event::Special("\x1b""d")

static const Event	CtrlAltD = Event::Special("\x1b\x04")

static const Event	e = Event::Character("e")

static const Event	E = Event::Character("E")

static const Event	CtrlE = Event::Special("\x05")

static const Event	AltE = Event::Special("\x1b""e")

static const Event	CtrlAltE = Event::Special("\x1b\x05")

static const Event	f = Event::Character("f")

static const Event	F = Event::Character("F")

static const Event	CtrlF = Event::Special("\x06")

static const Event	AltF = Event::Special("\x1b""f")

static const Event	CtrlAltF = Event::Special("\x1b\x06")

static const Event	g = Event::Character("g")

static const Event	G = Event::Character("G")

static const Event	CtrlG = Event::Special("\x07")

static const Event	AltG = Event::Special("\x1b""g")

static const Event	CtrlAltG = Event::Special("\x1b\x07")

static const Event	h = Event::Character("h")

static const Event	H = Event::Character("H")

static const Event	CtrlH = Event::Special("\x08")

static const Event	AltH = Event::Special("\x1b""h")

static const Event	CtrlAltH = Event::Special("\x1b\x08")

static const Event	i = Event::Character("i")

static const Event	I = Event::Character("I")

static const Event	CtrlI = Event::Special("\x09")

static const Event	AltI = Event::Special("\x1b""i")

static const Event	CtrlAltI = Event::Special("\x1b\x09")

static const Event	j = Event::Character("j")

static const Event	J = Event::Character("J")

static const Event	CtrlJ = Event::Special("\x0a")

static const Event	AltJ = Event::Special("\x1b""j")

static const Event	CtrlAltJ = Event::Special("\x1b\x0a")

static const Event	k = Event::Character("k")

static const Event	K = Event::Character("K")

static const Event	CtrlK = Event::Special("\x0b")

static const Event	AltK = Event::Special("\x1b""k")

static const Event	CtrlAltK = Event::Special("\x1b\x0b")

static const Event	l = Event::Character("l")

static const Event	L = Event::Character("L")

static const Event	CtrlL = Event::Special("\x0c")

static const Event	AltL = Event::Special("\x1b""l")

static const Event	CtrlAltL = Event::Special("\x1b\x0c")

static const Event	m = Event::Character("m")

static const Event	M = Event::Character("M")

static const Event	CtrlM = Event::Special("\x0d")

static const Event	AltM = Event::Special("\x1b""m")

static const Event	CtrlAltM = Event::Special("\x1b\x0d")

static const Event	n = Event::Character("n")

static const Event	N = Event::Character("N")

static const Event	CtrlN = Event::Special("\x0e")

static const Event	AltN = Event::Special("\x1b""n")

static const Event	CtrlAltN = Event::Special("\x1b\x0e")

static const Event	o = Event::Character("o")

static const Event	O = Event::Character("O")

static const Event	CtrlO = Event::Special("\x0f")

static const Event	AltO = Event::Special("\x1b""o")

static const Event	CtrlAltO = Event::Special("\x1b\x0f")

static const Event	p = Event::Character("p")

static const Event	P = Event::Character("P")

static const Event	CtrlP = Event::Special("\x10")

static const Event	AltP = Event::Special("\x1b""p")

static const Event	CtrlAltP = Event::Special("\x1b\x10")

static const Event	q = Event::Character("q")

static const Event	Q = Event::Character("Q")

static const Event	CtrlQ = Event::Special("\x11")

static const Event	AltQ = Event::Special("\x1b""q")

static const Event	CtrlAltQ = Event::Special("\x1b\x11")

static const Event	r = Event::Character("r")

static const Event	R = Event::Character("R")

static const Event	CtrlR = Event::Special("\x12")

static const Event	AltR = Event::Special("\x1b""r")

static const Event	CtrlAltR = Event::Special("\x1b\x12")

static const Event	s = Event::Character("s")

static const Event	S = Event::Character("S")

static const Event	CtrlS = Event::Special("\x13")

static const Event	AltS = Event::Special("\x1b""s")

static const Event	CtrlAltS = Event::Special("\x1b\x13")

static const Event	t = Event::Character("t")

static const Event	T = Event::Character("T")

static const Event	CtrlT = Event::Special("\x14")

static const Event	AltT = Event::Special("\x1b""t")

static const Event	CtrlAltT = Event::Special("\x1b\x14")

static const Event	u = Event::Character("u")

static const Event	U = Event::Character("U")

static const Event	CtrlU = Event::Special("\x15")

static const Event	AltU = Event::Special("\x1b""u")

static const Event	CtrlAltU = Event::Special("\x1b\x15")

static const Event	v = Event::Character("v")

static const Event	V = Event::Character("V")

static const Event	CtrlV = Event::Special("\x16")

static const Event	AltV = Event::Special("\x1b""v")

static const Event	CtrlAltV = Event::Special("\x1b\x16")

static const Event	w = Event::Character("w")

static const Event	W = Event::Character("W")

static const Event	CtrlW = Event::Special("\x17")

static const Event	AltW = Event::Special("\x1b""w")

static const Event	CtrlAltW = Event::Special("\x1b\x17")

static const Event	x = Event::Character("x")

static const Event	X = Event::Character("X")

static const Event	CtrlX = Event::Special("\x18")

static const Event	AltX = Event::Special("\x1b""x")

static const Event	CtrlAltX = Event::Special("\x1b\x18")

static const Event	y = Event::Character("y")

static const Event	Y = Event::Character("Y")

static const Event	CtrlY = Event::Special("\x19")

static const Event	AltY = Event::Special("\x1b""y")

static const Event	CtrlAltY = Event::Special("\x1b\x19")

static const Event	z = Event::Character("z")

static const Event	Z = Event::Character("Z")

static const Event	CtrlZ = Event::Special("\x1a")

static const Event	AltZ = Event::Special("\x1b""z")

static const Event	CtrlAltZ = Event::Special("\x1b\x1a")

static const Event	Custom = Event::Special({0})

Detailed Description

Represent an event. It can be key press event, a terminal resize, or more ...

For example:

Printable character can be created using Event::Character('a').
Some special are predefined, like Event::ArrowLeft.
One can find arbitrary code for special Events using: ./example/util/print_key_press For instance, CTLR+A maps to Event::Special({1});

Useful documentation about xterm specification: https://invisible-island.net/xterm/ctlseqs/ctlseqs.html

Definition at line 27 of file event.hpp.

Member Function Documentation

◆ CursorPosition()

Event CursorPosition	(	std::string	input,
		int	x,
		int	y )

static

Definition at line 87 of file event.cpp.

◆ CursorShape()

Event CursorShape	(	std::string	input,
		int	shape )

static

An event corresponding to a terminal DCS (Device Control String).

Definition at line 67 of file event.cpp.

◆ operator==()

bool operator== ( const Event & other ) const

inline

Definition at line 98 of file event.hpp.

◆ operator!=()

bool operator!= ( const Event & other ) const

inline

Definition at line 99 of file event.hpp.

◆ operator<()

bool operator< ( const Event & other ) const

inline

Definition at line 100 of file event.hpp.

◆ input()

const std::string & input ( ) const

inline

Definition at line 102 of file event.hpp.

◆ is_character()

bool is_character ( ) const

inline

Definition at line 104 of file event.hpp.

◆ character()

std::string character ( ) const

inline

Definition at line 105 of file event.hpp.

◆ is_mouse()

bool is_mouse ( ) const

inline

Definition at line 107 of file event.hpp.

◆ mouse()

struct Mouse & mouse ( )

inline

Definition at line 108 of file event.hpp.

◆ is_cursor_position()

bool is_cursor_position ( ) const

inline

Definition at line 111 of file event.hpp.

◆ cursor_x()

int cursor_x ( ) const

inline

Definition at line 112 of file event.hpp.

◆ cursor_y()

int cursor_y ( ) const

inline

Definition at line 113 of file event.hpp.

◆ is_cursor_shape()

bool is_cursor_shape ( ) const

inline

Definition at line 115 of file event.hpp.

◆ cursor_shape()

int cursor_shape ( ) const

inline

Definition at line 116 of file event.hpp.

◆ DebugString()

std::string DebugString ( ) const

Return a string representation of the event.

Definition at line 96 of file event.cpp.

Member Data Documentation

◆ ArrowLeft

const Event ArrowLeft = Event::Special("\x1B[D")

static

Definition at line 38 of file event.hpp.

◆ ArrowRight

const Event ArrowRight = Event::Special("\x1B[C")

static

Definition at line 39 of file event.hpp.

◆ ArrowUp

const Event ArrowUp = Event::Special("\x1B[A")

static

Definition at line 40 of file event.hpp.

◆ ArrowDown

const Event ArrowDown = Event::Special("\x1B[B")

static

Definition at line 41 of file event.hpp.

◆ ArrowLeftCtrl

const Event ArrowLeftCtrl = Event::Special("\x1B[1;5D")

static

Definition at line 43 of file event.hpp.

◆ ArrowRightCtrl

const Event ArrowRightCtrl = Event::Special("\x1B[1;5C")

static

Definition at line 44 of file event.hpp.

◆ ArrowUpCtrl

const Event ArrowUpCtrl = Event::Special("\x1B[1;5A")

static

Definition at line 45 of file event.hpp.

◆ ArrowDownCtrl

const Event ArrowDownCtrl = Event::Special("\x1B[1;5B")

static

Definition at line 46 of file event.hpp.

◆ Backspace

const Event Backspace = Event::Special({127})

static

Definition at line 49 of file event.hpp.

◆ Delete

const Event Delete = Event::Special("\x1B[3~")

static

Definition at line 50 of file event.hpp.

◆ Return

const Event Return = Event::Special({10})

static

Definition at line 51 of file event.hpp.

◆ Escape

const Event Escape = Event::Special("\x1B")

static

Definition at line 52 of file event.hpp.

◆ Tab

const Event Tab = Event::Special({9})

static

Definition at line 53 of file event.hpp.

◆ TabReverse

const Event TabReverse = Event::Special({27, 91, 90})

static

Definition at line 54 of file event.hpp.

◆ Insert

const Event Insert = Event::Special("\x1B[2~")

static

Definition at line 57 of file event.hpp.

◆ Home

const Event Home = Event::Special({27, 91, 72})

static

Definition at line 58 of file event.hpp.

◆ End

const Event End = Event::Special({27, 91, 70})

static

Definition at line 59 of file event.hpp.

◆ PageUp

const Event PageUp = Event::Special({27, 91, 53, 126})

static

Definition at line 60 of file event.hpp.

◆ PageDown

const Event PageDown = Event::Special({27, 91, 54, 126})

static

Definition at line 61 of file event.hpp.