KMyMoneyPlugin::OnlinePluginExtended

Search for usage in LXR

KMyMoneyPlugin::OnlinePluginExtended Class Referenceabstract

#include <onlinepluginextended.h>

Inheritance diagram for KMyMoneyPlugin::OnlinePluginExtended:

Signals

void jobAvailable (QString accountId, QString)
 
void jobAvailable (QString accountId, QStringList)
 
void jobUnavailable (QString accountId, QString)
 

Public Member Functions

 OnlinePluginExtended (QObject *parent, const KPluginMetaData &metaData, const QVariantList &args)
 
virtual QStringList availableJobs (QString accountId) const =0
 
virtual void plug (KXMLGUIFactory *guiFactory) override=0
 
virtual void sendOnlineJob (QList< onlineJob > &jobs)=0
 
virtual IonlineTaskSettings::ptr settings (QString accountId, QString taskName)=0
 
virtual void unplug () override=0
 
- Public Member Functions inherited from KMyMoneyPlugin::Plugin
 Plugin (QObject *parent, const KPluginMetaData &metaData, const QVariantList &args)
 
QString componentDisplayName () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
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 () const const
 
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 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 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_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
 
qobject_cast (const QObject *object)
 
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)
 
QThreadthread () const const
 
- Public Member Functions inherited from KXMLGUIClient
 KXMLGUIClient (KXMLGUIClient *parent)
 
virtual QActionaction (const QDomElement &element) const
 
QActionaction (const QString &name) 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
 
- Public Member Functions inherited from KMyMoneyPlugin::OnlinePlugin
virtual QWidgetaccountConfigTab (const MyMoneyAccount &account, QString &tabName)=0
 
virtual bool mapAccount (const MyMoneyAccount &acc, MyMoneyKeyValueContainer &onlineBankingSettings)=0
 
virtual MyMoneyKeyValueContainer onlineBankingSettings (const MyMoneyKeyValueContainer &current)=0
 
virtual void protocols (QStringList &protocolList) const =0
 
virtual bool updateAccount (const MyMoneyAccount &acc, bool moreAccounts=false)=0
 

Additional Inherited Members

- Public Types inherited from QObject
typedef  QObjectList
 
- Properties inherited from QObject
 objectName
 
- Public Slots inherited from KMyMoneyPlugin::Plugin
virtual void updateActions (const SelectedObjects &selections)
 
virtual void updateConfiguration ()
 
- 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)
 
- Protected Member Functions inherited from KMyMoneyPlugin::Plugin
AppInterface * appInterface () const
 
ImportInterfaceimportInterface () const
 
StatementInterfacestatementInterface () const
 
KToggleActiontoggleAction (const QString &name) const
 
ViewInterfaceviewInterface () 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
 
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)
 
- Static Protected Member Functions inherited from KXMLGUIClient
static QString standardsXmlFileLocation ()
 

Detailed Description

Interface between KMyMoney and Online Banking plugins for executing transactions.

This interface is under active development and will change often! Do not use it at the moment!

Author
Christian David (chris.nosp@m.tian.nosp@m.-davi.nosp@m.d@we.nosp@m.b.de)

Definition at line 29 of file onlinepluginextended.h.

Constructor & Destructor Documentation

◆ OnlinePluginExtended()

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

Definition at line 12 of file onlinepluginextended.cpp.

◆ ~OnlinePluginExtended()

virtual KMyMoneyPlugin::OnlinePluginExtended::~OnlinePluginExtended ( )
inlinevirtual

Definition at line 35 of file onlinepluginextended.h.

Member Function Documentation

◆ availableJobs()

virtual QStringList KMyMoneyPlugin::OnlinePluginExtended::availableJobs ( QString accountId) const
pure virtual

List onlineJobs supported by an account.

KMyMoney will use this function to ask the online plugin which online jobs it supports. Later changes can be made public using the jobAvailable signals.

Returns
A QStringList with supported onlineTask::name()s as values.

◆ jobAvailable

void KMyMoneyPlugin::OnlinePluginExtended::jobAvailable ( QString accountId,
QString  )
signal

Emit to make onlineJob available.

In case a onlineJob got available during runtime, emit one of these signals.

◆ plug()

virtual void KMyMoneyPlugin::OnlinePluginExtended::plug ( KXMLGUIFactory * guiFactory)
overridepure virtual

Called during plug in process.

Reimplemented from KMyMoneyPlugin::Plugin.

◆ sendOnlineJob()

virtual void KMyMoneyPlugin::OnlinePluginExtended::sendOnlineJob ( QList< onlineJob > & jobs)
pure virtual

Send onlineJobs to bank.

Parameters
jobsDo not delete the onlineJob objects. You can edit them but expect them to be deleted after you returned from this function.

◆ settings()

virtual IonlineTaskSettings::ptr KMyMoneyPlugin::OnlinePluginExtended::settings ( QString accountId,
QString taskName )
pure virtual

Get settings for onlineTask.

See also
onlineTask::settings

◆ unplug()

virtual void KMyMoneyPlugin::OnlinePluginExtended::unplug ( )
overridepure virtual

Called before unloading.

Reimplemented from KMyMoneyPlugin::Plugin.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 29 2024 11:48:50 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.