vdr 2.7.4
cSkinDisplayReplay Class Referenceabstract

#include <skins.h>

Classes

class  cProgressBar
 

Public Member Functions

 cSkinDisplayReplay (void)
 
virtual void SetMarks (const cMarks *Marks)
 
virtual void SetErrors (const cErrors *Errors)
 
virtual void SetRecording (const cRecording *Recording)
 
virtual void SetTitle (const char *Title)=0
 
virtual void SetMode (bool Play, bool Forward, int Speed)=0
 
virtual void SetProgress (int Current, int Total)=0
 
virtual void SetCurrent (const char *Current)=0
 
virtual void SetTotal (const char *Total)=0
 
virtual void SetJump (const char *Jump)=0
 
virtual void SetMessage (eMessageType Type, const char *Text)=0
 
- Public Member Functions inherited from cSkinDisplay
 cSkinDisplay (void)
 
virtual ~cSkinDisplay ()
 
int EditableWidth (void)
 
void SetEditableWidth (int Width)
 
virtual void SetButtons (const char *Red, const char *Green=NULL, const char *Yellow=NULL, const char *Blue=NULL)
 
virtual void Flush (void)
 

Protected Attributes

const cMarksmarks
 
const cErrorserrors
 

Additional Inherited Members

- Static Public Member Functions inherited from cSkinDisplay
static int AvgCharWidth (void)
 
static cSkinDisplayCurrent (void)
 

Detailed Description

Definition at line 309 of file skins.h.

Constructor & Destructor Documentation

◆ cSkinDisplayReplay()

cSkinDisplayReplay::cSkinDisplayReplay ( void )

Definition at line 214 of file skins.c.

References errors, and marks.

Referenced by cSkinDisplayReplay::cProgressBar::cProgressBar().

Member Function Documentation

◆ SetCurrent()

virtual void cSkinDisplayReplay::SetCurrent ( const char * Current)
pure virtual

Sets the current position within the recording, as a user readable string in the form "h:mm:ss.ff".

The ".ff" part, indicating the frame number, is optional and the actual implementation needs to take care that it is erased from the display when a Current string with ".ff" is followed by one without it.

Implemented in cSkinClassicDisplayReplay, cSkinCursesDisplayReplay, cSkinLCARSDisplayReplay, and cSkinSTTNGDisplayReplay.

References cSkinDisplay::Current().

◆ SetErrors()

void cSkinDisplayReplay::SetErrors ( const cErrors * Errors)
virtual

Sets the errors found in the recording to Errors, which shall be used to display the progress bar through a cProgressBar object.

Definition at line 230 of file skins.c.

References errors.

◆ SetJump()

virtual void cSkinDisplayReplay::SetJump ( const char * Jump)
pure virtual

Sets the prompt that allows the user to enter a jump point.

Jump is a string of the form "Jump: mm:ss". The actual implementation needs to be able to handle variations in the length of this string, which will occur when the user enters an actual value. If Jump is NULL, the jump prompt shall be removed from the display.

Implemented in cSkinClassicDisplayReplay, cSkinCursesDisplayReplay, cSkinLCARSDisplayReplay, and cSkinSTTNGDisplayReplay.

◆ SetMarks()

void cSkinDisplayReplay::SetMarks ( const cMarks * Marks)
virtual

Sets the editing marks to Marks, which shall be used to display the progress bar through a cProgressBar object.

Definition at line 225 of file skins.c.

References marks.

◆ SetMessage()

virtual void cSkinDisplayReplay::SetMessage ( eMessageType Type,
const char * Text )
pure virtual

Sets a one line message Text, with the given Type.

Type can be used to determine, e.g., the colors for displaying the Text. If Text is NULL, any previously displayed message must be removed, and any previous contents overwritten by the message must be restored.

Reimplemented from cSkinDisplay.

Implemented in cSkinClassicDisplayReplay, cSkinCursesDisplayReplay, cSkinLCARSDisplayReplay, and cSkinSTTNGDisplayReplay.

◆ SetMode()

virtual void cSkinDisplayReplay::SetMode ( bool Play,
bool Forward,
int Speed )
pure virtual

Sets the current replay mode, which can be used to display some indicator, showing the user whether we are currently in normal play mode, fast forward etc.

Implemented in cSkinClassicDisplayReplay, cSkinCursesDisplayReplay, cSkinLCARSDisplayReplay, and cSkinSTTNGDisplayReplay.

◆ SetProgress()

virtual void cSkinDisplayReplay::SetProgress ( int Current,
int Total )
pure virtual

This function will be called whenever the position in or the total length of the recording has changed.

A cProgressBar shall then be used to display a progress indicator.

Implemented in cSkinClassicDisplayReplay, cSkinCursesDisplayReplay, cSkinLCARSDisplayReplay, and cSkinSTTNGDisplayReplay.

References cSkinDisplay::Current().

◆ SetRecording()

void cSkinDisplayReplay::SetRecording ( const cRecording * Recording)
virtual

Sets the recording that is currently being played.

The default implementation calls SetTitle() with the title of the Recording. A derived class can use any information provided by the given Recording and display it.

Reimplemented in cSkinLCARSDisplayReplay.

Definition at line 220 of file skins.c.

References SetTitle(), and cRecording::Title().

◆ SetTitle()

virtual void cSkinDisplayReplay::SetTitle ( const char * Title)
pure virtual

Sets the title of the recording.

Implemented in cSkinClassicDisplayReplay, cSkinCursesDisplayReplay, cSkinLCARSDisplayReplay, and cSkinSTTNGDisplayReplay.

Referenced by SetRecording().

◆ SetTotal()

virtual void cSkinDisplayReplay::SetTotal ( const char * Total)
pure virtual

Sets the total length of the recording, as a user readable string in the form "h:mm:ss".

Implemented in cSkinClassicDisplayReplay, cSkinCursesDisplayReplay, cSkinLCARSDisplayReplay, and cSkinSTTNGDisplayReplay.

Member Data Documentation

◆ errors

◆ marks

const cMarks* cSkinDisplayReplay::marks
protected

< This class implements the progress display used during replay of a recording.

Definition at line 313 of file skins.h.

Referenced by cSkinDisplayReplay(), SetMarks(), cSkinClassicDisplayReplay::SetProgress(), cSkinLCARSDisplayReplay::SetProgress(), and cSkinSTTNGDisplayReplay::SetProgress().


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