morph 0.1.0
Asynchronous bridge between GUI thread and business models
Loading...
Searching...
No Matches
morph::ui::DateTimeInputWidget Class Referenceabstract

A date or date-and-time field, in the mode and display zone fixed at creation. More...

#include <backend.hpp>

Inheritance diagram for morph::ui::DateTimeInputWidget:
morph::ui::FieldWidget morph::ui::Widget morph::ui::testing::detail::FakeLeaf< DateTimeInputWidget > morph::ui::testing::detail::FakeField< DateTimeInputWidget > morph::ui::testing::detail::FakeDateTimeInput

Public Member Functions

virtual void setValue (std::optional< morph::time::Timestamp > const &value)=0
 Shows an instant. Never calls the onChange handler.
virtual void setOnChange (std::function< void(std::optional< morph::time::Timestamp >)> onChange)=0
 Sets what a user edit calls, with the instant entered or nullopt for a cleared field.
virtual void setCaption (std::string_view label, bool shown)=0
 Sets the field's label, and whether the input draws it as a visible caption above its control. Without shown, the caption is drawn elsewhere (a form's cell), or not at all.
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 date or date-and-time field, in the mode and display zone fixed at creation.

Definition at line 533 of file backend.hpp.

Member Function Documentation

◆ setValue()

virtual void morph::ui::DateTimeInputWidget::setValue ( std::optional< morph::time::Timestamp > const & value)
pure virtual

Shows an instant. Never calls the onChange handler.

Parameters
valueThe instant; nullopt or an empty Timestamp shows an empty field.

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

◆ setOnChange()

virtual void morph::ui::DateTimeInputWidget::setOnChange ( std::function< void(std::optional< morph::time::Timestamp >)> onChange)
pure virtual

Sets what a user edit calls, with the instant entered or nullopt for a cleared field.

Parameters
onChangeThe handler; empty does nothing.

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

◆ setCaption()

virtual void morph::ui::DateTimeInputWidget::setCaption ( std::string_view label,
bool shown )
pure virtual

Sets the field's label, and whether the input draws it as a visible caption above its control. Without shown, the caption is drawn elsewhere (a form's cell), or not at all.

Parameters
labelThe label, UTF-8.
shownWhether the input shows it.

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


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