Konsole::SessionTask Class Reference

#include <SessionController.h>

Inheritance diagram for Konsole::SessionTask:

Signals
void	completed (bool success)

Public Member Functions
	SessionTask (QObject *parent=0)
void	addSession (Session *session)
bool	autoDelete () const
virtual void	execute ()=0
void	setAutoDelete (bool enable)

Protected Member Functions
QList< SessionPtr >	sessions () const

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 377 of file SessionController.h.

Constructor & Destructor Documentation

SessionTask::SessionTask ( QObject *  parent = 0 )

explicit

Definition at line 1640 of file SessionController.cpp.

Member Function Documentation

void SessionTask::addSession

(

Session *

session

)

Adds a new session to the group.

Definition at line 1653 of file SessionController.cpp.

bool SessionTask::autoDelete

(

)

const

Returns true if the task automatically deletes itself.

See setAutoDelete()

Definition at line 1649 of file SessionController.cpp.

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

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::SearchHistoryTask, and Konsole::SaveHistoryTask.

QList< SessionPtr > SessionTask::sessions ( ) const

protected

Returns a list of sessions in the group.

Definition at line 1657 of file SessionController.cpp.

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 1645 of file SessionController.cpp.

---

The documentation for this class was generated from the following files:

• SessionController.h
• SessionController.cpp