cPlugin Class Reference

#include <plugin.h>

Inheritance diagram for cPlugin:

Inheritance graph
[legend]

List of all members.

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)
void RegisterI18n (const void *)
 This function is obsolete and may be removed in future versions of VDR!
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)

Private Member Functions

void SetName (const char *s)

Private Attributes

const char * name
bool started

Static Private Attributes

static char * configDirectory = NULL

Friends

class cDll
class cPluginManager


Detailed Description

Definition at line 20 of file plugin.h.


Constructor & Destructor Documentation

cPlugin::cPlugin ( void   ) 

Definition at line 30 of file plugin.c.

References name, and started.

cPlugin::~cPlugin (  )  [virtual]

Definition at line 36 of file plugin.c.


Member Function Documentation

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

Definition at line 40 of file plugin.c.

References I18nRegister(), and name.

Referenced by cDll::Load().

Here is the call graph for this function:

const char* cPlugin::Name ( void   )  [inline]

virtual const char* cPlugin::Version ( void   )  [pure virtual]

virtual const char* cPlugin::Description ( void   )  [pure virtual]

const char * cPlugin::CommandLineHelp ( void   )  [virtual]

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

Definition at line 46 of file plugin.c.

Referenced by main().

bool cPlugin::ProcessArgs ( int  argc,
char *  argv[] 
) [virtual]

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

Definition at line 51 of file plugin.c.

Referenced by cDll::Load().

bool cPlugin::Initialize ( void   )  [virtual]

Reimplemented in cPluginSkinCurses, and cPluginSky.

Definition at line 56 of file plugin.c.

Referenced by cPluginManager::InitializePlugins().

bool cPlugin::Start ( void   )  [virtual]

Reimplemented in cPluginHello, cPluginOsddemo, cPluginSkinCurses, and cPluginStatus.

Definition at line 61 of file plugin.c.

Referenced by cPluginManager::StartPlugins().

void cPlugin::Stop ( void   )  [virtual]

Definition at line 66 of file plugin.c.

Referenced by cPluginManager::StopPlugins().

void cPlugin::Housekeeping ( void   )  [virtual]

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

Definition at line 70 of file plugin.c.

Referenced by cPluginManager::Housekeeping().

void cPlugin::MainThreadHook ( void   )  [virtual]

Definition at line 74 of file plugin.c.

Referenced by cPluginManager::MainThreadHook().

cString cPlugin::Active ( void   )  [virtual]

Definition at line 78 of file plugin.c.

Referenced by cPluginManager::Active().

time_t cPlugin::WakeupTime ( void   )  [virtual]

const char * cPlugin::MainMenuEntry ( void   )  [virtual]

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

Definition at line 88 of file plugin.c.

Referenced by cMenuMain::Set().

cOsdObject * cPlugin::MainMenuAction ( void   )  [virtual]

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

Definition at line 93 of file plugin.c.

Referenced by main(), and cMenuMain::ProcessKey().

cMenuSetupPage * cPlugin::SetupMenu ( void   )  [virtual]

bool cPlugin::SetupParse ( const char *  Name,
const char *  Value 
) [virtual]

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

Definition at line 103 of file plugin.c.

Referenced by cSetup::Load().

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

Definition at line 108 of file plugin.c.

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

Referenced by cMenuSetupPage::SetupStore().

Here is the call graph for this function:

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

Definition at line 113 of file plugin.c.

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

Here is the call graph for this function:

void cPlugin::RegisterI18n ( const void *   ) 

This function is obsolete and may be removed in future versions of VDR!

Definition at line 133 of file plugin.c.

References dsyslog, and Name().

Here is the call graph for this function:

bool cPlugin::Service ( const char *  Id,
void *  Data = NULL 
) [virtual]

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

Reimplemented in cPluginSvdrpdemo.

Definition at line 123 of file plugin.c.

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

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

Reimplemented in cPluginSvdrpdemo.

Definition at line 128 of file plugin.c.

Referenced by cSVDRP::CmdPLUG().

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

Definition at line 138 of file plugin.c.

References configDirectory.

Referenced by main().

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

Definition at line 143 of file plugin.c.

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

Referenced by cPluginSky::Initialize().

Here is the call graph for this function:


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

char * cPlugin::configDirectory = NULL [static, private]

Definition at line 24 of file plugin.h.

Referenced by ConfigDirectory(), and SetConfigDirectory().

const char* cPlugin::name [private]

Definition at line 25 of file plugin.h.

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

bool cPlugin::started [private]

Definition at line 26 of file plugin.h.

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


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

Generated on Tue Nov 4 20:00:42 2008 for VDR by  doxygen 1.5.6