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

Small floating label, shown briefly above an anchor widget. More...

#include <Tooltip.h>

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

Public Member Functions

 Tooltip ()
 
void showFor (Bounds anchor, const char *text, uint32_t durationMs=1500)
 Shows text centered just above anchor for durationMs.
 
void hide ()
 
void draw (tinygpu::ISurface< RGB_T > &target) override
 
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.
 

Additional Inherited Members

- Public Attributes inherited from Widget< RGB_T >
Bounds bounds
 
bool visible = true
 
bool enabled = true
 
- 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::Tooltip< RGB_T >

Small floating label, shown briefly above an anchor widget.

Not driven by hover (this library targets touchscreens, not pointers) - call showFor(anchorBounds, text) yourself, typically from a long-press gesture on the widget it explains, and it hides itself automatically after its duration via update(). Add once with Screen::addFixedWidget() (last, so it draws on top); starts invisible so it costs nothing while idle.

Constructor & Destructor Documentation

◆ Tooltip()

Tooltip ( )
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 >.

◆ hide()

void hide ( )
inline

◆ showFor()

void showFor ( Bounds  anchor,
const char *  text,
uint32_t  durationMs = 1500 
)
inline

Shows text centered just above anchor for durationMs.

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


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