akonadi
#include <agentinstance.h>
Classes | |
class | Private |
Public Types | |
typedef QList< AgentInstance > | List |
enum | Status { Idle = 0, Running, Broken } |
Public Member Functions | |
AgentInstance () | |
AgentInstance (const AgentInstance &other) | |
~AgentInstance () | |
void | abortCurrentTask () const |
void | configure (QWidget *parent=0) |
QString | identifier () const |
bool | isOnline () const |
bool | isValid () const |
QString | name () const |
AgentInstance & | operator= (const AgentInstance &other) |
bool | operator== (const AgentInstance &other) const |
int | progress () const |
void | reconfigure () const |
void | restart () const |
void | setIsOnline (bool online) |
void | setName (const QString &name) |
Status | status () const |
QString | statusMessage () const |
void | synchronize () |
void | synchronizeCollectionTree () |
AgentType | type () const |
Detailed Description
A representation of an agent instance.
The agent instance is a representation of a running agent process. It provides information about the instance and a reference to the AgentType of that instance.
All available agent instances can be retrieved from the AgentManager.
Akonadi::AgentInstance::List instances = Akonadi::AgentManager::self()->instances(); foreach ( const Akonadi::AgentInstance &instance, instances ) { qDebug() << "Name:" << instance.name() << "(" << instance.identifier() << ")"; }
Member Typedef Documentation
typedef QList<AgentInstance> Akonadi::AgentInstance::List |
Describes a list of agent instances.
Definition at line 67 of file agentinstance.h.
Member Enumeration Documentation
Describes the status of the agent instance.
- Enumerator:
Idle The agent instance does currently nothing.
Running The agent instance is working on something.
Broken The agent instance encountered an error state.
Definition at line 72 of file agentinstance.h.
Constructor & Destructor Documentation
AgentInstance::AgentInstance | ( | ) |
Creates a new agent instance object.
Definition at line 30 of file agentinstance.cpp.
AgentInstance::AgentInstance | ( | const AgentInstance & | other | ) |
Creates an agent instance from an other
agent instance.
Definition at line 35 of file agentinstance.cpp.
AgentInstance::~AgentInstance | ( | ) |
Destroys the agent instance object.
Definition at line 40 of file agentinstance.cpp.
Member Function Documentation
void AgentInstance::abortCurrentTask | ( | ) | const |
Tell the agent to abort its current operation.
- Since:
- 4.4
Definition at line 131 of file agentinstance.cpp.
void AgentInstance::configure | ( | QWidget * | parent = 0 | ) |
Triggers the agent instance to show its configuration dialog.
- Parameters:
-
parent Parent window for the configuration dialog.
Definition at line 103 of file agentinstance.cpp.
QString AgentInstance::identifier | ( | ) | const |
Returns the unique identifier of the agent instance.
Definition at line 55 of file agentinstance.cpp.
bool AgentInstance::isOnline | ( | ) | const |
Returns whether the agent instance is online currently.
Definition at line 93 of file agentinstance.cpp.
bool AgentInstance::isValid | ( | ) | const |
Returns whether the agent instance object is valid.
Definition at line 44 of file agentinstance.cpp.
QString AgentInstance::name | ( | ) | const |
Returns the user visible name of the agent instance.
Definition at line 65 of file agentinstance.cpp.
AgentInstance & AgentInstance::operator= | ( | const AgentInstance & | other | ) |
Definition at line 118 of file agentinstance.cpp.
bool AgentInstance::operator== | ( | const AgentInstance & | other | ) | const |
Definition at line 126 of file agentinstance.cpp.
int AgentInstance::progress | ( | ) | const |
Returns the progress of the agent instance in percent, or -1 if no progress information are available.
Definition at line 88 of file agentinstance.cpp.
void AgentInstance::reconfigure | ( | ) | const |
Tell the agent that its configuration has been changed remotely via D-Bus.
Definition at line 146 of file agentinstance.cpp.
void Akonadi::AgentInstance::restart | ( | ) | const |
Restart the agent process.
Definition at line 161 of file agentinstance.cpp.
void AgentInstance::setIsOnline | ( | bool | online | ) |
Sets online
status of the agent instance.
Definition at line 98 of file agentinstance.cpp.
void AgentInstance::setName | ( | const QString & | name | ) |
Sets the user visible name
of the agent instance.
Definition at line 60 of file agentinstance.cpp.
AgentInstance::Status AgentInstance::status | ( | ) | const |
Returns the status of the agent instance.
Definition at line 70 of file agentinstance.cpp.
QString AgentInstance::statusMessage | ( | ) | const |
Returns a textual presentation of the status of the agent instance.
Definition at line 83 of file agentinstance.cpp.
void AgentInstance::synchronize | ( | ) |
Triggers the agent instance to start synchronization.
Definition at line 108 of file agentinstance.cpp.
void AgentInstance::synchronizeCollectionTree | ( | ) |
Triggers a synchronization of the collection tree by the given agent instance.
Definition at line 113 of file agentinstance.cpp.
AgentType AgentInstance::type | ( | ) | const |
Returns the agent type of this instance.
Definition at line 50 of file agentinstance.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Thu Aug 2 2012 15:25:23 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.