cTextScroller Class Reference

#include <osd.h>

List of all members.

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)

---

Detailed Description

Definition at line 399 of file osd.h.

---

Constructor & Destructor Documentation

cTextScroller::cTextScroller

(

void

)

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

---

Member Function Documentation

bool cTextScroller::CanScroll

(

void

)

[inline]

Definition at line 420 of file osd.h.

References CanScrollDown(), and CanScrollUp().

{ return CanScrollUp() || CanScrollDown(); }

bool cTextScroller::CanScrollDown

(

void

)

[inline]

Definition at line 422 of file osd.h.

References Total().

Referenced by CanScroll().

{ return offset + shown < Total(); }

bool cTextScroller::CanScrollUp

(

void

)

[inline]

Definition at line 421 of file osd.h.

Referenced by CanScroll().

{ return offset > 0; }

int cTextScroller::Height

(

void

)

[inline]

Definition at line 416 of file osd.h.

{ return height; }

int cTextScroller::Left

(

void

)

[inline]

Definition at line 413 of file osd.h.

{ return left; }

int cTextScroller::Offset

(

void

)

[inline]

Definition at line 418 of file osd.h.

{ return offset; }

void cTextScroller::Reset

(

void

)

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

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

int cTextScroller::Shown

(

void

)

[inline]

Definition at line 419 of file osd.h.

{ return shown; }

int cTextScroller::Top

(

void

)

[inline]

Definition at line 414 of file osd.h.

{ return top; }

int cTextScroller::Total

(

void

)

[inline]

Definition at line 417 of file osd.h.

References cTextWrapper::Lines().

Referenced by CanScrollDown().

{ return textWrapper.Lines(); }

int cTextScroller::Width

(

void

)

[inline]

Definition at line 415 of file osd.h.

{ return width; }

---

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

• contrib/sasc-ng/sc/include/vdr/osd.h