• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

Konsole

Konsole::SessionTask

Konsole::SessionTask Class Reference

#include <SessionController.h>

Inheritance diagram for Konsole::SessionTask:

Inheritance graph
[legend]

List of all members.


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


Signals

void completed (bool success)

Public Member Functions

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

Protected Member Functions

QList< SessionPtr > sessions () const

Constructor & Destructor Documentation

SessionTask::SessionTask ( QObject *  parent = 0  ) 

Definition at line 1139 of file SessionController.cpp.


Member Function Documentation

void SessionTask::addSession ( Session *  session  ) 

Adds a new session to the group.

Definition at line 1152 of file SessionController.cpp.

bool SessionTask::autoDelete (  )  const

Returns true if the task automatically deletes itself.

See setAutoDelete()

Definition at line 1148 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::SaveHistoryTask, and Konsole::SearchHistoryTask.

QList< SessionPtr > SessionTask::sessions (  )  const [protected]

Returns a list of sessions in the group.

Definition at line 1156 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 1144 of file SessionController.cpp.


The documentation for this class was generated from the following files:
  • SessionController.h
  • SessionController.cpp

Konsole

Skip menu "Konsole"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

API Reference

Skip menu "API Reference"
  • Konsole
  • Libraries
  •   libkonq
Generated for API Reference by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal