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

ksim

KSim::Plugin

KSim::Plugin Class Reference

#include <pluginglobal.h>

List of all members.


Detailed Description

A class that holds various information about a plugin.

Author:
Robbie Ward <linuxphreak@gmx.co.uk>

Definition at line 43 of file pluginglobal.h.


Public Member Functions

 Plugin ()
 Plugin (KSim::PluginObject *plugin, const KDesktopFile &file)
 Plugin (const Plugin &rhs)
 ~Plugin ()
Plugin & operator= (const Plugin &rhs)
bool operator== (const Plugin &rhs) const
bool operator!= (const Plugin &rhs) const
void setEnabled (bool enabled)
bool isEnabled () const
bool isDifferent () const
bool isNull () const
const QString & name () const
QPixmap icon () const
Q3CString libName () const
const QString & fileName () const
KSim::PluginObject * plugin () const
KSim::PluginView * view () const
KSim::PluginPage * configPage () const

Static Public Attributes

static KSim::Plugin null

Constructor & Destructor Documentation

KSim::Plugin::Plugin (  ) 

Constructs a null Plugin.

Definition at line 77 of file pluginglobal.cpp.

KSim::Plugin::Plugin ( KSim::PluginObject *  plugin,
const KDesktopFile &  file 
)

Constructs a Plugin.

Definition at line 81 of file pluginglobal.cpp.

KSim::Plugin::Plugin ( const Plugin &  rhs  ) 

Copy constructor.

Definition at line 91 of file pluginglobal.cpp.

KSim::Plugin::~Plugin (  ) 

Destructor for Plugin.

Definition at line 98 of file pluginglobal.cpp.


Member Function Documentation

KSim::Plugin & KSim::Plugin::operator= ( const Plugin &  rhs  ) 

Assigns rhs to this Plugin and returns a reference to this Plugin.

Definition at line 104 of file pluginglobal.cpp.

bool KSim::Plugin::operator== ( const Plugin &  rhs  )  const

Returns:
true if the plugin is equal to rhs; otherwise returns false

See also:
operator!=

Definition at line 127 of file pluginglobal.cpp.

bool KSim::Plugin::operator!= ( const Plugin &  rhs  )  const

Returns:
true if the plugin is different to rhs; otherwise returns false

See also:
operator==

Definition at line 132 of file pluginglobal.cpp.

void KSim::Plugin::setEnabled ( bool  enabled  ) 

sets if the plugin is enabled or not

Definition at line 137 of file pluginglobal.cpp.

bool KSim::Plugin::isEnabled (  )  const

returns true if this plugin is enabled, else it returns false

Definition at line 146 of file pluginglobal.cpp.

bool KSim::Plugin::isDifferent (  )  const

returns true if the last enabled state is different to the current enabled state, else it returns false

Definition at line 151 of file pluginglobal.cpp.

bool KSim::Plugin::isNull (  )  const

Returns:
true if the Plugin object is empty

Definition at line 156 of file pluginglobal.cpp.

const QString & KSim::Plugin::name (  )  const

Returns:
the name of the plugin, NOT the library name

See also:
libName

Definition at line 161 of file pluginglobal.cpp.

QPixmap KSim::Plugin::icon (  )  const

Returns:
the icon of the plugin

Definition at line 166 of file pluginglobal.cpp.

Q3CString KSim::Plugin::libName (  )  const

Returns:
library name of the plugin

Definition at line 171 of file pluginglobal.cpp.

const QString & KSim::Plugin::fileName (  )  const

Returns:
path to the .desktop file

Definition at line 176 of file pluginglobal.cpp.

KSim::PluginObject * KSim::Plugin::plugin (  )  const

Returns:
the plugin object

Definition at line 181 of file pluginglobal.cpp.

KSim::PluginView * KSim::Plugin::view (  )  const

Returns:
the view object of the plugin

Definition at line 186 of file pluginglobal.cpp.

KSim::PluginPage * KSim::Plugin::configPage (  )  const

Returns:
the config object of the plugin

Definition at line 191 of file pluginglobal.cpp.


Member Data Documentation

KSim::Plugin KSim::Plugin::null [static]

a null plugin, provided for convenience.

currently only used in KSim::PluginLoader

Definition at line 127 of file pluginglobal.h.


The documentation for this class was generated from the following files:
  • pluginglobal.h
  • pluginglobal.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