KDE 4.0 API Reference kopete/libkopete
Kopete::Task Class Reference
#include <kopetetask.h>
Detailed Description
Base class for all Kopete task.A Task is an encapsulation of a set of commands and data that perform a given task. In our case, a task can contain one or many sub tasks that will help the parent task to do its job.
For implementers, you should let the sub tasks do their job before doing something in the parent task. Like for example a sub task will modify the server list contact list or other things.
It is a really good idea to always call base start() method because it execute all sub tasks.
Some sub tasks are specific to a protocol and they are created using the factory method Kopete::Protocol::createProtocolTask(). See the documentation of this method for more information.
Definition at line 49 of file kopetetask.h.
Public Types | |
| enum | KopeteTaskError { NoProtocolSubTaskError = KJob::UserDefinedError+1, NetworkUnavailableError } |
Public Member Functions | |
| Task (QObject *parent=0) | |
| virtual | ~Task () |
| void | addSubTask (KJob *task) |
| virtual void | start () |
Member Enumeration Documentation
Common error code for Kopete tasks.
- Enumerator:
-
NoProtocolSubTaskError Forgot to add the protocol subtask for deleting the contact. NetworkUnavailableError The network is unavailable and thus cannot delete the contact.
Definition at line 56 of file kopetetask.h.
Constructor & Destructor Documentation
| Kopete::Task::Task | ( | QObject * | parent = 0 |
) |
| Kopete::Task::~Task | ( | ) | [virtual] |
Member Function Documentation
| void Kopete::Task::addSubTask | ( | KJob * | task | ) |
| void Kopete::Task::start | ( | ) | [virtual] |
Execute the task.
The default behavior for the start() here is to execute all subjobs if they are available.
For definition of classes in libkopete, start() should implement the default behavior for the kind of task.
For example, for DeleteContactTask, the default behavior should call deleteLater() on contact instance.
Reimplemented in Kopete::ProcessMessageTask, and Kopete::DeleteContactTask.
Definition at line 46 of file kopetetask.cpp.
The documentation for this class was generated from the following files:
