amass/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2024-11-22 18:59:59 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix the doxygen documentation by moving comments at the right place (#768)

Browse Source
This commit is contained in:
benoitdudu 2023-10-19 22:58:02 +02:00 committed by GitHub
parent d4c9c5e226
commit f499d34f7e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
include/ftxui/component/component_options.hpp
View File

@ -22,10 +22,10 @@ namespace ftxui {
/// |Radiobox::transform|, |MenuEntryOption::transform|, /// |Radiobox::transform|, |MenuEntryOption::transform|,
/// |MenuOption::transform|. /// |MenuOption::transform|.
struct EntryState { struct EntryState {
std::string label; /// < The label to display. std::string label; ///< The label to display.
bool state; /// < The state of the button/checkbox/radiobox bool state; ///< The state of the button/checkbox/radiobox
bool active; /// < Whether the entry is the active one. bool active; ///< Whether the entry is the active one.
bool focused; /// < Whether the entry is one focused by the user. bool focused; ///< Whether the entry is one focused by the user.
}; };
struct UnderlineOption { struct UnderlineOption {
@ -151,10 +151,10 @@ struct CheckboxOption {
/// @brief Used to define style for the Input component. /// @brief Used to define style for the Input component.
struct InputState { struct InputState {
Element element; Element element;
bool hovered; /// < Whether the input is hovered by the mouse. bool hovered; ///< Whether the input is hovered by the mouse.
bool focused; /// < Whether the input is focused by the user. bool focused; ///< Whether the input is focused by the user.
bool is_placeholder; /// < Whether the input is empty and displaying the bool is_placeholder; ///< Whether the input is empty and displaying the
/// < placeholder. ///< placeholder.
}; };
/// @brief Option for the Input component. /// @brief Option for the Input component.
@ -175,9 +175,9 @@ struct InputOption {
// Style: // Style:
std::function<Element(InputState)> transform; std::function<Element(InputState)> transform;
Ref<bool> password = false; /// < Obscure the input content using '*'. Ref<bool> password = false; ///< Obscure the input content using '*'.
Ref<bool> multiline = true; /// < Whether the input can be multiline. Ref<bool> multiline = true; ///< Whether the input can be multiline.
Ref<bool> insert = true; /// < Insert or overtype character mode. Ref<bool> insert = true; ///< Insert or overtype character mode.
/// Called when the content changes. /// Called when the content changes.
std::function<void()> on_change = [] {}; std::function<void()> on_change = [] {};
@ -232,32 +232,32 @@ struct SliderOption {
// Parameter pack used by `WindowOptions::render`. // Parameter pack used by `WindowOptions::render`.
struct WindowRenderState { struct WindowRenderState {
Element inner; /// < The element wrapped inside this window. Element inner; ///< The element wrapped inside this window.
const std::string& title; /// < The title of the window. const std::string& title; ///< The title of the window.
bool active = false; /// < Whether the window is the active one. bool active = false; ///< Whether the window is the active one.
bool drag = false; /// < Whether the window is being dragged. bool drag = false; ///< Whether the window is being dragged.
bool resize = false; /// < Whether the window is being resized. bool resize = false; ///< Whether the window is being resized.
bool hover_left = false; /// < Whether the resizeable left side is hovered. bool hover_left = false; ///< Whether the resizeable left side is hovered.
bool hover_right = false; /// < Whether the resizeable right side is hovered. bool hover_right = false; ///< Whether the resizeable right side is hovered.
bool hover_top = false; /// < Whether the resizeable top side is hovered. bool hover_top = false; ///< Whether the resizeable top side is hovered.
bool hover_down = false; /// < Whether the resizeable down side is hovered. bool hover_down = false; ///< Whether the resizeable down side is hovered.
}; };
// @brief Option for the `Window` component. // @brief Option for the `Window` component.
// @ingroup component // @ingroup component
struct WindowOptions { struct WindowOptions {
Component inner; /// < The component wrapped by this window. Component inner; ///< The component wrapped by this window.
ConstStringRef title = ""; /// < The title displayed by this window. ConstStringRef title = ""; ///< The title displayed by this window.
Ref<int> left = 0; /// < The left side position of the window. Ref<int> left = 0; ///< The left side position of the window.
Ref<int> top = 0; /// < The top side position of the window. Ref<int> top = 0; ///< The top side position of the window.
Ref<int> width = 20; /// < The width of the window. Ref<int> width = 20; ///< The width of the window.
Ref<int> height = 10; /// < The height of the window. Ref<int> height = 10; ///< The height of the window.
Ref<bool> resize_left = true; /// < Can the left side be resized? Ref<bool> resize_left = true; ///< Can the left side be resized?
Ref<bool> resize_right = true; /// < Can the right side be resized? Ref<bool> resize_right = true; ///< Can the right side be resized?
Ref<bool> resize_top = true; /// < Can the top side be resized? Ref<bool> resize_top = true; ///< Can the top side be resized?
Ref<bool> resize_down = true; /// < Can the down side be resized? Ref<bool> resize_down = true; ///< Can the down side be resized?
/// An optional function to customize how the window looks like: /// An optional function to customize how the window looks like:
std::function<Element(const WindowRenderState&)> render; std::function<Element(const WindowRenderState&)> render;