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

Top app bar: a title plus optional leading/trailing icon widgets (typically IconButton). More...

#include <AppBar.h>

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

Public Member Functions

 AppBar ()=default
 
 AppBar (Bounds bounds, const char *title)
 
void setTitle (const char *title)
 
void setColorOverride (RGB_T background, RGB_T foreground)
 
void clearColorOverride ()
 
Bounds leadingRect () const
 Suggested square icon slot at the bar's left edge.
 
Bounds trailingRect () const
 Suggested square icon slot at the bar's right edge.
 
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

Widget< RGB_T > * leading = nullptr
 
Widget< RGB_T > * trailing = nullptr
 
- 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::AppBar< RGB_T >

Top app bar: a title plus optional leading/trailing icon widgets (typically IconButton).

leading/trailing are children AppBar forwards draw()/update()/ onGesture() to internally - do not also add them to Screen directly, or they'd be hit-tested twice. Position them with leadingRect()/ trailingRect() before attaching.

Constructor & Destructor Documentation

◆ AppBar() [1/2]

AppBar ( )
default

◆ AppBar() [2/2]

AppBar ( Bounds  bounds,
const char *  title 
)
inline

Member Function Documentation

◆ clearColorOverride()

void clearColorOverride ( )
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 >.

◆ leadingRect()

Bounds leadingRect ( ) const
inline

Suggested square icon slot at the bar's left edge.

◆ onGesture()

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

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

Reimplemented from Widget< RGB_T >.

◆ setColorOverride()

void setColorOverride ( RGB_T  background,
RGB_T  foreground 
)
inline

Overrides the theme's surface/onSurface colors for this bar only - e.g. a blue title bar while the rest of the screen stays on the default theme. Call clearColorOverride() to go back to theme.colors.surface.

◆ setTitle()

void setTitle ( const char *  title)
inline

◆ trailingRect()

Bounds trailingRect ( ) const
inline

Suggested square icon slot at the bar's right edge.

◆ 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

◆ leading

Widget<RGB_T>* leading = nullptr

◆ trailing

Widget<RGB_T>* trailing = nullptr

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