KConfigBackEnd Class Reference
#include <kconfigbackend.h>
Inheritance diagram for KConfigBackEnd:

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>
Definition at line 48 of file kconfigbackend.h.
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) |
KLockFile::Ptr | lockFile (bool bGlobal=false) |
KDE_DEPRECATED QString | filename () const |
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 |
Constructor & Destructor Documentation
|
Constructs a configuration back end.
Definition at line 296 of file kconfigbackend.cpp. |
|
Destructs the configuration backend.
Definition at line 306 of file kconfigbackend.cpp. |
Member Function Documentation
|
Changes the filenames associated with this back end. You should probably reparse your config info after doing this.
Definition at line 243 of file kconfigbackend.cpp. |
|
Check whether the config files are writable.
Definition at line 1151 of file kconfigbackend.cpp. |
|
Definition at line 162 of file kconfigbackend.h. |
|
Returns the filename as passed to the constructor.
Definition at line 120 of file kconfigbackend.h. |
|
Returns the state of the app-config object.
Definition at line 113 of file kconfigbackend.h. |
|
Returns a lock file object for the configuration file.
Definition at line 269 of file kconfigbackend.cpp. |
|
Parses all configuration files for a configuration object. This method must be reimplemented by the derived classes.
Implemented in KConfigINIBackEnd. |
|
Returns the resource type as passed to the constructor.
Definition at line 126 of file kconfigbackend.h. |
|
Set the file mode for newly created files.
Definition at line 311 of file kconfigbackend.cpp. |
|
Set the locale string that defines the current language.
Definition at line 133 of file kconfigbackend.h. |
|
Writes configuration data to file(s). This method must be reimplemented by the derived classes.
Implemented in KConfigINIBackEnd. |
The documentation for this class was generated from the following files: