AgentInstance

Search for usage in LXR

Public Types | Public Member Functions | Protected Slots | Protected Member Functions | List of all members
AgentInstance Class Referenceabstract

#include <agentinstance.h>

Inheritance diagram for AgentInstance:
Inheritance graph
[legend]

Public Types

using Ptr = QSharedPointer<AgentInstance>
 

Public Member Functions

 AgentInstance (AgentManager &manager)
 
QString agentType () const
 
virtual void cleanup ()
 
virtual void configure (qlonglong windowId)=0
 
org::freedesktop::Akonadi::Agent::Control * controlInterface () const
 
bool hasAgentInterface () const
 
bool hasPreprocessorInterface () const
 
bool hasResourceInterface () const
 
QString identifier () const
 
bool isOnline () const
 
bool obtainAgentInterface ()
 
bool obtainPreprocessorInterface ()
 
bool obtainResourceInterface ()
 
org::freedesktop::Akonadi::Preprocessor * preProcessorInterface () const
 
int progress () const
 
virtual void quit ()
 
org::freedesktop::Akonadi::Resource * resourceInterface () const
 
QString resourceName () const
 
virtual void restartWhenIdle ()=0
 
org::freedesktop::Akonadi::Agent::Search * searchInterface () const
 
void setIdentifier (const QString &identifier)
 
virtual bool start (const AgentType &agentInfo)=0
 
int status () const
 
org::freedesktop::Akonadi::Agent::Status * statusInterface () const
 
QString statusMessage () 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
 

Protected Slots

void advancedStatusChanged (const QVariantMap &status)
 
void error (const QString &msg)
 
void errorHandler (const QDBusError &error)
 
void onlineChanged (bool state)
 
void percentChanged (int percent)
 
void refreshAgentStatus ()
 
void refreshResourceStatus ()
 
void resourceNameChanged (const QString &name)
 
void statusChanged (int status, const QString &statusMsg)
 
void statusMessageChanged (const QString &msg)
 
void statusStateChanged (int status)
 
void warning (const QString &msg)
 

Protected Member Functions

void setAgentType (const QString &agentType)
 
- 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)
 

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)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

Represents one agent instance and takes care of communication with it.

The agent exposes multiple D-Bus interfaces. The Control and the Status interfaces are implemented by all the agents. The Resource and Preprocessor interfaces are obviously implemented only by the agents impersonating resources or preprocessors.

Definition at line 34 of file akonadicontrol/agentinstance.h.

Member Typedef Documentation

◆ Ptr

using AgentInstance::Ptr = QSharedPointer<AgentInstance>

Definition at line 38 of file akonadicontrol/agentinstance.h.

Constructor & Destructor Documentation

◆ AgentInstance()

AgentInstance::AgentInstance ( AgentManager & manager)
explicit

Definition at line 12 of file akonadicontrol/agentinstance.cpp.

◆ ~AgentInstance()

AgentInstance::~AgentInstance ( )
overridedefault

Definition at line 28 of file core/agentinstance.cpp.

Member Function Documentation

◆ advancedStatusChanged

void AgentInstance::advancedStatusChanged ( const QVariantMap & status)
protectedslot

Definition at line 94 of file akonadicontrol/agentinstance.cpp.

◆ agentType()

QString AgentInstance::agentType ( ) const
inlinenodiscard

Definition at line 54 of file akonadicontrol/agentinstance.h.

◆ cleanup()

void AgentInstance::cleanup ( )
virtual

Definition at line 28 of file akonadicontrol/agentinstance.cpp.

◆ configure()

void AgentInstance::configure ( qlonglong windowId)
pure virtual

Definition at line 92 of file core/agentinstance.cpp.

◆ controlInterface()

org::freedesktop::Akonadi::Agent::Control * AgentInstance::controlInterface ( ) const
inline

Definition at line 105 of file akonadicontrol/agentinstance.h.

◆ error

void AgentInstance::error ( const QString & msg)
protectedslot

Definition at line 123 of file akonadicontrol/agentinstance.cpp.

◆ errorHandler

void AgentInstance::errorHandler ( const QDBusError & error)
protectedslot

Definition at line 173 of file akonadicontrol/agentinstance.cpp.

◆ hasAgentInterface()

bool AgentInstance::hasAgentInterface ( ) const
inlinenodiscard

Definition at line 95 of file akonadicontrol/agentinstance.h.

◆ hasPreprocessorInterface()

bool AgentInstance::hasPreprocessorInterface ( ) const
inlinenodiscard

Definition at line 100 of file akonadicontrol/agentinstance.h.

