KDECore
#include <kconfigini_p.h>
|
| KConfigIniBackend () |
|
| ~KConfigIniBackend () |
|
KConfigBase::AccessMode | accessMode () const |
|
void | createEnclosing () |
|
bool | isLocked () const |
|
bool | isWritable () const |
|
bool | lock (const KComponentData &componentData) |
|
QString | nonWritableErrorMessage () const |
|
ParseInfo | parseConfig (const QByteArray &locale, KEntryMap &entryMap, ParseOptions options) |
|
ParseInfo | parseConfig (const QByteArray &locale, KEntryMap &entryMap, ParseOptions options, bool merging) |
|
void | setFilePath (const QString &path) |
|
void | unlock () |
|
bool | writeConfig (const QByteArray &locale, KEntryMap &entryMap, WriteOptions options, const KComponentData &data) |
|
virtual | ~KConfigBackend () |
|
virtual KConfigBase::AccessMode | accessMode () const =0 |
|
virtual void | createEnclosing ()=0 |
|
QString | filePath () const |
|
virtual bool | isLocked () const =0 |
|
virtual bool | isWritable () const =0 |
|
QDateTime | lastModified () const |
|
virtual bool | lock (const KComponentData &componentData)=0 |
|
virtual QString | nonWritableErrorMessage () const =0 |
|
virtual ParseInfo | parseConfig (const QByteArray &locale, KEntryMap &pWriteBackMap, ParseOptions options=ParseOptions())=0 |
|
virtual void | setFilePath (const QString &path)=0 |
|
qint64 | size () const |
|
virtual void | unlock ()=0 |
|
virtual bool | writeConfig (const QByteArray &locale, KEntryMap &entryMap, WriteOptions options, const KComponentData &data)=0 |
|
Definition at line 30 of file kconfigini_p.h.
◆ StringType
Enumerator |
---|
GroupString | |
KeyString | |
ValueString | |
Definition at line 61 of file kconfigini_p.h.
◆ KConfigIniBackend()
KConfigIniBackend::KConfigIniBackend |
( |
| ) |
|
◆ ~KConfigIniBackend()
KConfigIniBackend::~KConfigIniBackend |
( |
| ) |
|
◆ accessMode()
◆ charFromHex()
char KConfigIniBackend::charFromHex |
( |
const char * |
str, |
|
|
const QFile & |
file, |
|
|
int |
line |
|
) |
| |
|
staticprotected |
◆ createEnclosing()
void KConfigIniBackend::createEnclosing |
( |
| ) |
|
|
virtual |
Create the enclosing object of the configuration object.
For example, if the configuration object is a file, this should create the parent directory.
Implements KConfigBackend.
Definition at line 548 of file kconfigini.cpp.
◆ isLocked()
bool KConfigIniBackend::isLocked |
( |
| ) |
const |
|
virtual |
◆ isWritable()
bool KConfigIniBackend::isWritable |
( |
| ) |
const |
|
virtual |
◆ lock()
◆ nonWritableErrorMessage()
QString KConfigIniBackend::nonWritableErrorMessage |
( |
| ) |
const |
|
virtual |
When isWritable() returns false
, return an error message to explain to the user why saving configuration will not work.
The return value when isWritable() returns true
is undefined.
- Returns
- a translated user-visible explanation for the configuration object not being writable
Implements KConfigBackend.
Definition at line 543 of file kconfigini.cpp.
◆ parseConfig() [1/2]
Read persistent storage.
- Parameters
-
locale | the locale to read entries for (if the backend supports localized entries) |
pWriteBackMap | the KEntryMap where the entries are placed |
options | |
- See also
- ParseOptions
- Returns
- See also
- ParseInfo
Implements KConfigBackend.
Definition at line 68 of file kconfigini.cpp.
◆ parseConfig() [2/2]
◆ printableToString()
void KConfigIniBackend::printableToString |
( |
BufferFragment * |
aString, |
|
|
const QFile & |
file, |
|
|
int |
line |
|
) |
| |
|
staticprotected |
◆ setFilePath()
void KConfigIniBackend::setFilePath |
( |
const QString & |
path | ) |
|
|
virtual |
Set the file path.
- Note
path
MUST be absolute.
- Parameters
-
path | the absolute file path |
Implements KConfigBackend.
Definition at line 559 of file kconfigini.cpp.
◆ stringToPrintable()
QByteArray KConfigIniBackend::stringToPrintable |
( |
const QByteArray & |
aString, |
|
|
StringType |
type |
|
) |
| |
|
staticprotected |
◆ unlock()
void KConfigIniBackend::unlock |
( |
| ) |
|
|
virtual |
◆ warningProlog()
QString KConfigIniBackend::warningProlog |
( |
const QFile & |
file, |
|
|
int |
line |
|
) |
| |
|
staticprotected |
◆ writeConfig()
bool KConfigIniBackend::writeConfig |
( |
const QByteArray & |
locale, |
|
|
KEntryMap & |
entryMap, |
|
|
WriteOptions |
options, |
|
|
const KComponentData & |
data |
|
) |
| |
|
virtual |
Write the dirty entries to permanent storage.
- Parameters
-
locale | the locale to write entries for (if the backend supports localized entries) |
entryMap | the KEntryMap containing the config object's entries. |
options | |
- See also
- WriteOptions
- Parameters
-
data | the component that requested the write |
- Returns
true
if the write was successful, false
if writing the configuration failed
Implements KConfigBackend.
Definition at line 380 of file kconfigini.cpp.
◆ writeEntries() [1/2]
void KConfigIniBackend::writeEntries |
( |
const QByteArray & |
locale, |
|
|
QFile & |
file, |
|
|
const KEntryMap & |
map |
|
) |
| |
|
protected |
◆ writeEntries() [2/2]
void KConfigIniBackend::writeEntries |
( |
const QByteArray & |
locale, |
|
|
QFile & |
file, |
|
|
const KEntryMap & |
map, |
|
|
bool |
defaultGroup, |
|
|
bool & |
firstEntry |
|
) |
| |
|
protected |
The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by
doxygen 1.9.6 written
by
Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.