KontactInterface::Plugin

KontactInterface::Plugin Class Referenceabstract

#include <plugin.h>

Inheritance diagram for KontactInterface::Plugin:

Public Slots

void slotConfigUpdated ()
 

Public Member Functions

 Plugin (Core *core, QObject *parent, const char *appName, const char *pluginName=nullptr)
 
 ~Plugin () override
 
virtual const KAboutData aboutData ()
 
void aboutToSelect ()
 
virtual void bringToForeground ()
 
virtual bool canDecodeMimeData (const QMimeData *data) const
 
virtual void configUpdated ()
 
Corecore () const
 
virtual SummarycreateSummaryWidget (QWidget *parent)
 
bool disabled () const
 
QString executableName () const
 
QString icon () const
 
QString identifier () const
 
void insertNewAction (QAction *action)
 
void insertSyncAction (QAction *action)
 
virtual QStringList invisibleToolbarActions () const
 
virtual bool isRunningStandalone () const
 
QList< QAction * > newActions () const
 
KParts::Partpart ()
 
virtual void processDropEvent (QDropEvent *)
 
virtual bool queryClose () const
 
virtual void readProperties (const KConfigGroup &)
 
QString registerClient ()
 
virtual void saveProperties (KConfigGroup &)
 
virtual void select ()
 
void setDisabled (bool value)
 
void setExecutableName (const QString &name)
 
void setIcon (const QString &icon)
 
void setIdentifier (const QString &identifier)
 
void setPartLibraryName (const QByteArray &name)
 
void setShowInSideBar (bool hasPart)
 
void setTitle (const QString &title)
 
virtual void shortcutChanged ()
 
virtual bool showInSideBar () const
 
QList< QAction * > syncActions () const
 
QString title () const
 
virtual int weight () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Member Functions inherited from KXMLGUIClient
 KXMLGUIClient (KXMLGUIClient *parent)
 
QActionaction (const char *name) const
 
virtual QActionaction (const QDomElement &element) const
 
virtual KActionCollectionactionCollection () const
 
QList< KXMLGUIClient * > childClients ()
 
KXMLGUIBuilderclientBuilder () const
 
virtual QString componentName () const
 
virtual QDomDocument domDocument () const
 
KXMLGUIFactoryfactory () const
 
void insertChildClient (KXMLGUIClient *child)
 
KXMLGUIClientparentClient () const
 
void plugActionList (const QString &name, const QList< QAction * > &actionList)
 
void reloadXML ()
 
void removeChildClient (KXMLGUIClient *child)
 
void replaceXMLFile (const QString &xmlfile, const QString &localxmlfile, bool merge=false)
 
void setClientBuilder (KXMLGUIBuilder *builder)
 
void setFactory (KXMLGUIFactory *factory)
 
void setXMLGUIBuildDocument (const QDomDocument &doc)
 
void unplugActionList (const QString &name)
 
virtual QString xmlFile () const
 
QDomDocument xmlguiBuildDocument () const
 

Protected Member Functions

virtual KParts::PartcreatePart ()=0
 
KParts::PartloadPart ()
 
void virtual_hook (int id, void *data) override
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Protected Member Functions inherited from KXMLGUIClient
void loadStandardsXmlFile ()
 
virtual void setComponentName (const QString &componentName, const QString &componentDisplayName)
 
virtual void setDOMDocument (const QDomDocument &document, bool merge=false)
 
virtual void setLocalXMLFile (const QString &file)
 
virtual void setXML (const QString &document, bool merge=false)
 
virtual void setXMLFile (const QString &file, bool merge=false, bool setXMLDoc=true)
 
virtual void stateChanged (const QString &newstate, ReverseStateChange reverse=StateNoReverse)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Static Public Member Functions inherited from KXMLGUIClient
static QString findVersionNumber (const QString &xml)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Static Protected Member Functions inherited from KXMLGUIClient
static QString standardsXmlFileLocation ()
 

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 80 of file plugin.h.

Constructor & Destructor Documentation

Plugin::Plugin ( Core core,
QObject parent,
const char *  appName,
const char *  pluginName = nullptr 
)

Creates a new plugin.

Private class that helps to provide binary compatibility between releases.

Parameters
coreThe core object that manages the plugin.
parentThe parent object.
appNameThe name of the application that provides the part. This is the name used for DBus registration. It's ok to have several plugins using the same application name.
pluginNameThe unique name of the plugin. Defaults to appName if not set.

Definition at line 61 of file plugin.cpp.

Plugin::~Plugin ( )
override

Destroys the plugin.

Definition at line 74 of file plugin.cpp.

Member Function Documentation

const KAboutData Plugin::aboutData ( )
virtual

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

Definition at line 135 of file plugin.cpp.

void Plugin::aboutToSelect ( )

Called by kontact when the plugin is selected by the user.

Calls the virtual method select(), but also handles some standard behavior like "invisible toolbar actions".

Definition at line 219 of file plugin.cpp.

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 320 of file plugin.cpp.

