component_options.hpp

Go to the documentation of this file.

#ifndef FTXUI_COMPONENT_COMPONENT_OPTIONS_HPP
#define FTXUI_COMPONENT_COMPONENT_OPTIONS_HPP
 
#include <ftxui/dom/elements.hpp>
#include <ftxui/util/ref.hpp>
 
namespace ftxui {
 
/// @brief Option for the Menu component.
/// @ingroup component
struct MenuOption {
  Decorator style_normal = nothing;    ///< style.
  Decorator style_focused = inverted;  ///< Style when focused.
  Decorator style_selected = bold;     ///< Style when selected.
  Decorator style_selected_focused =
      Decorator(inverted) | bold;  ///< Style when selected and focused.
 
  /// Called when the selected entry changes.
  std::function<void()> on_change = [] {};
  /// Called when the user presses enter.
  std::function<void()> on_enter = [] {};
 
  Ref<int> focused_entry = 0;
};
 
/// @brief Option for the MenuEntry component.
/// @ingroup component
struct MenuEntryOption {
  Decorator style_normal = nothing;    ///< style.
  Decorator style_focused = inverted;  ///< Style when focused.
  Decorator style_selected = bold;     ///< Style when selected.
  Decorator style_selected_focused =
      Decorator(inverted) | bold;  ///< Style when selected and focused.
};
 
/// @brief Option for the Button component.
/// @ingroup component
struct ButtonOption {
  /// Whether to show a border around the button.
  bool border = true;
};
 
/// @brief Option for the Checkbox component.
/// @ingroup component
struct CheckboxOption {
  std::string style_checked = "▣ ";     ///< Prefix for a "checked" state.
  std::string style_unchecked = "☐ ";   ///< Prefix for a "unchecked" state.
  Decorator style_normal = nothing;     ///< style.
  Decorator style_focused = inverted;   ///< Style when focused.
  Decorator style_selected = bold;      ///< Style when selected.
  Decorator style_selected_focused =
      Decorator(inverted) | bold;  ///< Style when selected and focused.
 
  /// Called when the user change the state.
  std::function<void()> on_change = []() {};
};
 
/// @brief Option for the Input component.
/// @ingroup component
struct InputOption {
  /// Called when the content changes.
  std::function<void()> on_change = [] {};
  /// Called when the user presses enter.
  std::function<void()> on_enter = [] {};
 
  /// Obscure the input content using '*'.
  Ref<bool> password = false;
 
  /// When set different from -1, this attributes is used to store the cursor
  /// position.
  Ref<int> cursor_position = -1;
};
 
/// @brief Option for the Radiobox component.
/// @ingroup component
struct RadioboxOption {
  std::string style_checked = "◉ ";     ///< Prefix for a "checked" state.
  std::string style_unchecked = "○ ";   ///< Prefix for a "unchecked" state.
  Decorator style_normal = nothing;    ///< style.
  Decorator style_focused = inverted;  ///< Style when focused.
  Decorator style_selected = bold;     ///< Style when selected.
  Decorator style_selected_focused =
      Decorator(inverted) | bold;  ///< Style when selected and focused.
 
  /// Called when the selected entry changes.
  std::function<void()> on_change = []() {};
 
  Ref<int> focused_entry = 0;
};
 
/// @brief Option for the Toggle component.
/// @ingroup component
struct ToggleOption {
  Decorator style_normal = nothing;    ///< style.
  Decorator style_focused = inverted;  ///< Style when focused.
  Decorator style_selected = bold;     ///< Style when selected.
  Decorator style_selected_focused =
      Decorator(inverted) | bold;  ///< Style when selected and focused.
 
  /// Called when the selected entry changes.
  std::function<void()> on_change = [] {};
  /// Called when the user presses enter.
  std::function<void()> on_enter = [] {};
 
  Ref<int> focused_entry = 0;
};
 
}  // namespace ftxui
 
#endif /* end of include guard: FTXUI_COMPONENT_COMPONENT_OPTIONS_HPP */
 
// Copyright 2021 Arthur Sonzogni. All rights reserved.
// Use of this source code is governed by the MIT license that can be found in
// the LICENSE file.