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)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Protected Member Functions
QList< SessionPtr >	sessions () const
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

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

Constructor & Destructor Documentation

SessionTask::SessionTask ( QObject *  parent = 0 )

explicit

Definition at line 1649 of file SessionController.cpp.

Member Function Documentation

void SessionTask::addSession

(

Session *

session

)

Adds a new session to the group.

Definition at line 1662 of file SessionController.cpp.

bool SessionTask::autoDelete

(

)

const

Returns true if the task automatically deletes itself.

See setAutoDelete()

Definition at line 1658 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 1666 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 1654 of file SessionController.cpp.

---

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

• SessionController.h
• SessionController.cpp