KDECore
#include <kconfigdata.h>

Public Types | |
enum | EntryOption { EntryDirty =1 , EntryGlobal =2 , EntryImmutable =4 , EntryDeleted =8 , EntryExpansion =16 , EntryRawKey =32 , EntryDefault =(SearchDefaults<<16) , EntryLocalized =(SearchLocalized<<16) } |
enum | SearchFlag { SearchDefaults =1 , SearchLocalized =2 } |
Public Member Functions | |
Iterator | findEntry (const QByteArray &group, const QByteArray &key=QByteArray(), SearchFlags flags=SearchFlags()) |
ConstIterator | findEntry (const QByteArray &group, const QByteArray &key=QByteArray(), SearchFlags flags=SearchFlags()) const |
Iterator | findExactEntry (const QByteArray &group, const QByteArray &key=QByteArray(), SearchFlags flags=SearchFlags()) |
QString | getEntry (const QByteArray &group, const QByteArray &key, const QString &defaultValue=QString(), SearchFlags flags=SearchFlags(), bool *expand=0) const |
bool | getEntryOption (const ConstIterator &it, EntryOption option) const |
bool | getEntryOption (const QByteArray &group, const QByteArray &key, SearchFlags flags, EntryOption option) const |
bool | hasEntry (const QByteArray &group, const QByteArray &key=QByteArray(), SearchFlags flags=SearchFlags()) const |
bool | revertEntry (const QByteArray &group, const QByteArray &key, SearchFlags flags=SearchFlags()) |
bool | setEntry (const QByteArray &group, const QByteArray &key, const QByteArray &value, EntryOptions options) |
void | setEntry (const QByteArray &group, const QByteArray &key, const QString &value, EntryOptions options) |
void | setEntryOption (const QByteArray &group, const QByteArray &key, SearchFlags flags, EntryOption option, bool bf) |
void | setEntryOption (Iterator it, EntryOption option, bool bf) |
Detailed Description
type specifying a map of entries (key,value pairs).
The keys are actually a key in a particular config file group together with the group name.
Definition at line 152 of file kconfigdata.h.
Member Enumeration Documentation
◆ EntryOption
Enumerator | |
---|---|
EntryDirty | |
EntryGlobal | |
EntryImmutable | |
EntryDeleted | |
EntryExpansion | |
EntryRawKey | |
EntryDefault | |
EntryLocalized |
Definition at line 161 of file kconfigdata.h.
◆ SearchFlag
Enumerator | |
---|---|
SearchDefaults | |
SearchLocalized |
Definition at line 155 of file kconfigdata.h.
Member Function Documentation
◆ findEntry() [1/2]
Iterator KEntryMap::findEntry | ( | const QByteArray & | group, |
const QByteArray & | key = QByteArray() , |
||
SearchFlags | flags = SearchFlags() |
||
) |
◆ findEntry() [2/2]
ConstIterator KEntryMap::findEntry | ( | const QByteArray & | group, |
const QByteArray & | key = QByteArray() , |
||
SearchFlags | flags = SearchFlags() |
||
) | const |
◆ findExactEntry()
QMap< KEntryKey, KEntry >::Iterator KEntryMap::findExactEntry | ( | const QByteArray & | group, |
const QByteArray & | key = QByteArray() , |
||
SearchFlags | flags = SearchFlags() |
||
) |
Definition at line 42 of file kconfigdata.cpp.
◆ getEntry()
QString KEntryMap::getEntry | ( | const QByteArray & | group, |
const QByteArray & | key, | ||
const QString & | defaultValue = QString() , |
||
SearchFlags | flags = SearchFlags() , |
||
bool * | expand = 0 |
||
) | const |
Definition at line 209 of file kconfigdata.cpp.
◆ getEntryOption() [1/2]
bool KEntryMap::getEntryOption | ( | const ConstIterator & | it, |
EntryOption | option | ||
) | const |
◆ getEntryOption() [2/2]
|
inline |
Definition at line 203 of file kconfigdata.h.
◆ hasEntry()
bool KEntryMap::hasEntry | ( | const QByteArray & | group, |
const QByteArray & | key = QByteArray() , |
||
SearchFlags | flags = SearchFlags() |
||
) | const |
Definition at line 226 of file kconfigdata.cpp.
◆ revertEntry()
bool KEntryMap::revertEntry | ( | const QByteArray & | group, |
const QByteArray & | key, | ||
SearchFlags | flags = SearchFlags() |
||
) |
Definition at line 289 of file kconfigdata.cpp.
◆ setEntry() [1/2]
bool KEntryMap::setEntry | ( | const QByteArray & | group, |
const QByteArray & | key, | ||
const QByteArray & | value, | ||
EntryOptions | options | ||
) |
Returns true if the entry gets dirtied or false in other case.
◆ setEntry() [2/2]
|
inline |
Definition at line 188 of file kconfigdata.h.
◆ setEntryOption() [1/2]
|
inline |
Definition at line 210 of file kconfigdata.h.
◆ setEntryOption() [2/2]
void KEntryMap::setEntryOption | ( | Iterator | it, |
EntryOption | option, | ||
bool | bf | ||
) |
The documentation for this class was generated from the following files:
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.