• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • kdeutils
  • Sitemap
  • Contact Us
 

ksim

KSim::PluginObject

KSim::PluginObject Class Reference

#include <pluginmodule.h>

Inheritance diagram for KSim::PluginObject:

Inheritance graph
[legend]

List of all members.


Detailed Description

The base class for ksim modules.

To init a plugin so KSim can load your plugin just do:

   // MyPluginModule is the class that inherits KSim::PluginObject
   KSIM_INIT_PLUGIN(MyPluginModule);
 
See also:
KSim::PluginView KSim::PluginPage
Author:
Robbie Ward <linuxphreak@gmx.co.uk>

Definition at line 57 of file pluginmodule.h.


Public Member Functions

 PluginObject (const Q3CString &name)
virtual ~PluginObject ()
virtual KSim::PluginView * createView (const char *)=0
virtual KSim::PluginPage * createConfigPage (const char *)=0
virtual void showAbout ()=0
const char * componentName () const
const Q3CString & name () const
void setConfigFileName (const QString &name)
const QString & configFileName () const

Constructor & Destructor Documentation

KSim::PluginObject::PluginObject ( const Q3CString &  name  ) 

constructor for PluginObject

Definition at line 42 of file pluginmodule.cpp.

KSim::PluginObject::~PluginObject (  )  [virtual]

destructor for PluginObject

Definition at line 49 of file pluginmodule.cpp.


Member Function Documentation

virtual KSim::PluginView* KSim::PluginObject::createView ( const char *   )  [pure virtual]

creates a new View page, re-implement this to return your main view class

Implemented in CpuPlugin, DiskPlugin, PluginModule, I8KPlugin, PluginModule, MailPlugin, NetPlugin, and KSim::Snmp::Plugin.

virtual KSim::PluginPage* KSim::PluginObject::createConfigPage ( const char *   )  [pure virtual]

creates a new Config page, re-implement this to return you config class

Implemented in CpuPlugin, DiskPlugin, PluginModule, I8KPlugin, PluginModule, MailPlugin, NetPlugin, and KSim::Snmp::Plugin.

virtual void KSim::PluginObject::showAbout (  )  [pure virtual]

re-implement this to show your about dialog

Implemented in CpuPlugin, DiskPlugin, PluginModule, I8KPlugin, PluginModule, MailPlugin, NetPlugin, and KSim::Snmp::Plugin.

const char * KSim::PluginObject::componentName (  )  const

Returns:
the instance name of the app

Definition at line 54 of file pluginmodule.cpp.

const Q3CString & KSim::PluginObject::name (  )  const

Returns:
the name of the plugin

Definition at line 59 of file pluginmodule.cpp.

void KSim::PluginObject::setConfigFileName ( const QString &  name  ) 

sets the configuration file name to name

Definition at line 64 of file pluginmodule.cpp.

const QString & KSim::PluginObject::configFileName (  )  const

Returns:
the config filename the plugin should use or name() if the filename hasn't been set

Definition at line 74 of file pluginmodule.cpp.


The documentation for this class was generated from the following files:
  • pluginmodule.h
  • pluginmodule.cpp

ksim

Skip menu "ksim"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

kdeutils

Skip menu "kdeutils"
  • ark
  • kcalc
  • kcharselect
  • kdelirc
  • kdessh
  • kdf
  • kfloppy
  • kgpg
  • kjots
  • klaptopdaemon
  • kmilo
  • ksim
  • ktimer
  • kwallet
  • superkaramba
Generated for kdeutils by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal