KConfigBackEnd Class Reference
Abstract base class for KDE configuration file loading/saving. KDE Configuration file loading/saving abstract base class. More...
#include <kconfigbackend.h>
Inheritance diagram for KConfigBackEnd:

Public Member Functions | |
KConfigBackEnd (KConfigBase *_config, const QString &_fileName, const char *_resType, bool _useKDEGlobals) | |
virtual | ~KConfigBackEnd () |
virtual bool | parseConfigFiles ()=0 |
virtual void | sync (bool bMerge=true)=0 |
void | changeFileName (const QString &_fileName, const char *_resType, bool _useKDEGlobals) |
virtual KConfigBase::ConfigState | getConfigState () const |
QString | fileName () const |
const char * | resource () const |
void | setLocaleString (const QCString &_localeString) |
void | setFileWriteMode (int mode) |
bool | checkConfigFilesWritable (bool warnUser) |
KDE_DEPRECATED QString | filename () const |
KLockFile::Ptr | lockFile (bool bGlobal=false) |
Protected Member Functions | |
virtual void | virtual_hook (int id, void *data) |
Protected Attributes | |
KConfigBase * | pConfig |
QString | mfileName |
QCString | resType |
bool | useKDEGlobals: 1 |
bool | bFileImmutable: 1 |
QCString | localeString |
QString | mLocalFileName |
QString | mGlobalFileName |
KConfigBase::ConfigState | mConfigState |
int | mFileMode |
KConfigBackEndPrivate * | d |
Friends | |
class | KConfig |
class | KSharedConfig |
Detailed Description
Abstract base class for KDE configuration file loading/saving. KDE Configuration file loading/saving abstract base class.This class forms the base for all classes that implement some manner of loading/saving to configuration files. It is an abstract base class, meaning that you cannot directly instantiate objects of this class. As of right now, the only back end available is one to read/write to INI-style files, but in the future, other formats may be available, such as XML or a database.
- Author:
- Preston Brown <pbrown@kde.org>, Matthias Kalle Dalheimer <kalle@kde.org>
- Version:
- Id
- kconfigbackend.h,v 1.34 2004/05/07 12:47:15 waba Exp
Definition at line 48 of file kconfigbackend.h.
Constructor & Destructor Documentation
|
Constructs a configuration back end.
Definition at line 275 of file kconfigbackend.cpp. References changeFileName(). |
|
Destructs the configuration backend.
Definition at line 285 of file kconfigbackend.cpp. |
Member Function Documentation
|
Parses all configuration files for a configuration object. This method must be reimplemented by the derived classes.
Implemented in KConfigINIBackEnd. Referenced by KConfigBase::parseConfigFiles(). |
|
Writes configuration data to file(s). This method must be reimplemented by the derived classes.
Implemented in KConfigINIBackEnd. Referenced by KConfig::reparseConfiguration(), KSimpleConfig::sync(), and KConfigBase::sync(). |
|
Changes the filenames associated with this back end. You should probably reparse your config info after doing this.
Definition at line 222 of file kconfigbackend.cpp. References KGlobal::dirs(), and KStandardDirs::saveLocation(). Referenced by KConfig::copyTo(), KConfigBackEnd(), KDesktopFile::KDesktopFile(), and KSimpleConfig::KSimpleConfig(). |
|
Returns the state of the app-config object.
Definition at line 113 of file kconfigbackend.h. Referenced by KConfigBase::getConfigState(), and KConfigBase::parseConfigFiles(). |
|
Returns the filename as passed to the constructor.
Definition at line 120 of file kconfigbackend.h. Referenced by KDesktopFile::fileName(). |
|
Returns the resource type as passed to the constructor.
Definition at line 126 of file kconfigbackend.h. Referenced by KDesktopFile::resource(). |
|
Set the locale string that defines the current language.
Definition at line 133 of file kconfigbackend.h. Referenced by KConfigINIBackEnd::parseConfigFiles(), and KConfigBase::setLocale(). |
|
Set the file mode for newly created files.
Definition at line 290 of file kconfigbackend.cpp. Referenced by KConfig::setFileWriteMode(). |
|
Check whether the config files are writable.
Definition at line 1082 of file kconfigbackend.cpp. References KStandardDirs::findExe(), KInstance::instanceName(), and KProcess::start(). Referenced by KConfigBase::checkConfigFilesWritable(). |
|
Definition at line 155 of file kconfigbackend.h. |
|
Returns a lock file object for the configuration file.
Definition at line 248 of file kconfigbackend.cpp. Referenced by KConfig::lockFile(), and KConfigINIBackEnd::sync(). |
The documentation for this class was generated from the following files: