KMyMoneyPlugin::Plugin Class Reference

#include <kmymoneyplugin.h>

Inheritance diagram for KMyMoneyPlugin::Plugin:

Public Slots
virtual void	plug (KXMLGUIFactory *guiFactory)
virtual void	unplug ()
virtual void	updateActions (const SelectedObjects &selections)
virtual void	updateConfiguration ()

Public Member Functions
	Plugin (QObject *parent, const KPluginMetaData &metaData, const QVariantList &args)
QString	componentDisplayName () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () 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 () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	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
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const
Public Member Functions inherited from KXMLGUIClient
	KXMLGUIClient (KXMLGUIClient *parent)
virtual QAction *	action (const QDomElement &element) const
QAction *	action (const QString &name) const
virtual KActionCollection *	actionCollection () const
QList< KXMLGUIClient * >	childClients ()
KXMLGUIBuilder *	clientBuilder () const
virtual QString	componentName () const
virtual QDomDocument	domDocument () const
KXMLGUIFactory *	factory () const
void	insertChildClient (KXMLGUIClient *child)
KXMLGUIClient *	parentClient () 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
AppInterface *	appInterface () const
ImportInterface *	importInterface () const
StatementInterface *	statementInterface () const
KToggleAction *	toggleAction (const QString &name) const
ViewInterface *	viewInterface () const
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
QObject *	sender () 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 *context, Functor functor, 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)
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (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

This class describes the interface between KMyMoney and it's plugins.

The plugins are based on Qt 5's plugin system. So you must compile json information into the plugin. KMyMoney looks into the folder "${PLUGIN_INSTALL_DIR}/kmymoney/" and loads all plugins found there (if the user did not deactivate the plugin).

The json header of the plugin must comply with the requirements of KCoreAddon's KPluginMetaData class. To load the plugin at start up the service type "KMyMoney/Plugin" must be set.

Warning

The plugin system for KMyMoney 5 is still in development. Especially the loading of the on-demand plugins (mainly undocumented :( ) will change.

A basic json header is shown below.

{
 "KPlugin": {
     "Authors": [
         {
             "Name": "Author's Names, Second Author",
             "Email": "E-Mail 1, E-Mail 2"
         }
     ],
     "Description": "Short description for plugin list (translateable)",
     "EnabledByDefault": true,
     "Icon": "icon to be shown in plugin list",
     "Id": "a unique identifier",
     "License": "see KPluginMetaData for list of predefined licenses (translateable)",
     "Name": "Name of the plugin (translateable)",
     "Version": "@PROJECT_VERSION@@PROJECT_VERSION_SUFFIX@",
  }
}

This example assumes you are using

configure_file(${CMAKE_CURRENT_SOURCE_DIR}/... ${CMAKE_CURRENT_BINARY_DIR}/... @ONLY)

to replace the version variables using cmake.

See also

https://doc.qt.io/qt-5/plugins-howto.html

https://api.kde.org/frameworks/kcoreaddons/html/classKPluginMetaData.html

Definition at line 106 of file kmymoneyplugin.h.

Constructor & Destructor Documentation

Plugin()

KMyMoneyPlugin::Plugin::Plugin ( QObject * parent, const KPluginMetaData & metaData, const QVariantList & args )

explicit

Definition at line 29 of file kmymoneyplugin.cpp.

~Plugin()

KMyMoneyPlugin::Plugin::~Plugin ( )

virtual

Definition at line 41 of file kmymoneyplugin.cpp.

Member Function Documentation

appInterface()

KMyMoneyPlugin::AppInterface * KMyMoneyPlugin::Plugin::appInterface ( ) const

protected

Definition at line 90 of file kmymoneyplugin.cpp.

componentDisplayName()

QString KMyMoneyPlugin::Plugin::componentDisplayName

(

)

const

Definition at line 45 of file kmymoneyplugin.cpp.

importInterface()

KMyMoneyPlugin::ImportInterface * KMyMoneyPlugin::Plugin::importInterface ( ) const

protected

Definition at line 108 of file kmymoneyplugin.cpp.

plug

void KMyMoneyPlugin::Plugin::plug ( KXMLGUIFactory * guiFactory )

virtualslot

Called during plug in process.

Reimplemented in KMyMoneyPlugin::OnlinePluginExtended.

Definition at line 50 of file kmymoneyplugin.cpp.

statementInterface()

KMyMoneyPlugin::StatementInterface * KMyMoneyPlugin::Plugin::statementInterface ( ) const

protected

Definition at line 102 of file kmymoneyplugin.cpp.

toggleAction()

KToggleAction * KMyMoneyPlugin::Plugin::toggleAction ( const QString & name ) const

protected

See KMyMoneyApp::toggleAction() for a description.

Definition at line 68 of file kmymoneyplugin.cpp.

unplug

void KMyMoneyPlugin::Plugin::unplug ( )

virtualslot

Called before unloading.

Reimplemented in KMyMoneyPlugin::OnlinePluginExtended.

Definition at line 55 of file kmymoneyplugin.cpp.

updateActions

void KMyMoneyPlugin::Plugin::updateActions ( const SelectedObjects & selections )

virtualslot

This method is called by the application whenever a selection changes.

The default implementation does nothing.

Definition at line 59 of file kmymoneyplugin.cpp.

updateConfiguration

void KMyMoneyPlugin::Plugin::updateConfiguration ( )

virtualslot

This method is called by the application whenever the configuration changes.

The default implementation does nothing.

Definition at line 64 of file kmymoneyplugin.cpp.

viewInterface()

KMyMoneyPlugin::ViewInterface * KMyMoneyPlugin::Plugin::viewInterface ( ) const

protected

Definition at line 96 of file kmymoneyplugin.cpp.

---

The documentation for this class was generated from the following files:

• kmymoneyplugin.h
• kmymoneyplugin.cpp