KDECore

kconfig.h

00001 /*
00002    This file is part of the KDE libraries
00003    Copyright (c) 2006, 2007 Thomas Braxton <kde.braxton@gmail.com>
00004    Copyright (c) 2001 Waldo Bastian <bastian@kde.org>
00005    Copyright (c) 1999 Preston Brown <pbrown@kde.org>
00006    Copyright (c) 1997 Matthias Kalle Dalheimer <kalle@kde.org>
00007 
00008    This library is free software; you can redistribute it and/or
00009    modify it under the terms of the GNU Library General Public
00010    License as published by the Free Software Foundation; either
00011    version 2 of the License, or (at your option) any later version.
00012 
00013    This library is distributed in the hope that it will be useful,
00014    but WITHOUT ANY WARRANTY; without even the implied warranty of
00015    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00016    Library General Public License for more details.
00017 
00018    You should have received a copy of the GNU Library General Public License
00019    along with this library; see the file COPYING.LIB.  If not, write to
00020    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
00021    Boston, MA 02110-1301, USA.
00022 */
00023 
00024 #ifndef KCONFIG_H
00025 #define KCONFIG_H
00026 
00027 #include "kconfigbase.h"
00028 
00029 #include <kdecore_export.h>
00030 
00031 #include <QtCore/QString>
00032 #include <QtCore/QVariant>
00033 #include <QtCore/QByteArray>
00034 #include <QtCore/QList>
00035 
00036 class KConfigGroup;
00037 class KComponentData;
00038 class KEntryMap;
00039 class KConfigPrivate;
00040 
00041 class KDECORE_EXPORT KConfig : public KConfigBase
00042 {
00043 public:
00044     enum OpenFlag {
00045         IncludeGlobals  = 0x01, 
00046         CascadeConfig   = 0x02, 
00047 
00050         SimpleConfig    = 0x00, 
00051         NoCascade       = IncludeGlobals, 
00052         NoGlobals       = CascadeConfig, 
00053         FullConfig      = IncludeGlobals|CascadeConfig 
00054     };
00055     Q_DECLARE_FLAGS(OpenFlags, OpenFlag)
00056 
00057     explicit KConfig(const QString& file = QString(), OpenFlags mode = FullConfig,
00058                      const char* resourceType = "config");
00059 
00060     explicit KConfig(const KComponentData& componentData, const QString& file = QString(),
00061                      OpenFlags mode = FullConfig, const char* resourceType = "config");
00062 
00063     virtual ~KConfig();
00064 
00065     const KComponentData &componentData() const; // krazy:exclude=constref
00066 
00070     QString name() const;
00071 
00073     void sync();
00074 
00076     void markAsClean();
00077 
00080     AccessMode accessMode() const;
00081 
00082     bool isConfigWritable(bool warnUser);
00084 
00095     KConfig* copyTo(const QString &file, KConfig *config=0) const;
00096 
00110     void checkUpdate(const QString &id, const QString &updateFile);
00111 
00116     void reparseConfiguration();
00117 
00119 
00132     void addConfigSources(const QStringList &sources);
00133 
00136 
00139     QString locale() const;
00147     bool setLocale(const QString& aLocale);
00149 
00151 
00156     void setReadDefaults(bool b);
00157     bool readDefaults() const;
00159 
00162     bool isImmutable() const;
00164 
00166 
00172     KDE_DEPRECATED void setForceGlobal(bool force);
00179     KDE_DEPRECATED bool forceGlobal() const;
00181 
00183     QStringList groupList() const;
00184 
00197     QMap<QString, QString> entryMap(const QString &aGroup=QString()) const;
00198 
00199 protected:
00200     virtual bool hasGroupImpl(const QByteArray &group) const;
00201     virtual KConfigGroup groupImpl( const QByteArray &b);
00202     virtual const KConfigGroup groupImpl(const QByteArray &b) const;
00203     virtual void deleteGroupImpl(const QByteArray &group, WriteConfigFlags flags = Normal);
00204     virtual bool isGroupImmutableImpl(const QByteArray& aGroup) const;
00205 
00206     friend class KConfigGroup;
00207     friend class KConfigGroupPrivate;
00208 
00212     virtual void virtual_hook( int id, void* data );
00213 
00214     KConfigPrivate *const d_ptr;
00215 
00216     KConfig(KConfigPrivate &d);
00217 
00218 private:
00219     QStringList keyList(const QString& aGroup=QString()) const;
00220 
00221     Q_DISABLE_COPY(KConfig)
00222 
00223     Q_DECLARE_PRIVATE(KConfig)
00224 };
00225 Q_DECLARE_OPERATORS_FOR_FLAGS( KConfig::OpenFlags )
00226 
00227 #endif // KCONFIG_H
KDECore

kconfig.h

KDECore

kdelibs
