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

A passive, transient message outside the normal flow: non-modal, dims nothing, and never takes keyboard focus. Auto-dismisses after a backend-chosen interval. More...

#include <backend.hpp>

Inheritance diagram for morph::ui::ToastWidget:
morph::ui::Widget morph::ui::testing::detail::FakeLeaf< ToastWidget > morph::ui::testing::detail::FakeToast

Public Member Functions

virtual void show (std::string_view text, Tone tone)=0
 Shows the message, replacing any shown or dismissing, and (re)starts the dismissal interval regardless of whether the toast is already on-screen — a second call while one is showing replaces its text and tone and restarts the interval, rather than being a no-op or stacking a second message.
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 passive, transient message outside the normal flow: non-modal, dims nothing, and never takes keyboard focus. Auto-dismisses after a backend-chosen interval.

Definition at line 615 of file backend.hpp.

Member Function Documentation

◆ show()

virtual void morph::ui::ToastWidget::show ( std::string_view text,
Tone tone )
pure virtual

Shows the message, replacing any shown or dismissing, and (re)starts the dismissal interval regardless of whether the toast is already on-screen — a second call while one is showing replaces its text and tone and restarts the interval, rather than being a no-op or stacking a second message.

Parameters
textThe message, UTF-8.
toneThe tone, mapped to the backend's theme.

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


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