morph::ui::CheckboxWidget Class Reference

A labelled check box. More...

#include <backend.hpp>

Inheritance diagram for morph::ui::CheckboxWidget:

Public Member Functions
virtual void	setLabel (std::string_view label)=0
	Replaces the caption.
virtual void	setChecked (bool checked)=0
	Sets the state. Never calls the onToggle handler.
virtual void	setOnToggle (std::function< void(bool)> onToggle)=0
	Sets what a user toggle calls, with the new state.
Public Member Functions inherited from morph::ui::FieldWidget
virtual void	setReadOnly (bool readonly)=0
	Makes the value read-only or editable again. A read-only field still takes focus and lets its text be selected, and reports no edit, submit or commit.
virtual void	setRequired (bool required)=0
	Shows or clears the mark of a field that must be given.
virtual void	setErrors (std::vector< std::string > const &errors)=0
	Replaces the messages shown with the field.
virtual void	setStale (bool stale)=0
	Shows or clears the mark of a value that is being recomputed.
Public Member Functions inherited from morph::ui::Widget
	Widget (Widget const &)=delete
Widget &	operator= (Widget const &)=delete
	Widget (Widget &&)=delete
Widget &	operator= (Widget &&)=delete
virtual void	setVisible (bool visible)=0
	Shows or hides the widget and everything inside it.
virtual void	setEnabled (bool enabled)=0
	Enables or disables input on the widget and everything inside it.
virtual void	setLayout (LayoutHints const &hints)=0
	Sets the size request.
virtual void	setDragKey (std::optional< Key > const &key)=0
	Makes the widget draggable, carrying key, or not draggable.
virtual void	setDropHandler (std::function< bool(Key const &)> accepts, std::function< void(Key)> onDrop)=0
	Makes the widget a drop target.
virtual void	setAccessibleName (std::string_view name)=0
	Sets the name assistive technology reads for the widget.
virtual void	setAccessibleRole (std::string_view role)=0
	Sets the role assistive technology announces for the widget.
virtual void	setTestId (std::string_view testId)=0
	Sets the stable identifier an automated test finds the widget by.
virtual void	setTooltip (std::string_view text)=0
	Sets the text shown while the pointer rests on the widget.
virtual void	setSurface (std::string_view surface)=0
	Styles the widget and everything inside it with a named token set of the theme.
virtual void	setKeys (std::vector< std::string > const &chords, std::function< void(std::string)> onChord)=0
	Declares the keyboard chords the widget handles while focus is inside it.
virtual void	focus ()=0
	Moves keyboard focus to the widget.
virtual void	setOnHover (std::function< void()> onHover)
	Calls onHover each time the pointer comes to rest over the widget. A backend without a pointer, or one that does not report hovering, keeps the default, which never calls it: hovering is a hint, such as a prefetch, never something a widget relies on.

Detailed Description

A labelled check box.

Definition at line 226 of file backend.hpp.

Member Function Documentation

setLabel()

virtual void morph::ui::CheckboxWidget::setLabel ( std::string_view label )

pure virtual

Replaces the caption.

Parameters

label

The caption, UTF-8.

Implemented in morph::ui::testing::detail::FakeCheckbox.

setChecked()

virtual void morph::ui::CheckboxWidget::setChecked ( bool checked )

pure virtual

Sets the state. Never calls the onToggle handler.

Parameters

checked

Whether it is checked.

Implemented in morph::ui::testing::detail::FakeCheckbox.

setOnToggle()

virtual void morph::ui::CheckboxWidget::setOnToggle ( std::function< void(bool)> onToggle )

pure virtual

Sets what a user toggle calls, with the new state.

Parameters

onToggle

The handler; empty does nothing.

Implemented in morph::ui::testing::detail::FakeCheckbox.

---

The documentation for this class was generated from the following file:

• morph/ui/backend.hpp