Differential D13034 Diff 43304 src/core/kconfigwatcher.h

Changeset View

Standalone View

src/core/kconfigwatcher.h

This file was added.

1		/*
2		* Copyright 2018 David Edmundson <davidedmundson@kde.org>
3		*
4		* This program is free software; you can redistribute it and/or modify
5		* it under the terms of the GNU Library General Public License as
6		* published by the Free Software Foundation; either version 2, or
7		* (at your option) any later version.
8		*
9		* This program is distributed in the hope that it will be useful,
10		* but WITHOUT ANY WARRANTY; without even the implied warranty of
11		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12		* GNU General Public License for more details
13		*
14		* You should have received a copy of the GNU Library General Public
15		* License along with this program; if not, write to the
16		* Free Software Foundation, Inc.,
17		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18		*/
19
20		#ifndef KCONFIGWATCHER_H
21		#define KCONFIGWATCHER_H
22
23		#include <QObject>
24
25		#include <KSharedConfig>
26		#include <KConfigGroup>
27
28		#include <kconfigcore_export.h>
29
30		class KConfigWatcherPrivate;
31
32		/*
33		* Notifies when another client has updated this config file with the Notify flag set.
34		* @since 5.51
35		*/
	dfaureUnsubmitted Not Done 51 dfaure: 51
36		class KCONFIGCORE_EXPORT KConfigWatcher: public QObject
37		{
38		Q_OBJECT
39		public:
40		typedef QSharedPointer<KConfigWatcher> Ptr;
41
42		/*
43		* Instantiate a ConfigWatcher for a given config
44		*
45		* @note any additional config sources should be set before this point.
46		*/
47		static Ptr create(const KSharedConfig::Ptr &config);
48
49		Q_SIGNALS:
50		/**
51		* Emitted when a config group has changed
52		* The config will be reloaded before this signal is emitted
53		*
54		* @arg group the config group that has changed
55		* @arg names a list of entries that have changed within that group
56		*/
57		void configChanged(const KConfigGroup &group, const QByteArrayList &names);
58
59		private Q_SLOTS:
60		void onConfigChangeNotification(const QHash<QString, QByteArrayList> &changes);
61
	dfaureUnsubmitted Done const ref dfaure: const ref
62		private:
63		KConfigWatcher(const KSharedConfig::Ptr &config);
64		Q_DISABLE_COPY(KConfigWatcher)
65		KConfigWatcherPrivate *const d;
66		};
67
68		#endif