KDE 4.0 API Reference Konsole
Konsole::SessionTask Class Reference
#include <SessionController.h>
Detailed Description
Abstract class representing a task which can be performed on a group of sessions.Create a new instance of the appropriate sub-class for the task you want to perform and call the addSession() method to add each session which needs to be processed.
Finally, call the execute() method to perform the sub-class specific action on each of the sessions.
Definition at line 273 of file SessionController.h.
Signals | |
| void | completed (bool success) |
Public Member Functions | |
| SessionTask (QObject *parent=0) | |
| void | setAutoDelete (bool enable) |
| bool | autoDelete () const |
| void | addSession (Session *session) |
| virtual void | execute ()=0 |
Protected Member Functions | |
| QList< SessionPtr > | sessions () const |
Constructor & Destructor Documentation
| SessionTask::SessionTask | ( | QObject * | parent = 0 |
) |
Definition at line 1041 of file SessionController.cpp.
Member Function Documentation
| void SessionTask::setAutoDelete | ( | bool | enable | ) |
Sets whether the task automatically deletes itself when the task has been finished.
Depending on whether the task operates synchronously or asynchronously, the deletion may be scheduled immediately after execute() returns or it may happen some time later.
Definition at line 1046 of file SessionController.cpp.
| bool SessionTask::autoDelete | ( | ) | const |
Returns true if the task automatically deletes itself.
See setAutoDelete()
Definition at line 1050 of file SessionController.cpp.
| void SessionTask::addSession | ( | Session * | session | ) |
| virtual void Konsole::SessionTask::execute | ( | ) | [pure virtual] |
Executes the task on each of the sessions in the group.
The completed() signal is emitted when the task is finished, depending on the specific sub-class execute() may be synchronous or asynchronous
Implemented in Konsole::SaveHistoryTask, and Konsole::SearchHistoryTask.
| void Konsole::SessionTask::completed | ( | bool | success | ) | [signal] |
Emitted when the task has completed.
Depending on the task this may occur just before execute() returns, or it may occur later
- Parameters:
-
success Indicates whether the task completed successfully or not
| QList< SessionPtr > SessionTask::sessions | ( | ) | const [protected] |
The documentation for this class was generated from the following files:
