AceSegment  0.8.2
A framework for rendering seven segment LED displays using the TM1637, MAX7219, HT16K33, or 74HC595 controller chips
Public Member Functions | List of all members
ace_segment::StringScroller< T_LED_MODULE > Class Template Reference

Class that scrolls a string left or right. More...

#include <StringScroller.h>

Public Member Functions

 StringScroller (CharWriter< T_LED_MODULE > &charWriter)
 Constructor.
 
T_LED_MODULE & ledModule ()
 Get the underlying LedModule.
 
PatternWriter< T_LED_MODULE > & patternWriter ()
 Get the underlying PatternWriter.
 
CharWriter< T_LED_MODULE > & charWriter ()
 Get the underlying LedModule.
 
uint8_t getNumDigits () const
 Return the number of digits supported by this display instance.
 
void initScrollLeft (const char *s)
 Set scroll string, clear the display, and prepare to scroll left.
 
void initScrollLeft (const __FlashStringHelper *fs)
 Set scroll string, clear the display, and prepare to scroll left.
 
bool scrollLeft ()
 Scroll one position left. More...
 
void initScrollRight (const char *s)
 Set scroll string, clear the display, and prepare to scroll right.
 
void initScrollRight (const __FlashStringHelper *fs)
 Set scroll string, clear the display, and prepare to scroll right.
 
bool scrollRight ()
 Scroll one position left. More...
 

Detailed Description

template<typename T_LED_MODULE>
class ace_segment::StringScroller< T_LED_MODULE >

Class that scrolls a string left or right.

Template Parameters
T_LED_MODULEthe class of the underlying LED Module, often LedModule but other classes with the same generic public methods can be substituted

Definition at line 43 of file StringScroller.h.

Member Function Documentation

◆ scrollLeft()

template<typename T_LED_MODULE >
bool ace_segment::StringScroller< T_LED_MODULE >::scrollLeft ( )
inline

Scroll one position left.

Return true when the scrolling is done and the display is cleared

Definition at line 86 of file StringScroller.h.

◆ scrollRight()

template<typename T_LED_MODULE >
bool ace_segment::StringScroller< T_LED_MODULE >::scrollRight ( )
inline

Scroll one position left.

Return true when the scrolling is done and the display is cleared

Definition at line 117 of file StringScroller.h.


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