Kontact::Plugin Class Reference
Base class for all Plugins in Kontact. More...
#include <plugin.h>
Inherits QObject, and KXMLGUIClient.
Inherited by Akregator::Plugin, JournalPlugin, KAddressbookPlugin, KitchenSyncPlugin, KMailPlugin, KNodePlugin, KNotesPlugin, KOrganizerPlugin, KPilotPlugin, MultiSynkPlugin, NewsTickerPlugin, SpecialdatesPlugin, SummaryView, TodoPlugin, and WeatherPlugin.
Public Slots
- void slotConfigUpdated ()
Public Member Functions
- Plugin (Core *core, QObject *parent, const char *name)
- 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::ReadOnlyPart * part ()
- virtual QString tipFile () const
- virtual void select ()
- virtual void configUpdated ()
- virtual Summary * createSummaryWidget (QWidget *)
- virtual bool showInSideBar () const
- void setShowInSideBar (bool hasPart)
- virtual bool queryClose () 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 Member Functions
- virtual KParts::ReadOnlyPart * createPart ()=0
- KParts::ReadOnlyPart * loadPart ()
- virtual void virtual_hook (int id, void *data)
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.
Constructor & Destructor Documentation
|
Creates a new Plugin, note that name parameter name is required if you want your plugin to do dcop via it's own instance of.
|
Member Function Documentation
|
Sets the identifier.
|
|
Returns the identifier. It is used as argument for several methods of Kontacts core. |
|
Sets the localized title.
|
|
Returns the localized title.
|
|
Sets the icon name.
|
|
Returns the icon name.
|
|
Sets the name of executable (if existant).
|
|
Returns the name of the binary (if existant).
|
|
Set name of library which contains the KPart used by this plugin.
|
|
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. |
|
Reimplement this method if you want to add your credits to the Kontact about dialog.
|
|
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. |
|
Reimplement this method and return the a path relative to "data" to the tips file.
|
|
This function is called when the plugin is selected by the user before the widget of the KPart belonging to the plugin is raised.
|
|
This function is called whenever the config dialog has been closed successfully.
|
|
Reimplement this method if you want to add a widget for your application to Kontact's summary page.
|
|
Returns wether the plugin provides a part that should be shown in the sidebar.
|
|
Set if the plugin provides a part that should be shown in the sidebar.
|
|
Reimplement this method if you want to add checks before closing down the main kontact window. Return true if it's OK to close the window. If any loaded plugin returns false from this method, then the main kontact window will not close. |
|
Retrieve the current DCOP Client for the plugin. The clients name is taken from the name argument in the constructor.
|
|
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.
|
|
FIXME: write API doc for Kontact::Plugin::newActions().
|
|
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.
|
|
internal usage
|
|
Reimplement and return the part here. Reimplementing createPart() is mandatory! |
The documentation for this class was generated from the following files:
- plugin.h
- plugin.cpp