kontact Library API Documentation

Kontact::Plugin Class Reference

Base class for all Plugins in Kontact. More...

#include <plugin.h>

Inheritance diagram for Kontact::Plugin:

QObject List of all members.

Public Methods

 Plugin (Core *core, QObject *parent, const char *name)
 ~Plugin ()
void setIdentifier (const QString &identifier)
QString identifier () const
void setTitle (const QString &title)
QString title () const
void setIcon (const QString &icon)
QString icon () const
void setExecutableName (const QString &bin)
QString executableName () const
void setPartLibraryName (const QCString &)
virtual bool createDCOPInterface (const QString &)
virtual bool isRunningStandalone ()
virtual void bringToForeground ()
virtual const KAboutData * aboutData ()
KParts::Part * part ()
virtual QString tipFile () const
virtual void select ()
virtual void configUpdated ()
virtual SummarycreateSummaryWidget (QWidget *)
virtual bool showInSideBar () const
DCOPClient * dcopClient () const
virtual int weight () const
void insertNewAction (KAction *action)
QPtrList< KAction > * newActions () const
virtual QStringList invisibleToolbarActions () const
virtual bool canDecodeDrag (QMimeSource *)
virtual void processDropEvent (QDropEvent *)
Corecore () const

Protected Methods

virtual KParts::Part * createPart ()=0
KParts::Part * loadPart ()

Detailed Description

Base class for all Plugins in Kontact.

Inherit from it to get a plugin. It can insert an icon into the sidepane, add widgets to the widgetstack and add menu items via XMLGUI.

Definition at line 56 of file plugin.h.


Constructor & Destructor Documentation

Plugin::Plugin Core   core,
QObject   parent,
const char *    name
 

Creates a new Plugin, note that.

Parameters:
name  is required if you want your plugin to do dcop via it's own instance of DCOPClient by calling dcopClient.
Note:
name MUST be the name of the application that provides the part! This is the name used for DCOP registration. It's ok to have several plugins using the same application name.

Definition at line 53 of file plugin.cpp.

References QObject::name().


Member Function Documentation

void Plugin::setIdentifier const QString   identifier
 

Sets the identifier.

Definition at line 72 of file plugin.cpp.

QString Plugin::identifier   const
 

Returns the identifier.

It is used as argument for several methods of Kontacts core.

Definition at line 77 of file plugin.cpp.

void Plugin::setTitle const QString   title
 

Sets the localized title.

Definition at line 82 of file plugin.cpp.

QString Plugin::title   const
 

Returns the localized title.

Definition at line 87 of file plugin.cpp.

Referenced by aboutData().

void Plugin::setIcon const QString   icon
 

Sets the icon name.

Definition at line 92 of file plugin.cpp.

QString Plugin::icon   const
 

Returns the icon name.

Definition at line 97 of file plugin.cpp.

void Plugin::setExecutableName const QString   bin
 

Sets the name of executable (if existant).

Definition at line 102 of file plugin.cpp.

QString Plugin::executableName   const
 

Returns the name of the binary (if existant).

Definition at line 107 of file plugin.cpp.

void Plugin::setPartLibraryName const QCString  
 

Set name of library which contains the KPart used by this plugin.

Definition at line 112 of file plugin.cpp.

virtual bool Kontact::Plugin::createDCOPInterface const QString   [inline, virtual]
 

Create the DCOP interface for the given serviceType, if this plugin provides it.

Return false otherwise.

Definition at line 123 of file plugin.h.

virtual bool Kontact::Plugin::isRunningStandalone   [inline, virtual]
 

Reimplement this method and return wether a standalone application is still running This is only required if your part is also available as standalone application.

Definition at line 129 of file plugin.h.

void Plugin::bringToForeground   [virtual]
 

Reimplement this method if your application needs a different approach to be brought in the foreground.

The default behaviour is calling the binary. This is only required if your part is also available as standalone application.

Definition at line 197 of file plugin.cpp.

const KAboutData * Plugin::aboutData   [virtual]
 

Reimplement this method if you want to add your credits to the Kontact about dialog.

Definition at line 122 of file plugin.cpp.

References title().

KParts::Part * Plugin::part  
 

You can use this method if you need to access the current part.

You can be sure that you always get the same pointer as long as the part has not been deleted.

Definition at line 138 of file plugin.cpp.

References QObject::connect(), createPart(), QObject::destroyed(), and Kontact::Core::partLoaded().

QString Plugin::tipFile   const [virtual]
 

Reimplement this method and return the a path relative to "data" to the tips file.

Definition at line 150 of file plugin.cpp.

void Plugin::select   [virtual]
 

This function is called when the plugin is selected by the user before the widget of the KPart belonging to the plugin is raised.

Definition at line 184 of file plugin.cpp.

void Plugin::configUpdated   [virtual]
 

This function is called whenever the config dialog has been closed successfully.

Definition at line 188 of file plugin.cpp.

virtual Summary* Kontact::Plugin::createSummaryWidget QWidget   [inline, virtual]
 

Reimplement this method if you want to add a widget for your application to Kontact's summary page.

Parameters:
parent  parent widget.

Definition at line 174 of file plugin.h.

virtual bool Kontact::Plugin::showInSideBar   const [inline, virtual]
 

Reimplement this method if you don't want to have a plugin shown in the sidebar.

Definition at line 179 of file plugin.h.

DCOPClient * Plugin::dcopClient   const
 

Retrieve the current DCOP Client for the plugin.

The clients name is taken from the name argument in the constructor. @note: The DCOPClient object will only be created when this method is called for the first time. Make sure that the part has been loaded before calling this method, if it's the one that contains the DCOP interface that other parts might use.

Definition at line 156 of file plugin.cpp.

References QObject::name().

virtual int Kontact::Plugin::weight   const [inline, virtual]
 

Return the weight of the plugin.

The higher the weight the lower it will be displayed in the sidebar. The default implementation returns 0.

Definition at line 196 of file plugin.h.

void Plugin::insertNewAction KAction *    action
 

Insert "New" action.

Definition at line 169 of file plugin.cpp.

QPtrList< KAction > * Plugin::newActions   const
 

FIXME: write API doc for Kontact::Plugin::newActions().

Definition at line 174 of file plugin.cpp.

virtual QStringList Kontact::Plugin::invisibleToolbarActions   const [inline, virtual]
 

Returns a list of action name which shall be hidden in the main toolbar.

Definition at line 211 of file plugin.h.

virtual bool Kontact::Plugin::canDecodeDrag QMimeSource   [inline, virtual]
 

Return, if the plugin can handle the drag object of the given mime type.

Definition at line 216 of file plugin.h.

virtual void Kontact::Plugin::processDropEvent QDropEvent   [inline, virtual]
 

Process drop event.

Definition at line 221 of file plugin.h.

virtual KParts::Part* Kontact::Plugin::createPart   [protected, pure virtual]
 

Reimplement and return the part here.

Reimplementing createPart() is mandatory!

Referenced by part().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kontact Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:39:01 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003