|
|
Access KDE Configuration entries.
This class implements KDE's default configuration system.
See also: config, KConfigBase, KSimpleConfig
| KConfig ( const QString& fileName = QString::null,
bool bReadOnly = false, bool bUseKDEGlobals = true, const char *resType="config")
| KConfig |
Construct a KConfig object.
Parameters:
| fileName | A file to parse in addition to the
system-wide file(s). If it is not provided, only global
KDE configuration data will be read (depending on the value of
bUseKDEGlobals).
|
| bReadOnly | Set the config object's read-only status. |
| bUseKDEGlobals | Toggle reading the global KDE configuration file. |
| resType | the place to look in (config, data, etc) See KStandardDirs |
| ~KConfig ()
| ~KConfig |
[virtual]
Destructor.
Writes back any dirty configuration entries, and destroys dynamically created objects.
| void rollback (bool bDeep = true)
| rollback |
[virtual]
Clears all entries out of the dirtyEntryMap, so the
values will not be written to disk on a later call to
sync().
Parameters:
| bDeep | If true, the dirty map is actually emptied. otherwise, the config object's global dirty flag is set to false, but the dirty entries remain in the dirty entry map. |
See also: rollback
Reimplemented from KConfigBase.
| bool hasGroup (const QString &_pGroup)
| hasGroup |
[const virtual]
Parameters:
| _pGroup | The group to search for. |
Returns: true if the group exists.
Reimplemented from KConfigBase.
| QStringList groupList ()
| groupList |
[const virtual]
Retrieve a list of groups that are known.
Returns: The list of groups.
Reimplemented from KConfigBase.
| bool hasKey (const QString &pKey)
| hasKey |
[const virtual]
Reimplemented from KConfigBase.
| QMap<QString, QString> entryMap (const QString &pGroup)
| entryMap |
[const virtual]
Retrieve a map (tree) of entries for all entries in a particular group.
Only the actual entry string is returned, none of the other internal data should be included.
Parameters:
| pGroup | A group to get keys from. |
Returns: A map of entries in the group specified, indexed by key. The returned map may be empty if the group is not found.
Reimplemented from KConfigBase.
| void reparseConfiguration ()
| reparseConfiguration |
[virtual]
Clear all internal data structures and then reread configuration information from disk.
Reimplemented from KConfigBase.
| KEntryMap internalEntryMap (const QString &pGroup)
| internalEntryMap |
[protected const virtual]
Retrieve a map (tree) of the entries in the specified group.
Do not use this function, the implementation / return type are subject to change.
Parameters:
| pGroup | the group to provide a KEntryMap for. |
Returns: The map of the entries in the group.
Reimplemented from KConfigBase.
| KEntryMap internalEntryMap ()
| internalEntryMap |
[protected const virtual]
Returns a copy of the internal map used to hold all entries.
Do not use this function, the implementation / return type are subject to change.
Parameters:
| pGroup | the group to provide a KEntryMap for. |
Returns: The map of the entries in the group.
Reimplemented from KConfigBase.
| void putData (const KEntryKey &_key, const KEntry &_data)
| putData |
[protected virtual]
Insert a key,value pair into the internal storage mechanism of the configuration object.
Parameters:
| _key | The key to insert. It contains information both on the group of the key and the key itself. If the key already exists, the old value will be replaced. |
| _data | the KEntry that is to be stored. |
Reimplemented from KConfigBase.
| KEntry lookupData (const KEntryKey &_key)
| lookupData |
[protected const virtual]
Look up an entry in the config object's internal structure.
Parameters:
| _key | The key to look up It contains information both on the group of the key and the entry's key itself. |
Returns: the KEntry value (data) found for the key. KEntry.aValue will be the null string if nothing was located.
Reimplemented from KConfigBase.
| KEntryMap aEntryMap | aEntryMap |
[protected]
| bool hasGroup (const QCString &_pGroup)
| hasGroup |
[const virtual]
Overloaded public functions.
Reimplemented from KConfigBase.
| bool hasGroup (const char *_pGroup)
| hasGroup |
[const virtual]
Reimplemented from KConfigBase.
| bool hasKey (const char *pKey)
| hasKey |
[const virtual]
Reimplemented from KConfigBase.