mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-23 10:22:50 +00:00
123 lines
3.5 KiB
C++
123 lines
3.5 KiB
C++
/*
|
|
Copyright (c) 2007 Volker Krause <vkrause@kde.org>
|
|
|
|
This library is free software; you can redistribute it and/or modify it
|
|
under the terms of the GNU Library General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or (at your
|
|
option) any later version.
|
|
|
|
This library 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 Library General Public
|
|
License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public License
|
|
along with this library; see the file COPYING.LIB. If not, write to the
|
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef AKONADI_CHANGERECORDER_H
|
|
#define AKONADI_CHANGERECORDER_H
|
|
|
|
#include <akonadi/monitor.h>
|
|
|
|
#include <QSettings>
|
|
|
|
namespace Akonadi {
|
|
|
|
class ChangeRecorderPrivate;
|
|
|
|
/**
|
|
* @short Records and replays change notification.
|
|
*
|
|
* This class is responsible for recording change notifications while
|
|
* an agent is not online and replaying the notifications when the agent
|
|
* is online again. Therefore the agent doesn't have to care about
|
|
* online/offline mode in its synchronization algorithm.
|
|
*
|
|
* Unlike Akonadi::Monitor this class only emits one change signal at a
|
|
* time. To receive the next one you need to explicitly call replayNext().
|
|
* If a signal is emitted that has no receivers, it's automatically skipped,
|
|
* which means you only need to connect to signals you are actually interested
|
|
* in.
|
|
*
|
|
* @author Volker Krause <vkrause@kde.org>
|
|
*/
|
|
class AKONADI_EXPORT ChangeRecorder : public Monitor
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
/**
|
|
* Creates a new change recorder.
|
|
*/
|
|
explicit ChangeRecorder(QObject *parent = 0);
|
|
|
|
/**
|
|
* Destroys the change recorder.
|
|
* All not yet processed changes are written back to the config file.
|
|
*/
|
|
~ChangeRecorder();
|
|
|
|
/**
|
|
* Sets the QSettings object used for persistent recorded changes.
|
|
*/
|
|
void setConfig(QSettings *settings);
|
|
|
|
/**
|
|
* Returns whether there are recorded changes.
|
|
*/
|
|
bool isEmpty() const;
|
|
|
|
/**
|
|
* Removes the previously emitted change from the records.
|
|
*/
|
|
void changeProcessed();
|
|
|
|
/**
|
|
* Enables change recording. If change recording is disabled, this class
|
|
* behaves exactly like Akonadi::Monitor.
|
|
* Change recording is enabled by default.
|
|
* @param enable @c false to disable change recording. @c true by default
|
|
*/
|
|
void setChangeRecordingEnabled(bool enable);
|
|
|
|
/**
|
|
* Debugging: dump current list of notifications, as saved on disk.
|
|
*/
|
|
QString dumpNotificationListToString() const;
|
|
|
|
public Q_SLOTS:
|
|
/**
|
|
* Replay the next change notification and erase the previous one from the record.
|
|
*/
|
|
void replayNext();
|
|
|
|
Q_SIGNALS:
|
|
/**
|
|
* Emitted when new changes are recorded.
|
|
*/
|
|
void changesAdded();
|
|
|
|
/**
|
|
* Emitted when replayNext() was called, but there was no valid change to replay.
|
|
* This can happen when all pending changes have been filtered out, for example.
|
|
* You only need to connect to this signal if you rely on one signal being emitted
|
|
* as a result of calling replayNext().
|
|
*/
|
|
void nothingToReplay();
|
|
|
|
protected:
|
|
//@cond PRIVATE
|
|
explicit ChangeRecorder(ChangeRecorderPrivate *d, QObject *parent = 0);
|
|
//@endcond
|
|
|
|
private:
|
|
//@cond PRIVATE
|
|
Q_DECLARE_PRIVATE(ChangeRecorder)
|
|
//@endcond
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|