mouse.hpp

Go to the documentation of this file.

// 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.
#ifndef FTXUI_COMPONENT_MOUSE_HPP
#define FTXUI_COMPONENT_MOUSE_HPP
 
#include <cstdint>
 
#include "ftxui/util/export.hpp"
 
namespace ftxui {
 
/// @brief A mouse event. It contains the coordinate of the mouse, the button
/// pressed and the modifier (shift, ctrl, meta).
/// @ingroup component
struct FTXUI_EXPORT(COMPONENT) Mouse {
  enum Button : uint8_t {
    Left = 0,
    Middle = 1,
    Right = 2,
    None = 3,
    WheelUp = 4,
    WheelDown = 5,
    WheelLeft = 6,   /// Supported terminal only.
    WheelRight = 7,  /// Supported terminal only.
  };
 
  enum Motion : uint8_t {
    Released = 0,
    Pressed = 1,
    Moved = 2,
  };
 
  // Button
  Button button = Button::None;
 
  // Motion
  Motion motion = Motion::Pressed;
 
  // Modifiers:
  bool shift = false;
  bool meta = false;
  bool control = false;
 
  // Coordinates:
  int x = 0;
  int y = 0;
};
 
}  // namespace ftxui
 
#endif /* end of include guard: FTXUI_COMPONENT_MOUSE_HPP */