cTextScroller Class Reference

#include <osd.h>

Public Member Functions
	cTextScroller (void)
	cTextScroller (cOsd *Osd, int Left, int Top, int Width, int Height, const char *Text, const cFont *Font, tColor ColorFg, tColor ColorBg)
void	Set (cOsd *Osd, int Left, int Top, int Width, int Height, const char *Text, const cFont *Font, tColor ColorFg, tColor ColorBg)
void	Reset (void)
int	Left (void)
int	Top (void)
int	Width (void)
int	Height (void)
int	Total (void)
int	Offset (void)
int	Shown (void)
bool	CanScroll (void)
bool	CanScrollUp (void)
bool	CanScrollDown (void)
void	Scroll (bool Up, bool Page)

Private Member Functions
void	DrawText (void)

Private Attributes
cOsd *	osd
int	left
int	top
int	width
int	height
const cFont *	font
tColor	colorFg
tColor	colorBg
int	offset
int	shown
cTextWrapper	textWrapper

Detailed Description

Definition at line 1034 of file osd.h.

Constructor & Destructor Documentation

cTextScroller() [1/2]

cTextScroller::cTextScroller

(

void

)

Definition at line 2330 of file osd.c.

References colorBg, colorFg, font, height, left, offset, osd, shown, top, and width.

cTextScroller() [2/2]

cTextScroller::cTextScroller	(	cOsd *	Osd,
		int	Left,
		int	Top,
		int	Width,
		int	Height,
		const char *	Text,
		const cFont *	Font,
		tColor	ColorFg,
		tColor	ColorBg )

Definition at line 2341 of file osd.c.

References Font, Height(), Left(), Set(), Top(), and Width().

Member Function Documentation

CanScroll()

bool cTextScroller::CanScroll ( void )

inline

Definition at line 1055 of file osd.h.

References CanScrollDown(), and CanScrollUp().

CanScrollDown()

bool cTextScroller::CanScrollDown ( void )

inline

Definition at line 1057 of file osd.h.

References offset, shown, and Total().

Referenced by CanScroll(), and Scroll().

CanScrollUp()

bool cTextScroller::CanScrollUp ( void )

inline

Definition at line 1056 of file osd.h.

References offset.

Referenced by CanScroll(), and Scroll().

DrawText()

void cTextScroller::DrawText ( void )

private

Definition at line 2368 of file osd.c.

References colorBg, colorFg, font, left, offset, osd, shown, textWrapper, top, and width.

Referenced by Scroll(), and Set().

Height()

int cTextScroller::Height ( void )

inline

Definition at line 1051 of file osd.h.

References height.

Referenced by cTextScroller(), Set(), cSkinClassicDisplayMenu::SetEvent(), cSkinCursesDisplayMenu::SetEvent(), cSkinLCARSDisplayMenu::SetEvent(), cSkinSTTNGDisplayMenu::SetEvent(), cSkinClassicDisplayMenu::SetRecording(), cSkinCursesDisplayMenu::SetRecording(), cSkinLCARSDisplayMenu::SetRecording(), and cSkinSTTNGDisplayMenu::SetRecording().

Left()

int cTextScroller::Left ( void )

inline

Definition at line 1048 of file osd.h.

References left.

Referenced by cTextScroller(), and Set().

Offset()

int cTextScroller::Offset ( void )

inline

Definition at line 1053 of file osd.h.

References offset.

Reset()

void cTextScroller::Reset

(

void

)

Definition at line 2363 of file osd.c.

References osd.

Scroll()

void cTextScroller::Scroll	(	bool	Up,
		bool	Page )

Definition at line 2376 of file osd.c.

References CanScrollDown(), CanScrollUp(), DrawText(), offset, shown, and Total().

Set()

void cTextScroller::Set	(	cOsd *	Osd,
		int	Left,
		int	Top,
		int	Width,
		int	Height,
		const char *	Text,
		const cFont *	Font,
		tColor	ColorFg,
		tColor	ColorBg )

Definition at line 2346 of file osd.c.

References colorBg, colorFg, DrawText(), Font, font, Height(), height, Left(), left, min(), offset, osd, shown, textWrapper, Top(), top, Total(), Width(), and width.

Referenced by cTextScroller(), cSkinClassicDisplayMenu::SetEvent(), cSkinCursesDisplayMenu::SetEvent(), cSkinLCARSDisplayMenu::SetEvent(), cSkinSTTNGDisplayMenu::SetEvent(), cSkinClassicDisplayMenu::SetRecording(), cSkinCursesDisplayMenu::SetRecording(), cSkinLCARSDisplayMenu::SetRecording(), and cSkinSTTNGDisplayMenu::SetRecording().

Shown()

int cTextScroller::Shown ( void )

inline

Definition at line 1054 of file osd.h.

References shown.

Top()

int cTextScroller::Top ( void )

inline

Definition at line 1049 of file osd.h.

References top.

Referenced by cTextScroller(), and Set().

Total()

int cTextScroller::Total ( void )

inline

Definition at line 1052 of file osd.h.

References textWrapper.

Referenced by CanScrollDown(), Scroll(), and Set().

Width()

int cTextScroller::Width ( void )

inline

Definition at line 1050 of file osd.h.

References width.

Referenced by cTextScroller(), and Set().

Member Data Documentation

colorBg

tColor cTextScroller::colorBg

private

Definition at line 1039 of file osd.h.

Referenced by cTextScroller(), DrawText(), and Set().

colorFg

tColor cTextScroller::colorFg

private

Definition at line 1039 of file osd.h.

Referenced by cTextScroller(), DrawText(), and Set().

font

const cFont* cTextScroller::font

private

Definition at line 1038 of file osd.h.

Referenced by cTextScroller(), DrawText(), and Set().

height

int cTextScroller::height

private

Definition at line 1037 of file osd.h.

Referenced by cTextScroller(), Height(), and Set().

left

int cTextScroller::left

private

Definition at line 1037 of file osd.h.

Referenced by cTextScroller(), DrawText(), Left(), and Set().

offset

int cTextScroller::offset

private

Definition at line 1040 of file osd.h.

Referenced by CanScrollDown(), CanScrollUp(), cTextScroller(), DrawText(), Offset(), Scroll(), and Set().

osd

cOsd* cTextScroller::osd

private

Definition at line 1036 of file osd.h.

Referenced by cTextScroller(), DrawText(), Reset(), and Set().

shown

int cTextScroller::shown

private

Definition at line 1040 of file osd.h.

Referenced by CanScrollDown(), cTextScroller(), DrawText(), Scroll(), Set(), and Shown().

textWrapper

cTextWrapper cTextScroller::textWrapper

private

Definition at line 1041 of file osd.h.

Referenced by DrawText(), Set(), and Total().

top

int cTextScroller::top

private

Definition at line 1037 of file osd.h.

Referenced by cTextScroller(), DrawText(), Set(), and Top().

width

int cTextScroller::width

private

Definition at line 1037 of file osd.h.

Referenced by cTextScroller(), DrawText(), Set(), and Width().

---

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

• osd.h
• osd.c