Switch¶
A control providing the user with an on/off choice.
In contrast to Checkbox
, Switch
is commonly used in scenarios where the user's on or off choice takes effect immediately and does not require further confirmation.
Declaration¶
namespace bdn::ui {
class Switch : public View
}
Example¶
#include <bdn/ui/Switch.h>
// ...
auto switchControl = std::make_shared<Switch>();
switchControl->label = "A switch can also have a label!";
switchControl->on = true;
switchControl->onClick() += [](auto event) {
// Do something when the switch is turned off or on
};
Properties¶
-
Property<std::string> label
The switch's label.
-
Property<bool> on
Whether switch is on (
true
) or off (false
).
Events¶
-
Notifier<const ClickEvent &> &onClick()
A notifier for click events. Subscribe to this notifier if you want to be notified when the user clicks the switch.
Relationships¶
Inherits from View
.