bool Plugin::canDecodeMimeData ( const QMimeData data) const
virtual

Returns whether the plugin can handle the drag object of the given mime type.

Definition at line 196 of file plugin.cpp.

void Plugin::configUpdated ( )
virtual

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

Definition at line 232 of file plugin.cpp.

Core * Plugin::core ( ) const

Returns a pointer to the kontact core object.

Definition at line 214 of file plugin.cpp.

virtual KParts::Part* KontactInterface::Plugin::createPart ( )
protectedpure virtual

Reimplement and return the part here.

Reimplementing createPart() is mandatory!

Summary * Plugin::createSummaryWidget ( QWidget parent)
virtual

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

Parameters
parentThe parent widget of the summary widget.

Definition at line 333 of file plugin.cpp.

bool Plugin::disabled ( ) const

Returns whether the plugin is disabled.

Definition at line 359 of file plugin.cpp.

QString Plugin::executableName ( ) const

Returns the name of the executable (if existent).

Definition at line 115 of file plugin.cpp.

QString Plugin::icon ( ) const

Returns the icon name that is used for the plugin.

Definition at line 105 of file plugin.cpp.

QString Plugin::identifier ( ) const

Returns the identifier of the plugin.

Definition at line 85 of file plugin.cpp.

void Plugin::insertNewAction ( QAction action)

Inserts a custom "New" action.

Parameters
actionthe new action to insert

Definition at line 171 of file plugin.cpp.

void Plugin::insertSyncAction ( QAction action)

Inserts a custom "Sync" action.

Parameters
actionthe custom Sync action to insert

Definition at line 176 of file plugin.cpp.

QStringList Plugin::invisibleToolbarActions ( ) const
virtual

Returns a list of action names that shall be hidden in the main toolbar.

Definition at line 191 of file plugin.cpp.

bool Plugin::isRunningStandalone ( ) const
virtual

Reimplement this method and return whether a standalone application is still running.

This is only required if your part is also available as standalone application.

Definition at line 125 of file plugin.cpp.

KParts::Part * Plugin::loadPart ( )
protected

Returns the loaded part.

Definition at line 130 of file plugin.cpp.

QList< QAction * > Plugin::newActions ( ) const

Returns the list of custom "New" actions.

Definition at line 181 of file plugin.cpp.

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 140 of file plugin.cpp.

void Plugin::processDropEvent ( QDropEvent )
virtual

Process drop event.

Definition at line 202 of file plugin.cpp.

bool Plugin::queryClose ( ) const
virtual

Reimplement this method if you want to add checks before closing 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.

Definition at line 349 of file plugin.cpp.

void Plugin::readProperties ( const KConfigGroup )
virtual

Session management: read properties.

Definition at line 206 of file plugin.cpp.

QString Plugin::registerClient ( )

Registers the client at DBus and returns the dbus identifier.

Definition at line 153 of file plugin.cpp.

void Plugin::saveProperties ( KConfigGroup )
virtual

Session management: save properties.

Definition at line 210 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 228 of file plugin.cpp.

void Plugin::setDisabled ( bool  value)

Sets whether the plugin shall be disabled.

Definition at line 354 of file plugin.cpp.

void Plugin::setExecutableName ( const QString name)

Sets the name of executable (if existent).

Definition at line 110 of file plugin.cpp.

void Plugin::setIcon ( const QString icon)

Sets the icon name that is used for the plugin.

Definition at line 100 of file plugin.cpp.

void Plugin::setIdentifier ( const QString identifier)

Sets the identifier of the plugin.

Definition at line 80 of file plugin.cpp.

void Plugin::setPartLibraryName ( const QByteArray name)

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

Definition at line 120 of file plugin.cpp.

void Plugin::setShowInSideBar ( bool  hasPart)

Set if the plugin provides a part that should be shown in the sidebar.

Parameters
hasPartshows part in sidebar if set as true

Definition at line 344 of file plugin.cpp.

void Plugin::setTitle ( const QString title)

Sets the localized title of the plugin.

Definition at line 90 of file plugin.cpp.

void Plugin::shortcutChanged ( )
virtual
Since
4.13

Definition at line 364 of file plugin.cpp.

bool Plugin::showInSideBar ( ) const
virtual

Returns whether the plugin provides a part that should be shown in the sidebar.

Definition at line 339 of file plugin.cpp.

void Plugin::slotConfigUpdated ( )
slot

usage

This slot is called whenever the configuration has been changed.

Definition at line 315 of file plugin.cpp.

QList< QAction * > Plugin::syncActions ( ) const

Returns the list of custom "Sync" actions.

Definition at line 186 of file plugin.cpp.

QString Plugin::title ( ) const

Returns the localized title of the plugin.

Definition at line 95 of file plugin.cpp.

void Plugin::virtual_hook ( int  id,
void *  data 
)
overrideprotected

Virtual hook for BC extension.

Definition at line 368 of file plugin.cpp.

int Plugin::weight ( ) const
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 166 of file plugin.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun Aug 9 2020 23:28:38 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.