TinyMaterialDesign
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Snackbar< RGB_T > Class Template Reference

Transient bottom message bar with an optional single text action. More...

#include <Snackbar.h>

Inheritance diagram for Snackbar< RGB_T >:
Inheritance graph
[legend]
Collaboration diagram for Snackbar< RGB_T >:
Collaboration graph
[legend]

Public Member Functions

 Snackbar ()
 
 Snackbar (Bounds bounds)
 
void show (const char *message, const char *actionLabel=nullptr, uint32_t durationMs=4000)
 
void dismiss ()
 
void draw (tinygpu::ISurface< RGB_T > &target) override
 
bool onGesture (const tinygpu::GestureEvent &event) override
 Handles one gesture event. Returns true if this widget consumed it.
 
bool update (uint32_t nowMs) override
 
- Public Member Functions inherited from Widget< RGB_T >
virtual ~Widget ()=default
 
virtual void setTheme (const MaterialTheme< RGB_T > &theme)
 
virtual void draw (tinygpu::ISurface< RGB_T > &target)=0
 
virtual bool onGesture (const tinygpu::GestureEvent &event)
 Handles one gesture event. Returns true if this widget consumed it.
 
virtual bool update (uint32_t nowMs)
 
virtual bool isDraggable () const
 
virtual bool isDraggableAt (int32_t x, int32_t y) const
 
virtual int childCount () const
 
virtual Widget< RGB_T > * child (int index)
 
virtual void drawBackground (tinygpu::ISurface< RGB_T > &target)
 
virtual void setThemeTint (RGB_T background, RGB_T foreground)
 
virtual bool isContainer () const
 Provides true if the widget is a container.
 

Public Attributes

std::function< void()> onAction
 Fired when the (optional) action text is tapped.
 
std::function< void()> onDismiss
 Fired when the snackbar hides itself, whether by timeout or dismiss().
 
- Public Attributes inherited from Widget< RGB_T >
Bounds bounds
 
bool visible = true
 
bool enabled = true
 

Additional Inherited Members

- Protected Member Functions inherited from Widget< RGB_T >
const MaterialTheme< RGB_T > & theme () const
 Convenience accessor for draw() overrides - see theme_.
 
- Protected Attributes inherited from Widget< RGB_T >
const MaterialTheme< RGB_T > * theme_ = nullptr
 

Detailed Description

template<typename RGB_T = TINYMD_DEFAULT_RGB_T>
class tinymd::Snackbar< RGB_T >

Transient bottom message bar with an optional single text action.

Not a modal - add it once with Screen::addFixedWidget() (last, so it draws on top) and drive its lifetime with show()/dismiss(); it hides itself automatically after its duration via update(), same mechanism a ripple fade uses. visible stays false until show() is called, so it costs nothing extra when idle - Screen already skips invisible widgets.

Constructor & Destructor Documentation

◆ Snackbar() [1/2]

Snackbar ( )
inline

◆ Snackbar() [2/2]

Snackbar ( Bounds  bounds)
inlineexplicit

Member Function Documentation

◆ dismiss()

void dismiss ( )
inline

◆ draw()

void draw ( tinygpu::ISurface< RGB_T > &  target)
inlineoverridevirtual

Renders the widget into target using colors/fonts/tokens from its own theme (see theme()/setTheme()).

Implements Widget< RGB_T >.

◆ onGesture()

bool onGesture ( const tinygpu::GestureEvent &  event)
inlineoverridevirtual

Handles one gesture event. Returns true if this widget consumed it.

Reimplemented from Widget< RGB_T >.

◆ show()

void show ( const char *  message,
const char *  actionLabel = nullptr,
uint32_t  durationMs = 4000 
)
inline

Shows the bar with message (and optional actionLabel) for durationMs (default 4s, matching M3 guidance).

◆ update()

bool update ( uint32_t  nowMs)
inlineoverridevirtual

Called once per frame, before draw(), to advance any time-based animation (ripple fade, indeterminate progress sweep, ...). Returns true if that advance changed anything this widget will draw differently, so Screen can decide whether a redraw is actually needed - see Screen::isDirty(). Default: no-op, not dirty, so widgets that don't animate cost nothing extra.

Reimplemented from Widget< RGB_T >.

Member Data Documentation

◆ onAction

std::function<void()> onAction

Fired when the (optional) action text is tapped.

◆ onDismiss

std::function<void()> onDismiss

Fired when the snackbar hides itself, whether by timeout or dismiss().


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