FTXUI/include/ftxui/component/event.hpp

111 lines
3.0 KiB
C++
Raw Normal View History

#ifndef FTXUI_COMPONENT_EVENT_HPP
#define FTXUI_COMPONENT_EVENT_HPP
2018-10-19 04:58:38 +08:00
2021-05-02 02:40:35 +08:00
#include <ftxui/component/mouse.hpp> // for Mouse
#include <string> // for string, operator==
2019-06-30 16:11:37 +08:00
#include <vector>
2018-10-19 04:58:38 +08:00
namespace ftxui {
2018-10-19 04:58:38 +08:00
class ScreenInteractive;
2021-05-10 02:32:27 +08:00
class ComponentBase;
2020-08-16 08:24:50 +08:00
/// @brief 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
struct Event {
// --- Constructor section ---------------------------------------------------
static Event Character(char);
static Event Character(wchar_t);
2021-04-19 00:32:38 +08:00
static Event Character(std::string);
static Event Special(std::string);
2021-04-25 21:22:38 +08:00
static Event Mouse(std::string, Mouse mouse);
static Event CursorReporting(std::string, int x, int y);
2018-10-19 04:58:38 +08:00
// --- Arrow ---
2020-10-24 22:47:03 +08:00
static const Event ArrowLeft;
static const Event ArrowRight;
static const Event ArrowUp;
static const Event ArrowDown;
2018-10-19 04:58:38 +08:00
// --- Other ---
2020-10-24 22:47:03 +08:00
static const Event Backspace;
static const Event Delete;
static const Event Return;
static const Event Escape;
static const Event Tab;
static const Event TabReverse;
static const Event F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12;
2018-10-19 04:58:38 +08:00
static const Event Home;
static const Event End;
static const Event PageUp;
static const Event PageDown;
2019-01-27 09:33:06 +08:00
// --- Custom ---
static Event Custom;
//--- Method section ---------------------------------------------------------
2021-05-02 02:40:35 +08:00
bool is_character() const { return type_ == Type::Character; }
2020-10-24 22:47:03 +08:00
wchar_t character() const { return character_; }
2021-04-19 00:32:38 +08:00
2021-04-25 21:22:38 +08:00
bool is_mouse() const { return type_ == Type::Mouse; }
struct Mouse& mouse() {
return mouse_;
}
bool is_cursor_reporting() const { return type_ == Type::CursorReporting; }
2021-04-25 21:22:38 +08:00
int cursor_x() const { return cursor_.x; }
int cursor_y() const { return cursor_.y; }
2021-04-19 00:32:38 +08:00
2020-10-24 22:47:03 +08:00
const std::string& input() const { return input_; }
2018-10-19 04:58:38 +08:00
2020-10-24 22:47:03 +08:00
bool operator==(const Event& other) const { return input_ == other.input_; }
bool operator!=(const Event& other) const { return !operator==(other); }
2018-10-19 04:58:38 +08:00
//--- State section ----------------------------------------------------------
private:
2021-05-10 02:32:27 +08:00
friend ComponentBase;
2021-05-02 02:40:35 +08:00
friend ScreenInteractive;
2021-04-19 00:32:38 +08:00
enum class Type {
Unknown,
Character,
2021-04-25 21:22:38 +08:00
Mouse,
CursorReporting,
2021-04-19 00:32:38 +08:00
};
2021-04-25 21:22:38 +08:00
Type type_ = Type::Unknown;
2021-04-19 00:32:38 +08:00
2021-04-25 21:22:38 +08:00
struct Cursor {
2021-04-19 00:32:38 +08:00
int x;
int y;
};
union {
wchar_t character_ = U'?';
2021-04-25 21:22:38 +08:00
struct Mouse mouse_;
struct Cursor cursor_;
2021-04-19 00:32:38 +08:00
};
std::string input_;
2021-05-02 02:40:35 +08:00
ScreenInteractive* screen_ = nullptr;
};
2018-10-19 04:58:38 +08:00
} // namespace ftxui
2018-10-19 04:58:38 +08:00
#endif /* end of include guard: FTXUI_COMPONENT_EVENT_HPP */
// Copyright 2020 Arthur Sonzogni. All rights reserved.
// Use of this source code is governed by the MIT license that can be found in
// the LICENSE file.