vdr  2.0.7
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
cPlugin Class Referenceabstract

#include <plugin.h>

Public Member Functions

 cPlugin (void)
 
virtual ~cPlugin ()
 
const char * Name (void)
 
virtual const char * Version (void)=0
 
virtual const char * Description (void)=0
 
virtual const char * CommandLineHelp (void)
 
virtual bool ProcessArgs (int argc, char *argv[])
 
virtual bool Initialize (void)
 
virtual bool Start (void)
 
virtual void Stop (void)
 
virtual void Housekeeping (void)
 
virtual void MainThreadHook (void)
 
virtual cString Active (void)
 
virtual time_t WakeupTime (void)
 
virtual const char * MainMenuEntry (void)
 
virtual cOsdObjectMainMenuAction (void)
 
virtual cMenuSetupPageSetupMenu (void)
 
virtual bool SetupParse (const char *Name, const char *Value)
 
void SetupStore (const char *Name, const char *Value=NULL)
 
void SetupStore (const char *Name, int Value)
 
virtual bool Service (const char *Id, void *Data=NULL)
 
virtual const char ** SVDRPHelpPages (void)
 
virtual cString SVDRPCommand (const char *Command, const char *Option, int &ReplyCode)
 

Static Public Member Functions

static void SetConfigDirectory (const char *Dir)
 
static const char * ConfigDirectory (const char *PluginName=NULL)
 
static void SetCacheDirectory (const char *Dir)
 
static const char * CacheDirectory (const char *PluginName=NULL)
 
static void SetResourceDirectory (const char *Dir)
 
static const char * ResourceDirectory (const char *PluginName=NULL)
 

Private Member Functions

void SetName (const char *s)
 

Private Attributes

const char * name
 
bool started
 

Static Private Attributes

static cString configDirectory
 
static cString cacheDirectory
 
static cString resourceDirectory
 

Friends

class cDll
 
class cPluginManager
 

Detailed Description

Definition at line 20 of file plugin.h.

Constructor & Destructor Documentation

cPlugin::cPlugin ( void  )

Definition at line 32 of file plugin.c.

References name, and started.

cPlugin::~cPlugin ( )
virtual

Definition at line 38 of file plugin.c.

Member Function Documentation

cString cPlugin::Active ( void  )
virtual

Definition at line 80 of file plugin.c.

Referenced by cPluginManager::Active().

const char * cPlugin::CacheDirectory ( const char *  PluginName = NULL)
static

Definition at line 154 of file plugin.c.

References cacheDirectory, esyslog, cThread::IsMainThread(), MakeDirs(), and cString::sprintf().

const char * cPlugin::CommandLineHelp ( void  )
virtual

Reimplemented in cPluginSkinCurses, cPluginOsddemo, cPluginRcu, cPluginStatus, cPluginPictures, cPluginHello, and cPluginDvbsddevice.

Definition at line 48 of file plugin.c.

Referenced by main().

const char * cPlugin::ConfigDirectory ( const char *  PluginName = NULL)
static

Definition at line 140 of file plugin.c.

References configDirectory, esyslog, cThread::IsMainThread(), MakeDirs(), and cString::sprintf().

virtual const char* cPlugin::Description ( void  )
pure virtual
void cPlugin::Housekeeping ( void  )
virtual

Reimplemented in cPluginSkinCurses, cPluginOsddemo, cPluginStatus, and cPluginHello.

Definition at line 72 of file plugin.c.

Referenced by cPluginManager::Housekeeping().

bool cPlugin::Initialize ( void  )
virtual

Reimplemented in cPluginSkinCurses, and cPluginEpgtableid0.

Definition at line 58 of file plugin.c.

Referenced by cPluginManager::InitializePlugins().

cOsdObject * cPlugin::MainMenuAction ( void  )
virtual
const char * cPlugin::MainMenuEntry ( void  )
virtual
void cPlugin::MainThreadHook ( void  )
virtual

Reimplemented in cPluginDvbhddevice.

Definition at line 76 of file plugin.c.

Referenced by cPluginManager::MainThreadHook().