◆ hasResourceInterface()

bool AgentInstance::hasResourceInterface ( ) const
inlinenodiscard

Definition at line 90 of file akonadicontrol/agentinstance.h.

◆ identifier()

QString AgentInstance::identifier ( ) const
inlinenodiscard

Set/get the unique identifier of this AgentInstance.

Definition at line 44 of file akonadicontrol/agentinstance.h.

◆ isOnline()

bool AgentInstance::isOnline ( ) const
inlinenodiscard

Definition at line 74 of file akonadicontrol/agentinstance.h.

◆ obtainAgentInterface()

bool AgentInstance::obtainAgentInterface ( )

Definition at line 35 of file akonadicontrol/agentinstance.cpp.

◆ obtainPreprocessorInterface()

bool AgentInstance::obtainPreprocessorInterface ( )

Definition at line 78 of file akonadicontrol/agentinstance.cpp.

◆ obtainResourceInterface()

bool AgentInstance::obtainResourceInterface ( )

Definition at line 65 of file akonadicontrol/agentinstance.cpp.

◆ onlineChanged

void AgentInstance::onlineChanged ( bool state)
protectedslot

Definition at line 128 of file akonadicontrol/agentinstance.cpp.

◆ percentChanged

void AgentInstance::percentChanged ( int percent)
protectedslot

Definition at line 109 of file akonadicontrol/agentinstance.cpp.

◆ preProcessorInterface()

org::freedesktop::Akonadi::Preprocessor * AgentInstance::preProcessorInterface ( ) const
inline

Definition at line 125 of file akonadicontrol/agentinstance.h.

◆ progress()

int AgentInstance::progress ( ) const
inlinenodiscard

Definition at line 69 of file akonadicontrol/agentinstance.h.

◆ quit()

void AgentInstance::quit ( )
virtual

Definition at line 19 of file akonadicontrol/agentinstance.cpp.

◆ refreshAgentStatus

void AgentInstance::refreshAgentStatus ( )
protectedslot

Definition at line 146 of file akonadicontrol/agentinstance.cpp.

◆ refreshResourceStatus

void AgentInstance::refreshResourceStatus ( )
protectedslot

Definition at line 163 of file akonadicontrol/agentinstance.cpp.

◆ resourceInterface()

org::freedesktop::Akonadi::Resource * AgentInstance::resourceInterface ( ) const
inline

Definition at line 120 of file akonadicontrol/agentinstance.h.

◆ resourceName()

QString AgentInstance::resourceName ( ) const
inlinenodiscard

Definition at line 79 of file akonadicontrol/agentinstance.h.

◆ resourceNameChanged

void AgentInstance::resourceNameChanged ( const QString & name)
protectedslot

Definition at line 137 of file akonadicontrol/agentinstance.cpp.

◆ searchInterface()

org::freedesktop::Akonadi::Agent::Search * AgentInstance::searchInterface ( ) const
inline

Definition at line 115 of file akonadicontrol/agentinstance.h.

◆ setAgentType()

void AgentInstance::setAgentType ( const QString & agentType)
inlineprotected

Definition at line 155 of file akonadicontrol/agentinstance.h.

◆ setIdentifier()

void AgentInstance::setIdentifier ( const QString & identifier)
inline

Definition at line 49 of file akonadicontrol/agentinstance.h.

◆ status()

AgentInstance::Status AgentInstance::status ( ) const
inlinenodiscard

Definition at line 59 of file akonadicontrol/agentinstance.h.

◆ statusChanged

void AgentInstance::statusChanged ( int status,
const QString & statusMsg )
protectedslot

Definition at line 84 of file akonadicontrol/agentinstance.cpp.

◆ statusInterface()

org::freedesktop::Akonadi::Agent::Status * AgentInstance::statusInterface ( ) const
inline

Definition at line 110 of file akonadicontrol/agentinstance.h.

◆ statusMessage()

QString AgentInstance::statusMessage ( ) const
inlinenodiscard

Definition at line 64 of file akonadicontrol/agentinstance.h.

◆ statusMessageChanged

void AgentInstance::statusMessageChanged ( const QString & msg)
protectedslot

Definition at line 104 of file akonadicontrol/agentinstance.cpp.

◆ statusStateChanged

void AgentInstance::statusStateChanged ( int status)
protectedslot

Definition at line 99 of file akonadicontrol/agentinstance.cpp.

◆ warning

void AgentInstance::warning ( const QString & msg)
protectedslot

Definition at line 118 of file akonadicontrol/agentinstance.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri May 2 2025 11:53:10 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.