Mirror/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2025-09-28 16:29:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add more documentation.

Browse Source
This commit is contained in:
ArthurSonzogni
2020-08-16 02:24:50 +02:00
committed by Arthur Sonzogni
parent f2dc080a35
commit 114ab4ae2a
33 changed files with 310 additions and 144 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
include/ftxui/component/checkbox.hpp
View File

@@ -7,27 +7,29 @@
namespace ftxui {
/// @brief A Checkbox. It can be checked or unchecked.Display an element on a ftxui::Screen.
/// @ingroup dom
class CheckBox : public Component {
public:
// Constructor.
CheckBox() = default;
~CheckBox() override = default;
bool state = false;
std::wstring label = L"label";
bool state = false; // The current state. true=checked, false:unchecked.
std::wstring label = L"label"; // The CheckBox label.
#if defined(_WIN32)
std::wstring checked = L"[X] ";
std::wstring unchecked = L"[ ] ";
std::wstring checked = L"[X] "; /// Prefix for a "checked" state.
std::wstring unchecked = L"[ ] "; /// Prefix for an "unchecked" state.
#else
std::wstring checked = L"▣ ";
std::wstring unchecked = L"☐ ";
std::wstring checked = L"▣ "; /// Prefix for a "checked" state.
std::wstring unchecked = L"☐ "; /// Prefix for a "unchecked" state.
#endif
Decorator focused_style = inverted;
Decorator unfocused_style = nothing;
Decorator focused_style = inverted; /// Decorator used when focused.
Decorator unfocused_style = nothing; /// Decorator used when unfocused.
// State update callback.
/// Called when the user change the state of the CheckBox.
std::function<void()> on_change = []() {};
// Component implementation.