const char* cPlugin::Name ( void  )
inline
bool cPlugin::ProcessArgs ( int  argc,
char *  argv[] 
)
virtual

Reimplemented in cPluginSkinCurses, cPluginOsddemo, cPluginRcu, cPluginStatus, cPluginPictures, cPluginHello, and cPluginDvbsddevice.

Definition at line 53 of file plugin.c.

Referenced by cDll::Load().

const char * cPlugin::ResourceDirectory ( const char *  PluginName = NULL)
static
bool cPlugin::Service ( const char *  Id,
void *  Data = NULL 
)
virtual
void cPlugin::SetCacheDirectory ( const char *  Dir)
static

Definition at line 149 of file plugin.c.

References cacheDirectory.

Referenced by main().

void cPlugin::SetConfigDirectory ( const char *  Dir)
static

Definition at line 135 of file plugin.c.

References configDirectory.

Referenced by main().

void cPlugin::SetName ( const char *  s)
private

Definition at line 42 of file plugin.c.

References I18nRegister(), and name.

Referenced by cDll::Load().

void cPlugin::SetResourceDirectory ( const char *  Dir)
static

Definition at line 163 of file plugin.c.

References resourceDirectory.

Referenced by main().

cMenuSetupPage * cPlugin::SetupMenu ( void  )
virtual
bool cPlugin::SetupParse ( const char *  Name,
const char *  Value 
)
virtual

Reimplemented in cPluginSkinCurses, cPluginOsddemo, cPluginStatus, cPluginPictures, cPluginHello, and cPluginDvbhddevice.

Definition at line 105 of file plugin.c.

Referenced by cSetup::Load().

void cPlugin::SetupStore ( const char *  Name,
const char *  Value = NULL 
)

Definition at line 110 of file plugin.c.

References Name(), Setup, and cSetup::Store().

Referenced by cMenuSetupPage::SetupStore().

void cPlugin::SetupStore ( const char *  Name,
int  Value 
)

Definition at line 115 of file plugin.c.

References Name(), Setup, and cSetup::Store().

bool cPlugin::Start ( void  )
virtual

Reimplemented in cPluginSkinCurses, cPluginOsddemo, cPluginRcu, cPluginStatus, and cPluginHello.

Definition at line 63 of file plugin.c.

Referenced by cPluginManager::StartPlugins().

void cPlugin::Stop ( void  )
virtual

Reimplemented in cPluginDvbhddevice.

Definition at line 68 of file plugin.c.

Referenced by cPluginManager::StopPlugins().

cString cPlugin::SVDRPCommand ( const char *  Command,
const char *  Option,
int &  ReplyCode 
)
virtual

Reimplemented in cPluginSvdrpdemo.

Definition at line 130 of file plugin.c.

Referenced by cSVDRP::CmdPLUG().

const char ** cPlugin::SVDRPHelpPages ( void  )
virtual

Reimplemented in cPluginSvdrpdemo.

Definition at line 125 of file plugin.c.

Referenced by cSVDRP::CmdHELP(), and cSVDRP::CmdPLUG().

virtual const char* cPlugin::Version ( void  )
pure virtual
time_t cPlugin::WakeupTime ( void  )
virtual

Friends And Related Function Documentation

friend class cDll
friend

Definition at line 21 of file plugin.h.

friend class cPluginManager
friend

Definition at line 22 of file plugin.h.

Member Data Documentation

cString cPlugin::cacheDirectory
staticprivate

Definition at line 25 of file plugin.h.

Referenced by CacheDirectory(), and SetCacheDirectory().

cString cPlugin::configDirectory
staticprivate

Definition at line 24 of file plugin.h.

Referenced by ConfigDirectory(), and SetConfigDirectory().

const char* cPlugin::name
private

Definition at line 27 of file plugin.h.

Referenced by cPlugin(), Name(), and SetName().

cString cPlugin::resourceDirectory
staticprivate

Definition at line 26 of file plugin.h.

Referenced by ResourceDirectory(), and SetResourceDirectory().

bool cPlugin::started
private

Definition at line 28 of file plugin.h.

Referenced by cPlugin(), cPluginManager::StartPlugins(), and cPluginManager::StopPlugins().


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