akonadi
Akonadi::AgentInstance Class Reference
A representation of an agent instance. More...
#include <agentinstance.h>
Public Types | |
typedef QList< AgentInstance > | List |
enum | Status { Idle = 0, Running, Broken } |
Public Member Functions | |
AgentInstance (const AgentInstance &other) | |
AgentInstance () | |
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 | setIsOnline (bool online) |
void | setName (const QString &name) |
Status | status () const |
QString | statusMessage () const |
void | synchronize () |
void | synchronizeCollectionTree () |
AgentType | type () const |
~AgentInstance () |
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() << ")"; }
Definition at line 58 of file agentinstance.h.
Member Typedef Documentation
typedef QList<AgentInstance> Akonadi::AgentInstance::List |
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 | ( | ) |
AgentInstance::AgentInstance | ( | const AgentInstance & | other | ) |
Creates an agent instance from an other
agent instance.
Definition at line 33 of file agentinstance.cpp.
AgentInstance::~AgentInstance | ( | ) |
Member Function Documentation
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 101 of file agentinstance.cpp.
QString AgentInstance::identifier | ( | ) | const |
Returns the unique identifier of the agent instance.
Definition at line 53 of file agentinstance.cpp.
bool AgentInstance::isOnline | ( | ) | const |
Returns whether the agent instance is online currently.
Definition at line 91 of file agentinstance.cpp.
bool AgentInstance::isValid | ( | ) | const |
Returns whether the agent instance object is valid.
Definition at line 42 of file agentinstance.cpp.
QString AgentInstance::name | ( | ) | const |
Returns the user visible name of the agent instance.
Definition at line 63 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 86 of file agentinstance.cpp.
void AgentInstance::setIsOnline | ( | bool | online | ) |
void AgentInstance::setName | ( | const QString & | name | ) |
AgentInstance::Status AgentInstance::status | ( | ) | const |
QString AgentInstance::statusMessage | ( | ) | const |
Returns a textual presentation of the status of the agent instance.
Definition at line 81 of file agentinstance.cpp.
void AgentInstance::synchronize | ( | ) |
Triggers the agent instance to start synchronization.
Definition at line 106 of file agentinstance.cpp.
void AgentInstance::synchronizeCollectionTree | ( | ) |
Triggers a synchronization of the collection tree by the given agent instance.
Definition at line 111 of file agentinstance.cpp.
AgentType AgentInstance::type | ( | ) | const |
The documentation for this class was generated from the following files: