Skip to main content

Checkbox

#include "toolkit/checkbox.hpp"

A labeled checkbox with two-state and optional tri-state (partial) modes. Inherits Widget. You can also set_enabled(false) to the widget, and it will not be clickable by the user, and drawed in gray (depending on palette and Style).

Checkbox screenshot

Example​

auto cb = std::make_unique<toolkit::Checkbox>("&Enable feature");
cb->on_toggle = [](bool checked) { /* ... */ };

Construction​

explicit Checkbox(std::string text);

API​

MemberDescription
checked() / set_checked(bool)Simple on/off state
check_state() / set_check_state(CheckState)Full state, including Partial
is_tri_state() / set_tri_state(bool)Enable the third, partially-checked state

CheckState is Unchecked \| Checked \| Partial (defined in types.hpp).

Callbacks​

CallbackDescription
on_toggle — std::function<void(bool)>Fired with the simplified checked/unchecked value
on_state_change — std::function<void(CheckState)>Fired with the full tri-state value