Kontact::Plugin Class Reference
Base class for all Plugins in Kontact. More...
#include <plugin.h>
Inheritance diagram for Kontact::Plugin:

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 Summary * | createSummaryWidget (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 *) |
Core * | core () 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
|
Creates a new Plugin, note that.
Definition at line 53 of file plugin.cpp. References QObject::name(). |
Member Function Documentation
|
Sets the identifier.
Definition at line 72 of file plugin.cpp. |
|
Returns the identifier. It is used as argument for several methods of Kontacts core. Definition at line 77 of file plugin.cpp. |
|
Sets the localized title.
Definition at line 82 of file plugin.cpp. |
|
Returns the localized title.
Definition at line 87 of file plugin.cpp. Referenced by aboutData(). |
|
Sets the icon name.
Definition at line 92 of file plugin.cpp. |
|
Returns the icon name.
Definition at line 97 of file plugin.cpp. |
|
Sets the name of executable (if existant).
Definition at line 102 of file plugin.cpp. |
|
Returns the name of the binary (if existant).
Definition at line 107 of file plugin.cpp. |
|
Set name of library which contains the KPart used by this plugin.
Definition at line 112 of file plugin.cpp. |
|
Create the DCOP interface for the given Return false otherwise. |
|
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.
|
|
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. |
|
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(). |
|
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(). |
|
Reimplement this method and return the a path relative to "data" to the tips file.
Definition at line 150 of file plugin.cpp. |
|
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. |
|
This function is called whenever the config dialog has been closed successfully.
Definition at line 188 of file plugin.cpp. |
|
Reimplement this method if you want to add a widget for your application to Kontact's summary page.
|
|
Reimplement this method if you don't want to have a plugin shown in the sidebar.
|
|
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(). |
|
Return the weight of the plugin. The higher the weight the lower it will be displayed in the sidebar. The default implementation returns 0. |
|
Insert "New" action.
Definition at line 169 of file plugin.cpp. |
|
FIXME: write API doc for Kontact::Plugin::newActions().
Definition at line 174 of file plugin.cpp. |
|
Returns a list of action name which shall be hidden in the main toolbar.
|
|
Return, if the plugin can handle the drag object of the given mime type.
|
|
Process drop event.
|
|
Reimplement and return the part here. Reimplementing createPart() is mandatory! Referenced by part(). |
The documentation for this class was generated from the following files: