ncmpc  0.30
Public Member Functions
BasicMarquee Class Reference

#include <BasicMarquee.hxx>

Public Member Functions

 BasicMarquee (const char *_separator)
 
bool IsDefined () const
 
bool Set (unsigned width, const char *text)
 
void Clear ()
 
void Rewind ()
 
void Step ()
 
char * ScrollString () const
 

Detailed Description

This class is used to auto-scroll text which does not fit on the screen. Call hscroll_init() to initialize the object, hscroll_clear() to free resources, and hscroll_set() to begin scrolling.

Constructor & Destructor Documentation

◆ BasicMarquee()

BasicMarquee::BasicMarquee ( const char *  _separator)
inline

Member Function Documentation

◆ IsDefined()

bool BasicMarquee::IsDefined ( ) const
inline

◆ Set()

bool BasicMarquee::Set ( unsigned  width,
const char *  text 
)

Sets a text to scroll. Call Clear() to disable it.

Returns
false if nothing was changed

◆ Clear()

void BasicMarquee::Clear ( )

Removes the text. It may be reused with Set().

◆ Rewind()

void BasicMarquee::Rewind ( )
inline

◆ Step()

void BasicMarquee::Step ( )
inline

◆ ScrollString()

char* BasicMarquee::ScrollString ( ) const

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