mirror of
https://github.com/KDE/konsole.git
synced 2026-06-11 15:35:09 -04:00
d1e18d9dda
Summary: Those three classes where *used* inside of the SessionController but they where not supposed to be there. The code in the SessionController is already too big to understand, so the removal of unrelated code is a good thing: it's now easier to reason about those other three classes without having to deal with the whole code that the SessionController has. Reviewers: #konsole, hindenburg Reviewed By: #konsole, hindenburg Subscribers: konsole-devel Tags: #konsole Differential Revision: https://phabricator.kde.org/D17485
88 lines
2.7 KiB
C++
88 lines
2.7 KiB
C++
/*
|
|
Copyright 2006-2008 by Robert Knight <robertknight@gmail.com>
|
|
Copyright 2009 by Thomas Dreibholz <dreibh@iem.uni-due.de>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
02110-1301 USA.
|
|
*/
|
|
|
|
#ifndef SESSIONTASK_H
|
|
#define SESSIONTASK_H
|
|
|
|
#include <QObject>
|
|
#include <QList>
|
|
#include <QPointer>
|
|
|
|
#include "Session.h"
|
|
|
|
namespace Konsole {
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
class SessionTask : public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
explicit SessionTask(QObject *parent = nullptr);
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
void setAutoDelete(bool enable);
|
|
/** Returns true if the task automatically deletes itself. See setAutoDelete() */
|
|
bool autoDelete() const;
|
|
|
|
/** Adds a new session to the group */
|
|
void addSession(Session *session);
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
virtual void execute() = 0;
|
|
|
|
Q_SIGNALS:
|
|
/**
|
|
* Emitted when the task has completed.
|
|
* Depending on the task this may occur just before execute() returns, or it
|
|
* may occur later
|
|
*
|
|
* @param success Indicates whether the task completed successfully or not
|
|
*/
|
|
void completed(bool success);
|
|
|
|
protected:
|
|
/** Returns a list of sessions in the group */
|
|
QList< QPointer<Session> > sessions() const;
|
|
|
|
private:
|
|
bool _autoDelete;
|
|
QList< QPointer<Session> > _sessions;
|
|
};
|
|
|
|
}
|
|
#endif
|