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

Tappable row: optional leading icon + title, with a selected state. More...

#include <ListItem.h>

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

Public Member Functions

 ListItem ()=default
 
 ListItem (Bounds bounds, const char *title, IconPainter< RGB_T > icon=nullptr)
 
void setTitle (const char *title)
 
void setIcon (IconPainter< RGB_T > icon)
 
bool selected () const
 
void setSelected (bool selected)
 
void setTypographyRole (TypographyRole role)
 
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.
 
- 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()> onClick
 
- 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::ListItem< RGB_T >

Tappable row: optional leading icon + title, with a selected state.

The building block for Drawer (Drawer.h), but usable standalone for any settings-style list. Selected items draw as a filled pill (Material's navigation-drawer look); unselected items are flat.

Constructor & Destructor Documentation

◆ ListItem() [1/2]

ListItem ( )
default

◆ ListItem() [2/2]

ListItem ( Bounds  bounds,
const char *  title,
IconPainter< RGB_T >  icon = nullptr 
)
inline

Member Function Documentation

◆ 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 >.

◆ selected()

bool selected ( ) const
inline

◆ setIcon()

void setIcon ( IconPainter< RGB_T >  icon)
inline

◆ setSelected()

void setSelected ( bool  selected)
inline

◆ setTitle()

void setTitle ( const char *  title)
inline

◆ setTypographyRole()

void setTypographyRole ( TypographyRole  role)
inline

Text size - kBody (the default, matching this row's original fixed size) down to kLabel for a denser list (e.g. a navigation drawer with several rows that don't need to be as prominent as body text).

Member Data Documentation

◆ onClick

std::function<void()> onClick

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