vdr  2.2.0
Public Member Functions | Private Attributes | List of all members
cSourceParam Class Referenceabstract

#include <sourceparams.h>

Public Member Functions

 cSourceParam (char Source, const char *Description)
 
char Source (void) const
 
virtual void SetData (cChannel *Channel)=0
 
virtual void GetData (cChannel *Channel)=0
 
virtual cOsdItemGetOsdItem (void)=0
 
- Public Member Functions inherited from cListObject
 cListObject (void)
 
virtual ~cListObject ()
 
virtual int Compare (const cListObject &ListObject) const
 
void Append (cListObject *Object)
 
void Insert (cListObject *Object)
 
void Unlink (void)
 
int Index (void) const
 
cListObjectPrev (void) const
 
cListObjectNext (void) const
 

Private Attributes

char source
 

Detailed Description

Definition at line 17 of file sourceparams.h.

Constructor & Destructor Documentation

cSourceParam::cSourceParam ( char  Source,
const char *  Description 
)

Sets up a parameter handler for the given Source.

Source must be in the range 'A'...'Z', and there can only be one cSourceParam for any given source. Description contains a short, one line description of this source. If a plugin sets up a new cSourceParam, this will also trigger defining the appropriate cSource automatically. Objects of cSourceParam shall only be created on the heap, and shall never be deleted (they will be deleted automatically when the program ends).

Definition at line 15 of file sourceparams.c.

References cListBase::Add(), cSources::ContainsSourceType(), dsyslog, esyslog, cSourceParams::Get(), source, Source(), SourceParams, and Sources.

Member Function Documentation

virtual void cSourceParam::GetData ( cChannel Channel)
pure virtual

Copies all source specific parameters to the given Channel.

Implemented in cDvbSourceParam.

Referenced by cMenuEditChannel::ProcessKey(), and Source().

virtual cOsdItem* cSourceParam::GetOsdItem ( void  )
pure virtual

Returns all the OSD items necessary for editing the source specific parameters of the channel that was given in the last call to SetData().

Each call to GetOsdItem() returns exactly one such item. After all items have been fetched, any further calls to GetOsdItem() return NULL. After another call to SetData(), the OSD items can be fetched again.

Implemented in cDvbSourceParam.

Referenced by cMenuEditChannel::Setup(), and Source().

virtual void cSourceParam::SetData ( cChannel Channel)
pure virtual

Sets all source specific parameters to those of the given Channel.

Must also reset a counter to use with later calls to GetOsdItem().

Implemented in cDvbSourceParam.

Referenced by cMenuEditChannel::Setup(), and Source().

char cSourceParam::Source ( void  ) const
inline

Member Data Documentation

char cSourceParam::source
private

Definition at line 19 of file sourceparams.h.

Referenced by cSourceParam(), and Source().


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