morph::ui::FieldWidget Class Reference

A widget that shows a value: text, or an input. A new field is editable, not required, without errors and not stale. More...

#include <backend.hpp>

Inheritance diagram for morph::ui::FieldWidget:

Public Member Functions
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 widget that shows a value: text, or an input. A new field is editable, not required, without errors and not stale.

Definition at line 116 of file backend.hpp.

Member Function Documentation

setReadOnly()

virtual void morph::ui::FieldWidget::setReadOnly ( bool readonly )

pure virtual

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.

Parameters

readonly

Whether the user may not change the value.

Implemented in morph::ui::testing::detail::FakeField< CheckboxWidget >, morph::ui::testing::detail::FakeField< DateTimeInputWidget >, morph::ui::testing::detail::FakeField< FilePickerWidget >, morph::ui::testing::detail::FakeField< SelectWidget >, morph::ui::testing::detail::FakeField< SliderWidget >, morph::ui::testing::detail::FakeField< TextInputWidget >, and morph::ui::testing::detail::FakeField< TextWidget >.

setRequired()

virtual void morph::ui::FieldWidget::setRequired ( bool required )

pure virtual

Shows or clears the mark of a field that must be given.

Parameters

required

Whether to show the mark.

Implemented in morph::ui::testing::detail::FakeField< CheckboxWidget >, morph::ui::testing::detail::FakeField< DateTimeInputWidget >, morph::ui::testing::detail::FakeField< FilePickerWidget >, morph::ui::testing::detail::FakeField< SelectWidget >, morph::ui::testing::detail::FakeField< SliderWidget >, morph::ui::testing::detail::FakeField< TextInputWidget >, and morph::ui::testing::detail::FakeField< TextWidget >.

setErrors()

virtual void morph::ui::FieldWidget::setErrors ( std::vector< std::string > const & errors )

pure virtual

Replaces the messages shown with the field.

Parameters

errors

The messages, in order, UTF-8; empty shows none.

Implemented in morph::ui::testing::detail::FakeField< CheckboxWidget >, morph::ui::testing::detail::FakeField< DateTimeInputWidget >, morph::ui::testing::detail::FakeField< FilePickerWidget >, morph::ui::testing::detail::FakeField< SelectWidget >, morph::ui::testing::detail::FakeField< SliderWidget >, morph::ui::testing::detail::FakeField< TextInputWidget >, and morph::ui::testing::detail::FakeField< TextWidget >.

setStale()

virtual void morph::ui::FieldWidget::setStale ( bool stale )

pure virtual

Shows or clears the mark of a value that is being recomputed.

Parameters

stale

Whether the value shown is the last known one.

Implemented in morph::ui::testing::detail::FakeField< CheckboxWidget >, morph::ui::testing::detail::FakeField< DateTimeInputWidget >, morph::ui::testing::detail::FakeField< FilePickerWidget >, morph::ui::testing::detail::FakeField< SelectWidget >, morph::ui::testing::detail::FakeField< SliderWidget >, morph::ui::testing::detail::FakeField< TextInputWidget >, and morph::ui::testing::detail::FakeField< TextWidget >.

---

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

• morph/ui/backend.hpp