#include <tdeconfig.h>
Public Member Functions | |
TDEConfig (const TQString &fileName=TQString::null, bool bReadOnly=false, bool bUseKDEGlobals=true, const char *resType="config") | |
TDEConfig (TDEConfigBackEnd *backEnd, bool bReadOnly=false) | |
virtual | ~TDEConfig () |
virtual void | rollback (bool bDeep=true) |
virtual TQStringList | groupList () const |
virtual TQMap< TQString, TQString > | entryMap (const TQString &pGroup) const |
virtual void | reparseConfiguration () |
void | setFileWriteMode (int mode) |
void | setForceGlobal (bool force) |
bool | forceGlobal () const |
void | checkUpdate (const TQString &id, const TQString &updateFile) |
TDEConfig * | copyTo (const TQString &file, TDEConfig *config=0) const |
TDELockFile::Ptr | lockFile (bool bGlobal=false) |
Public Member Functions inherited from TDEConfigBase | |
TDEConfigBase () | |
virtual | ~TDEConfigBase () |
void | setGroup (const TQString &group) |
void | setDesktopGroup () |
TQString | group () const |
bool | hasGroup (const TQString &group) const |
TQString | locale () const |
TQString | readEntry (const TQString &pKey, const TQString &aDefault=TQString::null) const |
TQString | readEntry (const char *pKey, const TQString &aDefault=TQString::null) const |
TQVariant | readPropertyEntry (const TQString &pKey, TQVariant::Type) const |
TQVariant | readPropertyEntry (const char *pKey, TQVariant::Type) const |
TQVariant | readPropertyEntry (const TQString &pKey, const TQVariant &aDefault) const |
TQVariant | readPropertyEntry (const char *pKey, const TQVariant &aDefault) const |
int | readListEntry (const TQString &pKey, TQStrList &list, char sep=',') const |
int | readListEntry (const char *pKey, TQStrList &list, char sep=',') const |
TQStringList | readListEntry (const TQString &pKey, char sep=',') const |
TQStringList | readListEntry (const char *pKey, char sep=',') const |
TQStringList | readListEntry (const char *pKey, const TQStringList &aDefault, char sep=',') const |
TQValueList< int > | readIntListEntry (const TQString &pKey) const |
TQValueList< int > | readIntListEntry (const char *pKey) const |
TQString | readPathEntry (const TQString &pKey, const TQString &aDefault=TQString::null) const |
TQString | readPathEntry (const char *pKey, const TQString &aDefault=TQString::null) const |
TQStringList | readPathListEntry (const TQString &pKey, char sep=',') const |
TQStringList | readPathListEntry (const char *pKey, char sep=',') const |
int | readNumEntry (const TQString &pKey, int nDefault=0) const |
int | readNumEntry (const char *pKey, int nDefault=0) const |
unsigned int | readUnsignedNumEntry (const TQString &pKey, unsigned int nDefault=0) const |
unsigned int | readUnsignedNumEntry (const char *pKey, unsigned int nDefault=0) const |
long | readLongNumEntry (const TQString &pKey, long nDefault=0) const |
long | readLongNumEntry (const char *pKey, long nDefault=0) const |
unsigned long | readUnsignedLongNumEntry (const TQString &pKey, unsigned long nDefault=0) const |
unsigned long | readUnsignedLongNumEntry (const char *pKey, unsigned long nDefault=0) const |
TQ_INT64 | readNum64Entry (const TQString &pKey, TQ_INT64 nDefault=0) const |
TQ_INT64 | readNum64Entry (const char *pKey, TQ_INT64 nDefault=0) const |
TQ_UINT64 | readUnsignedNum64Entry (const TQString &pKey, TQ_UINT64 nDefault=0) const |
TQ_UINT64 | readUnsignedNum64Entry (const char *pKey, TQ_UINT64 nDefault=0) const |
double | readDoubleNumEntry (const TQString &pKey, double nDefault=0.0) const |
double | readDoubleNumEntry (const char *pKey, double nDefault=0.0) const |
TQFont | readFontEntry (const TQString &pKey, const TQFont *pDefault=0L) const |
TQFont | readFontEntry (const char *pKey, const TQFont *pDefault=0L) const |
bool | readBoolEntry (const TQString &pKey, bool bDefault=false) const |
bool | readBoolEntry (const char *pKey, bool bDefault=false) const |
TQRect | readRectEntry (const TQString &pKey, const TQRect *pDefault=0L) const |
TQRect | readRectEntry (const char *pKey, const TQRect *pDefault=0L) const |
TQPoint | readPointEntry (const TQString &pKey, const TQPoint *pDefault=0L) const |
TQPoint | readPointEntry (const char *pKey, const TQPoint *pDefault=0L) const |
TQSize | readSizeEntry (const TQString &pKey, const TQSize *pDefault=0L) const |
TQSize | readSizeEntry (const char *pKey, const TQSize *pDefault=0L) const |
TQColor | readColorEntry (const TQString &pKey, const TQColor *pDefault=0L) const |
TQColor | readColorEntry (const char *pKey, const TQColor *pDefault=0L) const |
TQDateTime | readDateTimeEntry (const TQString &pKey, const TQDateTime *pDefault=0L) const |
TQDateTime | readDateTimeEntry (const char *pKey, const TQDateTime *pDefault=0L) const |
TQString | readEntryUntranslated (const TQString &pKey, const TQString &aDefault=TQString::null) const |
TQString | readEntryUntranslated (const char *pKey, const TQString &aDefault=TQString::null) const |
void | writeEntry (const TQString &pKey, const TQString &pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, const TQString &pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, const TQVariant &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, const TQVariant &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, const TQStrList &rValue, char sep=',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, const TQStrList &rValue, char sep=',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, const TQStringList &rValue, char sep=',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, const TQStringList &rValue, char sep=',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, const TQValueList< int > &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, const TQValueList< int > &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, const char *pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, const char *pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, unsigned int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, unsigned int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, unsigned long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, unsigned long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, TQ_INT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, TQ_INT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, TQ_UINT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, TQ_UINT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, double nValue, bool bPersistent=true, bool bGlobal=false, char format='g', int precision=6, bool bNLS=false) |
void | writeEntry (const char *pKey, double nValue, bool bPersistent=true, bool bGlobal=false, char format='g', int precision=6, bool bNLS=false) |
void | writeEntry (const TQString &pKey, bool bValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, bool bValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, const TQFont &rFont, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, const TQFont &rFont, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, const TQColor &rColor, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, const TQColor &rColor, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, const TQDateTime &rDateTime, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, const TQDateTime &rDateTime, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, const TQRect &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, const TQRect &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, const TQPoint &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, const TQPoint &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const TQString &pKey, const TQSize &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writeEntry (const char *pKey, const TQSize &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writePathEntry (const TQString &pKey, const TQString &path, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writePathEntry (const char *pKey, const TQString &path, bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writePathEntry (const char *pKey, const TQString &path, bool bPersistent, bool bGlobal, bool bNLS, bool expand) |
void | writePathEntry (const TQString &pKey, const TQStringList &rValue, char sep=',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | writePathEntry (const char *pKey, const TQStringList &rValue, char sep=',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false) |
void | deleteEntry (const TQString &pKey, bool bNLS=false, bool bGlobal=false) |
void | deleteEntry (const char *pKey, bool bNLS=false, bool bGlobal=false) |
bool | deleteGroup (const TQString &group, bool bDeep=true, bool bGlobal=false) |
void | setDollarExpansion (bool _bExpand=true) |
bool | isDollarExpansion () const |
virtual void | sync () |
bool | isDirty () const |
virtual void | setReadOnly (bool _ro) |
bool | isReadOnly () const |
bool | hasKey (const TQString &key) const |
bool | isImmutable () const |
bool | groupIsImmutable (const TQString &group) const |
bool | entryIsImmutable (const TQString &key) const |
ConfigState | getConfigState () const |
bool | checkConfigFilesWritable (bool warnUser) |
void | setReadDefaults (bool b) |
bool | readDefaults () const |
void | revertToDefault (const TQString &key) |
bool | hasDefault (const TQString &key) const |
void | setGroup (const TQCString &pGroup) |
void | setGroup (const char *pGroup) |
bool | hasGroup (const TQCString &_pGroup) const |
bool | hasGroup (const char *_pGroup) const |
bool | hasKey (const char *pKey) const |
Protected Member Functions | |
virtual bool | internalHasGroup (const TQCString &group) const |
virtual KEntryMap | internalEntryMap (const TQString &pGroup) const |
virtual KEntryMap | internalEntryMap () const |
virtual void | putData (const KEntryKey &_key, const KEntry &_data, bool _checkGroup=true) |
virtual KEntry | lookupData (const KEntryKey &_key) const |
virtual void | virtual_hook (int id, void *data) |
Protected Member Functions inherited from TDEConfigBase | |
void | setLocale () |
virtual void | setDirty (bool _bDirty=true) |
virtual void | parseConfigFiles () |
TQCString | readEntryUtf8 (const char *pKey) const |
bool | hasTranslatedKey (const char *pKey) const |
Protected Attributes | |
KEntryMap | aEntryMap |
Protected Attributes inherited from TDEConfigBase | |
TDEConfigBackEnd * | backEnd |
TQCString | mGroup |
TQCString | aLocaleString |
bool | bDirty |
bool | bLocaleInitialized |
bool | bReadOnly |
bool | bExpand |
Additional Inherited Members | |
Public Types inherited from TDEConfigBase | |
enum | ConfigState { NoAccess , ReadOnly , ReadWrite } |
Detailed Description
Access KDE Configuration entries.
This class implements KDE's default configuration system.
- See also
- TDEGlobal::config(), TDEConfigBase, KSimpleConfig
KDE Configuration Management class
Definition at line 43 of file tdeconfig.h.
Constructor & Destructor Documentation
◆ TDEConfig()
TDEConfig::TDEConfig | ( | const TQString & | fileName = TQString::null , |
bool | bReadOnly = false , |
||
bool | bUseKDEGlobals = true , |
||
const char * | resType = "config" |
||
) |
Constructs a TDEConfig 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. Note that the object will automatically become read-only if either the user does not have write permission to fileName
or if no file was specified.bUseKDEGlobals Toggle reading the global KDE configuration file. resType the place to look in (config, data, etc) See TDEStandardDirs.
Definition at line 44 of file tdeconfig.cpp.
◆ ~TDEConfig()
|
virtual |
Destructs the TDEConfig object.
Writes back any dirty configuration entries, and destroys dynamically created objects.
Definition at line 87 of file tdeconfig.cpp.
Member Function Documentation
◆ checkUpdate()
void TDEConfig::checkUpdate | ( | const TQString & | id, |
const TQString & | updateFile | ||
) |
Checks whether the config file contains the update id
as contained in updateFile
.
If not, it runs tdeconf_update to update the config file.
If you install config update files with critical fixes you may wish to use this method to verify that a critical update has indeed been performed to catch the case where a user restores an old config file from backup that has not been updated yet.
- Parameters
-
id the update to check updateFile the file containing the update
- Since
- 3.1
Definition at line 287 of file tdeconfig.cpp.
◆ copyTo()
Copies all entries from this config object to a new config object that will save itself to file
.
Actual saving to file
happens when the returned object is destructed or when sync() is called upon it.
- Parameters
-
file the new config object will save itself to. config optional config object to reuse
- Since
- 3.2
Definition at line 303 of file tdeconfig.cpp.
◆ entryMap()
|
virtual |
Returns 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.
Implements TDEConfigBase.
Definition at line 141 of file tdeconfig.cpp.
◆ forceGlobal()
|
inline |
Returns true if all entries are being written into kdeglobals.
- Returns
- true if all entries are being written into kdeglobals
- See also
- setForceGlobal
Definition at line 136 of file tdeconfig.h.
◆ groupList()
|
virtual |
Returns a list of groups that are known.
- Returns
- a list of of groups
Implements TDEConfigBase.
Definition at line 107 of file tdeconfig.cpp.
◆ internalEntryMap() [1/2]
|
inlineprotectedvirtual |
Returns a map (tree) of the entries in the tree.
Do not use this function, the implementation / return type are subject to change.
- Returns
- A map of the entries in the tree.
Implements TDEConfigBase.
Definition at line 212 of file tdeconfig.h.
◆ internalEntryMap() [2/2]
|
protectedvirtual |
Returns a map (tree) of the entries in the specified group.
This may or may not return all entries that belong to the config object. The only guarantee that you are given is that any entries that are dirty (i.e. modified and not yet written back to the disk) will be contained in the map. Some derivative classes may choose to return everything.
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.
Implements TDEConfigBase.
Definition at line 178 of file tdeconfig.cpp.
◆ internalHasGroup()
|
protectedvirtual |
Returns true if the specified group is known.
- Parameters
-
group The group to search for.
- Returns
- true if the group exists.
Implements TDEConfigBase.
Definition at line 254 of file tdeconfig.cpp.
◆ lockFile()
TDELockFile::Ptr TDEConfig::lockFile | ( | bool | bGlobal = false | ) |
Returns a lock file object for the configuration file or 0 if the backend does not support locking.
- Parameters
-
bGlobal if true, return the lock file for the global config file
NOTE: TDEConfig::sync() requires a lock on both the normal and global config file. When calling TDEConfig::sync() while having a lock on the global config file, the normal config file MUST be locked AS WELL and the normal config file MUST be locked BEFORE the global config file! Otherwise there is a risk of deadlock.
- Since
- 3.3
Definition at line 280 of file tdeconfig.cpp.
◆ lookupData()
Looks 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.
Implements TDEConfigBase.
Definition at line 238 of file tdeconfig.cpp.
◆ putData()
|
protectedvirtual |
Inserts 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. _checkGroup When false, assume that the group already exists.
Implements TDEConfigBase.
Definition at line 202 of file tdeconfig.cpp.
◆ reparseConfiguration()
|
virtual |
Clears all internal data structures and then reread configuration information from disk.
Implements TDEConfigBase.
Definition at line 161 of file tdeconfig.cpp.
◆ 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
- TDEConfigBase::rollback
Reimplemented from TDEConfigBase.
Definition at line 94 of file tdeconfig.cpp.
◆ setFileWriteMode()
void TDEConfig::setFileWriteMode | ( | int | mode | ) |
Set the file mode for newly created files.
- Parameters
-
mode the mode for new files as described in chmod(2)
- See also
- man:chmod(2) for a description of
mode
Definition at line 275 of file tdeconfig.cpp.
◆ setForceGlobal()
|
inline |
Forces all following write-operations being performed on kdeglobals, independent of the bGlobal flag in writeEntry().
- Parameters
-
force true to force writing in kdeglobals
- See also
- forceGlobal
Definition at line 129 of file tdeconfig.h.
Member Data Documentation
◆ aEntryMap
|
protected |
Contains all key,value entries, as well as some "special" keys which indicate the start of a group of entries.
These special keys will have the .key portion of their KEntryKey set to TQString::null.
Definition at line 243 of file tdeconfig.h.
The documentation for this class was generated from the following files: