tdecore
TDEConfigBase Class Reference
KDE Configuration Management abstract base class. More...
#include <tdeconfigbase.h>

Public Types | |
enum | ConfigState { NoAccess, ReadOnly, ReadWrite } |
Public Member Functions | |
TDEConfigBase () | |
virtual | ~TDEConfigBase () |
void | setGroup (const TQString &group) |
void | setDesktopGroup () |
TQString | group () const |
bool | hasGroup (const TQString &group) const |
virtual TQStringList | groupList () const =0 |
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 | rollback (bool bDeep=true) |
virtual void | sync () |
bool | isDirty () const |
virtual void | setReadOnly (bool _ro) |
bool | isReadOnly () const |
bool | hasKey (const TQString &key) const |
virtual TQMap< TQString, TQString > | entryMap (const TQString &group) const =0 |
virtual void | reparseConfiguration ()=0 |
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 | |
void | setLocale () |
virtual void | setDirty (bool _bDirty=true) |
virtual void | parseConfigFiles () |
virtual KEntryMap | internalEntryMap (const TQString &pGroup) const =0 |
virtual KEntryMap | internalEntryMap () const =0 |
virtual void | putData (const KEntryKey &_key, const KEntry &_data, bool _checkGroup=true)=0 |
virtual KEntry | lookupData (const KEntryKey &_key) const =0 |
virtual bool | internalHasGroup (const TQCString &group) const =0 |
TQCString | readEntryUtf8 (const char *pKey) const |
bool | hasTranslatedKey (const char *pKey) const |
virtual void | virtual_hook (int id, void *data) |
Protected Attributes | |
TDEConfigBackEnd * | backEnd |
TQCString | mGroup |
TQCString | aLocaleString |
bool | bDirty |
bool | bLocaleInitialized |
bool | bReadOnly |
bool | bExpand |
Friends | |
class | TDEConfigBackEnd |
class | TDEConfigINIBackEnd |
class | TDEConfigGroup |
Detailed Description
KDE Configuration Management abstract base class.
This class forms the base for all KDE configuration. It is an abstract base class, meaning that you cannot directly instantiate objects of this class. Either use TDEConfig (for usual KDE configuration) or KSimpleConfig (for special needs as in ksamba), or even TDESharedConfig (stores values in shared memory).
All configuration entries are key, value pairs. Each entry also belongs to a specific group of related entries. All configuration entries that do not explicitly specify which group they are in are in a special group called the default group.
If there is a $ character in an entry, TDEConfigBase tries to expand environment variable and uses its value instead of its name. You can avoid this feature by having two consecutive $ characters in your config file which get expanded to one.
- Note:
- the '=' char is not allowed in keys and the ']' char is not allowed in a group name.
Definition at line 70 of file tdeconfigbase.h.
Member Enumeration Documentation
Possible return values for getConfigState().
- See also:
- getConfigState()
Definition at line 1828 of file tdeconfigbase.h.
Constructor & Destructor Documentation
TDEConfigBase::TDEConfigBase | ( | ) |
Construct a TDEConfigBase object.
Definition at line 50 of file tdeconfigbase.cpp.
TDEConfigBase::~TDEConfigBase | ( | ) | [virtual] |
Destructs the TDEConfigBase object.
Definition at line 57 of file tdeconfigbase.cpp.
Member Function Documentation
bool TDEConfigBase::checkConfigFilesWritable | ( | bool | warnUser | ) |
Check whether the config files are writable.
- Parameters:
-
warnUser Warn the user if the configuration files are not writable.
- Returns:
- Indicates that all of the configuration files used are writable.
- Since:
- 3.2
Definition at line 1936 of file tdeconfigbase.cpp.
void TDEConfigBase::deleteEntry | ( | const TQString & | pKey, | |
bool | bNLS = false , |
|||
bool | bGlobal = false | |||
) |
Deletes the entry specified by pKey
in the current group.
- Parameters:
-
pKey The key to delete. bGlobal If bGlobal
is true, the pair is not removed from the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the key with the locale tag is removed.
Definition at line 1214 of file tdeconfigbase.cpp.
void TDEConfigBase::deleteEntry | ( | const char * | pKey, | |
bool | bNLS = false , |
|||
bool | bGlobal = false | |||
) |
Deletes the entry specified by pKey
in the current group.
- Parameters:
-
pKey The key to delete. bGlobal If bGlobal
is true, the pair is not removed from the application specific config file, but from the global KDE config file.bNLS If bNLS
is true, the key with the locale tag is removed.
Definition at line 1221 of file tdeconfigbase.cpp.
bool TDEConfigBase::deleteGroup | ( | const TQString & | group, | |
bool | bDeep = true , |
|||
bool | bGlobal = false | |||
) |
Deletes a configuration entry group.
If the group is not empty and bDeep is false, nothing gets deleted and false is returned. If this group is the current group and it is deleted, the current group is undefined and should be set with setGroup() before the next operation on the configuration object.
- Parameters:
-
group The name of the group bDeep Specify whether non-empty groups should be completely deleted (including their entries). bGlobal If bGlobal
is true, the group is not removed from the application specific config file, but from the global KDE config file.
- Returns:
- If the group is not empty and bDeep is false, deleteGroup returns false.
Definition at line 1247 of file tdeconfigbase.cpp.
bool TDEConfigBase::entryIsImmutable | ( | const TQString & | key | ) | const |
Checks whether it is possible to change the given entry.
- Parameters:
-
key the key to check
- Returns:
- whether the entry
key
may be changed in the current group in this configuration file.
Definition at line 182 of file tdeconfigbase.cpp.
virtual TQMap<TQString, TQString> TDEConfigBase::entryMap | ( | const TQString & | group | ) | const [pure 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:
-
group 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.
- See also:
- QMap
Implemented in TDEConfig.
TDEConfigBase::ConfigState TDEConfigBase::getConfigState | ( | ) | const |
Returns the state of the app-config object.
Possible return values are NoAccess (the application-specific config file could not be opened neither read-write nor read-only), ReadOnly (the application-specific config file is opened read-only, but not read-write) and ReadWrite (the application-specific config file is opened read-write).
- See also:
- ConfigState()
- Returns:
- the state of the app-config object
Definition at line 1781 of file tdeconfigbase.cpp.
TQString TDEConfigBase::group | ( | ) | const |
Returns the name of the group in which we are searching for keys and from which we are retrieving entries.
- Returns:
- The current group.
Definition at line 100 of file tdeconfigbase.cpp.
bool TDEConfigBase::groupIsImmutable | ( | const TQString & | group | ) | const |
Checks whether it is possible to change the given group.
- Parameters:
-
group the group to check
- Returns:
- whether changes may be made to
group
in this configuration file.
Definition at line 172 of file tdeconfigbase.cpp.
virtual TQStringList TDEConfigBase::groupList | ( | ) | const [pure virtual] |
Returns a list of groups that are known about.
- Returns:
- The list of groups.
Implemented in TDEConfig.
bool TDEConfigBase::hasDefault | ( | const TQString & | key | ) | const |
Returns whether a default is specified for an entry in either the system wide configuration file or the global KDE config file.
If an application computes a default value at runtime for a certain entry, e.g. like:
TQColor computedDefault = kapp->palette().color(TQPalette::Active, TQColorGroup::Text) TQColor color = config->readEntry(key, computedDefault); \encode Then it may wish to make the following check before writing back changes: \code if ( (value == computedDefault) && !config->hasDefault(key) ) config->revertToDefault(key) else config->writeEntry(key, value)
This ensures that as long as the entry is not modified to differ from the computed default, the application will keep using the computed default and will follow changes the computed default makes over time.
- Parameters:
-
key The key of the entry to check.
- Since:
- 3.2
Definition at line 1836 of file tdeconfigbase.cpp.
bool TDEConfigBase::hasGroup | ( | const TQString & | group | ) | const |
Returns true if the specified group is known about.
- Parameters:
-
group The group to search for.
- Returns:
- true if the group exists.
Definition at line 152 of file tdeconfigbase.cpp.
bool TDEConfigBase::hasKey | ( | const TQString & | key | ) | const |
Checks whether the key has an entry in the currently active group.
Use this to determine whether a key is not specified for the current group (hasKey() returns false). Keys with null data are considered nonexistent.
- Parameters:
-
key The key to search for.
- Returns:
- If true, the key is available.
Definition at line 109 of file tdeconfigbase.cpp.
virtual KEntryMap TDEConfigBase::internalEntryMap | ( | const TQString & | pGroup | ) | const [protected, pure virtual] |
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.
Implemented in TDEConfig.
virtual KEntryMap TDEConfigBase::internalEntryMap | ( | ) | const [protected, pure virtual] |
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.
Implemented in TDEConfig.
bool TDEConfigBase::isDirty | ( | ) | const [inline] |
Checks whether the config file has any dirty (modified) entries.
- Returns:
- true if the config file has any dirty (modified) entries.
Definition at line 1746 of file tdeconfigbase.h.
bool TDEConfigBase::isDollarExpansion | ( | ) | const [inline] |
Returns whether dollar expansion is on or off.
It is initially OFF.
- Returns:
- true if dollar expansion is on.
Definition at line 1709 of file tdeconfigbase.h.
bool TDEConfigBase::isImmutable | ( | ) | const |
Checks whether this configuration file can be modified.
- Returns:
- whether changes may be made to this configuration file.
Definition at line 167 of file tdeconfigbase.cpp.
bool TDEConfigBase::isReadOnly | ( | ) | const [inline] |
Returns the read-only status of the config object.
- Returns:
- The read-only status.
Definition at line 1762 of file tdeconfigbase.h.
TQString TDEConfigBase::locale | ( | ) | const |
Returns a the current locale.
- Returns:
- A string representing the current locale.
Definition at line 74 of file tdeconfigbase.cpp.
Looks up an entry in the config object's internal structure.
Classes that derive from TDEConfigBase will need to implement this method in a storage-specific manner.
Do not use this function, the implementation and return type are subject to change.
- 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.
Implemented in TDEConfig, and TDEConfigGroup.
void TDEConfigBase::parseConfigFiles | ( | ) | [protected, virtual] |
Parses all configuration files for a configuration object.
The actual parsing is done by the associated TDEConfigBackEnd.
Definition at line 1758 of file tdeconfigbase.cpp.
virtual void TDEConfigBase::putData | ( | const KEntryKey & | _key, | |
const KEntry & | _data, | |||
bool | _checkGroup = true | |||
) | [protected, pure virtual] |
Inserts a (key/value) pair into the internal storage mechanism of the configuration object.
Classes that derive from TDEConfigBase will need to implement this method in a storage-specific manner.
Do not use this function, the implementation / return type are subject to change.
- 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.
Implemented in TDEConfig, and TDEConfigGroup.
bool TDEConfigBase::readBoolEntry | ( | const TQString & | pKey, | |
bool | bDefault = false | |||
) | const |
Reads a boolean entry.
Read the value of an entry specified by pKey
in the current group and interpret it as a boolean value. Currently "on", "yes", "1" and "true" are accepted as true, everything else if false.
- Parameters:
-
pKey The key to search for bDefault A default value returned if the key was not found.
- Returns:
- The value for this key.
Definition at line 758 of file tdeconfigbase.cpp.
bool TDEConfigBase::readBoolEntry | ( | const char * | pKey, | |
bool | bDefault = false | |||
) | const |
Reads a boolean entry.
Read the value of an entry specified by pKey
in the current group and interpret it as a boolean value. Currently "on", "yes", "1" and "true" are accepted as true, everything else if false.
- Parameters:
-
pKey The key to search for bDefault A default value returned if the key was not found.
- Returns:
- The value for this key.
Definition at line 763 of file tdeconfigbase.cpp.
Reads a TQColor entry.
Read the value of an entry specified by pKey
in the current group and interpret it as a color.
- Parameters:
-
pKey The key to search for. pDefault A default value (null TQColor by default) returned if the key was not found or if the value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 963 of file tdeconfigbase.cpp.
TQColor TDEConfigBase::readColorEntry | ( | const TQString & | pKey, | |
const TQColor * | pDefault = 0L | |||
) | const |
Reads a TQColor entry.
Read the value of an entry specified by pKey
in the current group and interpret it as a color.
- Parameters:
-
pKey The key to search for. pDefault A default value (null TQColor by default) returned if the key was not found or if the value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 957 of file tdeconfigbase.cpp.
TQDateTime TDEConfigBase::readDateTimeEntry | ( | const TQString & | pKey, | |
const TQDateTime * | pDefault = 0L | |||
) | const |
Reads a TQDateTime entry.
Read the value of an entry specified by pKey
in the current group and interpret it as a date and time.
- Parameters:
-
pKey The key to search for. pDefault A default value ( currentDateTime() by default) returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 1022 of file tdeconfigbase.cpp.
TQDateTime TDEConfigBase::readDateTimeEntry | ( | const char * | pKey, | |
const TQDateTime * | pDefault = 0L | |||
) | const |
Reads a TQDateTime entry.
Read the value of an entry specified by pKey
in the current group and interpret it as a date and time.
- Parameters:
-
pKey The key to search for. pDefault A default value ( currentDateTime() by default) returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 1029 of file tdeconfigbase.cpp.
bool TDEConfigBase::readDefaults | ( | ) | const |
- Returns:
- true if all readEntry and readXXXEntry calls return the system wide (default) values instead of the user's preference.
- Since:
- 3.2
Definition at line 1804 of file tdeconfigbase.cpp.
double TDEConfigBase::readDoubleNumEntry | ( | const TQString & | pKey, | |
double | nDefault = 0.0 | |||
) | const |
Reads a floating point value.
Read the value of an entry specified by pKey
in the current group and interpret it numerically.
- Parameters:
-
pKey The key to search for. nDefault A default value returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 739 of file tdeconfigbase.cpp.
double TDEConfigBase::readDoubleNumEntry | ( | const char * | pKey, | |
double | nDefault = 0.0 | |||
) | const |
Reads a floating point value.
Read the value of an entry specified by pKey
in the current group and interpret it numerically.
- Parameters:
-
pKey The key to search for. nDefault A default value returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 744 of file tdeconfigbase.cpp.
TQString TDEConfigBase::readEntry | ( | const char * | pKey, | |
const TQString & | aDefault = TQString::null | |||
) | const |
Reads the value of an entry specified by pKey
in the current group.
- Parameters:
-
pKey The key to search for. aDefault A default value returned if the key was not found.
- Returns:
- The value for this key. Can be TQString::null if aDefault is null.
Definition at line 227 of file tdeconfigbase.cpp.
TQString TDEConfigBase::readEntry | ( | const TQString & | pKey, | |
const TQString & | aDefault = TQString::null | |||
) | const |
Reads the value of an entry specified by pKey
in the current group.
If you want to read a path, please use readPathEntry().
- Parameters:
-
pKey The key to search for. aDefault A default value returned if the key was not found.
- Returns:
- The value for this key. Can be TQString::null if aDefault is null.
Definition at line 221 of file tdeconfigbase.cpp.
TQString TDEConfigBase::readEntryUntranslated | ( | const TQString & | pKey, | |
const TQString & | aDefault = TQString::null | |||
) | const |
Reads the value of an entry specified by pKey
in the current group.
The untranslated entry is returned, you normally do not need this.
- Parameters:
-
pKey The key to search for. aDefault A default value returned if the key was not found.
- Returns:
- The value for this key.
Definition at line 204 of file tdeconfigbase.cpp.
TQString TDEConfigBase::readEntryUntranslated | ( | const char * | pKey, | |
const TQString & | aDefault = TQString::null | |||
) | const |
Reads the value of an entry specified by pKey
in the current group.
The untranslated entry is returned, you normally do not need this.
- Parameters:
-
pKey The key to search for. aDefault A default value returned if the key was not found.
- Returns:
- The value for this key.
Definition at line 211 of file tdeconfigbase.cpp.
Reads a TQFont value.
Read the value of an entry specified by pKey
in the current group and interpret it as a font object.
- Parameters:
-
pKey The key to search for. pDefault A default value (null TQFont by default) returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 785 of file tdeconfigbase.cpp.
Reads a TQFont value.
Read the value of an entry specified by pKey
in the current group and interpret it as a font object.
- Parameters:
-
pKey The key to search for. pDefault A default value (null TQFont by default) returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 790 of file tdeconfigbase.cpp.
TQValueList< int > TDEConfigBase::readIntListEntry | ( | const TQString & | pKey | ) | const |
Reads a list of Integers.
- Parameters:
-
pKey The key to search for.
- Returns:
- The list. Empty if the entry does not exist.
Definition at line 577 of file tdeconfigbase.cpp.
TQValueList< int > TDEConfigBase::readIntListEntry | ( | const char * | pKey | ) | const |
Reads a list of Integers.
- Parameters:
-
pKey The key to search for.
- Returns:
- The list. Empty if the entry does not exist.
Definition at line 582 of file tdeconfigbase.cpp.
TQStringList TDEConfigBase::readListEntry | ( | const char * | pKey, | |
char | sep = ',' | |||
) | const |
Reads a list of strings.
- Parameters:
-
pKey The key to search for. sep The list separator (default is ",").
- Returns:
- The list. Empty if the entry does not exist.
Definition at line 527 of file tdeconfigbase.cpp.
TQStringList TDEConfigBase::readListEntry | ( | const char * | pKey, | |
const TQStringList & | aDefault, | |||
char | sep = ',' | |||
) | const |
Reads a list of strings, but returns a default if the key did not exist.
- Parameters:
-
pKey The key to search for. aDefault The default value to use if the key does not exist. sep The list separator (default is ",").
- Returns:
- The list. Contains
aDefault
if the Key does not exist.
- Since:
- 3.3
Definition at line 568 of file tdeconfigbase.cpp.
Reads a list of strings.
- Parameters:
-
pKey The key to search for list In this object, the read list will be returned. sep The list separator (default ",")
- Returns:
- The number of entries in the list.
Definition at line 477 of file tdeconfigbase.cpp.
int TDEConfigBase::readListEntry | ( | const char * | pKey, | |
TQStrList & | list, | |||
char | sep = ',' | |||
) | const |
Reads a list of strings.
- Parameters:
-
pKey The key to search for list In this object, the read list will be returned. sep The list separator (default ",")
- Returns:
- The number of entries in the list.
Definition at line 483 of file tdeconfigbase.cpp.
TQStringList TDEConfigBase::readListEntry | ( | const TQString & | pKey, | |
char | sep = ',' | |||
) | const |
Reads a list of strings.
- Parameters:
-
pKey The key to search for. sep The list separator (default is ",").
- Returns:
- The list. Empty if the entry does not exist.
Definition at line 522 of file tdeconfigbase.cpp.
long TDEConfigBase::readLongNumEntry | ( | const char * | pKey, | |
long | nDefault = 0 | |||
) | const |
Reads a numerical value.
Read the value of an entry specified by pKey
in the current group and interpret it numerically.
- Parameters:
-
pKey The key to search for. nDefault A default value returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 668 of file tdeconfigbase.cpp.
long TDEConfigBase::readLongNumEntry | ( | const TQString & | pKey, | |
long | nDefault = 0 | |||
) | const |
Reads a numerical value.
Read the value of an entry specified by pKey
in the current group and interpret it numerically.
- Parameters:
-
pKey The key to search for. nDefault A default value returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 663 of file tdeconfigbase.cpp.
TQ_INT64 TDEConfigBase::readNum64Entry | ( | const TQString & | pKey, | |
TQ_INT64 | nDefault = 0 | |||
) | const |
Reads a 64-bit numerical value.
Read the value of an entry specified by pKey
in the current group and interpret it numerically.
- Parameters:
-
pKey The key to search for. nDefault A default value returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 700 of file tdeconfigbase.cpp.
TQ_INT64 TDEConfigBase::readNum64Entry | ( | const char * | pKey, | |
TQ_INT64 | nDefault = 0 | |||
) | const |
Reads a 64-bit numerical value.
Read the value of an entry specified by pKey
in the current group and interpret it numerically.
- Parameters:
-
pKey The key to search for. nDefault A default value returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 705 of file tdeconfigbase.cpp.
int TDEConfigBase::readNumEntry | ( | const TQString & | pKey, | |
int | nDefault = 0 | |||
) | const |
Reads a numerical value.
Read the value of an entry specified by pKey
in the current group and interpret it numerically.
- Parameters:
-
pKey The key to search for. nDefault A default value returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 623 of file tdeconfigbase.cpp.
int TDEConfigBase::readNumEntry | ( | const char * | pKey, | |
int | nDefault = 0 | |||
) | const |
Reads a numerical value.
Read the value of an entry specified by pKey
in the current group and interpret it numerically.
- Parameters:
-
pKey The key to search for. nDefault A default value returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 628 of file tdeconfigbase.cpp.
TQString TDEConfigBase::readPathEntry | ( | const TQString & | pKey, | |
const TQString & | aDefault = TQString::null | |||
) | const |
Reads a path.
Read the value of an entry specified by pKey
in the current group and interpret it as a path. This means, dollar expansion is activated for this value, so that e.g. $HOME gets expanded.
- Parameters:
-
pKey The key to search for. aDefault A default value returned if the key was not found.
- Returns:
- The value for this key. Can be TQString::null if aDefault is null.
Definition at line 595 of file tdeconfigbase.cpp.
TQString TDEConfigBase::readPathEntry | ( | const char * | pKey, | |
const TQString & | aDefault = TQString::null | |||
) | const |
Reads a path.
Read the value of an entry specified by pKey
in the current group and interpret it as a path. This means, dollar expansion is activated for this value, so that e.g. $HOME gets expanded.
- Parameters:
-
pKey The key to search for. aDefault A default value returned if the key was not found.
- Returns:
- The value for this key. Can be TQString::null if aDefault is null.
Definition at line 600 of file tdeconfigbase.cpp.
TQStringList TDEConfigBase::readPathListEntry | ( | const TQString & | pKey, | |
char | sep = ',' | |||
) | const |
Reads a list of string paths.
Read the value of an entry specified by pKey
in the current group and interpret it as a list of paths. This means, dollar expansion is activated for this value, so that e.g. $HOME gets expanded.
- Parameters:
-
pKey The key to search for. sep The list separator (default is ",").
- Returns:
- The list. Empty if the entry does not exist.
- Since:
- 3.1.3
Definition at line 609 of file tdeconfigbase.cpp.
TQStringList TDEConfigBase::readPathListEntry | ( | const char * | pKey, | |
char | sep = ',' | |||
) | const |
Reads a list of string paths.
Read the value of an entry specified by pKey
in the current group and interpret it as a list of paths. This means, dollar expansion is activated for this value, so that e.g. $HOME gets expanded.
- Parameters:
-
pKey The key to search for. sep The list separator (default is ",").
- Returns:
- The list. Empty if the entry does not exist.
- Since:
- 3.1.3
Definition at line 614 of file tdeconfigbase.cpp.
TQPoint TDEConfigBase::readPointEntry | ( | const TQString & | pKey, | |
const TQPoint * | pDefault = 0L | |||
) | const |
Reads a TQPoint entry.
Read the value of an entry specified by pKey
in the current group and interpret it as a TQPoint object.
- Parameters:
-
pKey The key to search for pDefault A default value (null TQPoint by default) returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 906 of file tdeconfigbase.cpp.
Reads a TQPoint entry.
Read the value of an entry specified by pKey
in the current group and interpret it as a TQPoint object.
- Parameters:
-
pKey The key to search for pDefault A default value (null TQPoint by default) returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 912 of file tdeconfigbase.cpp.
Reads the value of an entry specified by pKey
in the current group.
The value is treated as if it is of the given type.
Note that only the following TQVariant types are allowed : String, StringList, List, Font, Point, Rect, Size, Color, Int, UInt, Bool, Double, DateTime and Date.
- Parameters:
-
pKey The key to search for.
- Returns:
- An invalid TQVariant if the key was not found or if the read value cannot be converted to the given TQVariant::Type.
Definition at line 353 of file tdeconfigbase.cpp.
TQVariant TDEConfigBase::readPropertyEntry | ( | const char * | pKey, | |
TQVariant::Type | type | |||
) | const |
Reads the value of an entry specified by pKey
in the current group.
The value is treated as if it is of the given type.
Note that only the following TQVariant types are allowed : String, StringList, List, Font, Point, Rect, Size, Color, Int, UInt, Bool, Double, DateTime and Date.
- Parameters:
-
pKey The key to search for.
- Returns:
- An invalid TQVariant if the key was not found or if the read value cannot be converted to the given TQVariant::Type.
Definition at line 359 of file tdeconfigbase.cpp.
TQVariant TDEConfigBase::readPropertyEntry | ( | const TQString & | pKey, | |
const TQVariant & | aDefault | |||
) | const |
Reads the value of an entry specified by pKey
in the current group.
The value is treated as if it is of the type of the given default value.
Note that only the following TQVariant types are allowed : String, StringList, List, Font, Point, Rect, Size, Color, Int, UInt, Bool, Double, DateTime and Date.
- Parameters:
-
pKey The key to search for. aDefault A default value returned if the key was not found or if the read value cannot be converted to the TQVariant::Type.
- Returns:
- The value for the key or the default value if the key was not found.
Definition at line 368 of file tdeconfigbase.cpp.
Reads the value of an entry specified by pKey
in the current group.
The value is treated as if it is of the type of the given default value.
Note that only the following TQVariant types are allowed : String, StringList, List, Font, Point, Rect, Size, Color, Int, UInt, Bool, Double, DateTime and Date.
- Parameters:
-
pKey The key to search for. aDefault A default value returned if the key was not found or if the read value cannot be converted to the TQVariant::Type.
- Returns:
- The value for the key or the default value if the key was not found.
Definition at line 374 of file tdeconfigbase.cpp.
Reads a TQRect entry.
Read the value of an entry specified by pKey in the current group and interpret it as a TQRect object.
- Parameters:
-
pKey The key to search for pDefault A default value (null TQRect by default) returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 882 of file tdeconfigbase.cpp.
Reads a TQRect entry.
Read the value of an entry specified by pKey in the current group and interpret it as a TQRect object.
- Parameters:
-
pKey The key to search for pDefault A default value (null TQRect by default) returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 887 of file tdeconfigbase.cpp.
Reads a TQSize entry.
Read the value of an entry specified by pKey
in the current group and interpret it as a TQSize object.
- Parameters:
-
pKey The key to search for pDefault A default value (null TQSize by default) returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 931 of file tdeconfigbase.cpp.
Reads a TQSize entry.
Read the value of an entry specified by pKey
in the current group and interpret it as a TQSize object.
- Parameters:
-
pKey The key to search for pDefault A default value (null TQSize by default) returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 937 of file tdeconfigbase.cpp.
unsigned long TDEConfigBase::readUnsignedLongNumEntry | ( | const TQString & | pKey, | |
unsigned long | nDefault = 0 | |||
) | const |
Read an unsigned numerical value.
Read the value of an entry specified by pKey
in the current group and interpret it numerically.
- Parameters:
-
pKey The key to search for. nDefault A default value returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 682 of file tdeconfigbase.cpp.
unsigned long TDEConfigBase::readUnsignedLongNumEntry | ( | const char * | pKey, | |
unsigned long | nDefault = 0 | |||
) | const |
Read an unsigned numerical value.
Read the value of an entry specified by pKey
in the current group and interpret it numerically.
- Parameters:
-
pKey The key to search for. nDefault A default value returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 687 of file tdeconfigbase.cpp.
TQ_UINT64 TDEConfigBase::readUnsignedNum64Entry | ( | const TQString & | pKey, | |
TQ_UINT64 | nDefault = 0 | |||
) | const |
Read an 64-bit unsigned numerical value.
Read the value of an entry specified by pKey
in the current group and interpret it numerically.
- Parameters:
-
pKey The key to search for. nDefault A default value returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 720 of file tdeconfigbase.cpp.
TQ_UINT64 TDEConfigBase::readUnsignedNum64Entry | ( | const char * | pKey, | |
TQ_UINT64 | nDefault = 0 | |||
) | const |
Read an 64-bit unsigned numerical value.
Read the value of an entry specified by pKey
in the current group and interpret it numerically.
- Parameters:
-
pKey The key to search for. nDefault A default value returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 725 of file tdeconfigbase.cpp.
unsigned int TDEConfigBase::readUnsignedNumEntry | ( | const TQString & | pKey, | |
unsigned int | nDefault = 0 | |||
) | const |
Reads an unsigned numerical value.
Read the value of an entry specified by pKey
in the current group and interpret it numerically.
- Parameters:
-
pKey The key to search for. nDefault A default value returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 644 of file tdeconfigbase.cpp.
unsigned int TDEConfigBase::readUnsignedNumEntry | ( | const char * | pKey, | |
unsigned int | nDefault = 0 | |||
) | const |
Reads an unsigned numerical value.
Read the value of an entry specified by pKey
in the current group and interpret it numerically.
- Parameters:
-
pKey The key to search for. nDefault A default value returned if the key was not found or if the read value cannot be interpreted.
- Returns:
- The value for this key.
Definition at line 649 of file tdeconfigbase.cpp.
virtual void TDEConfigBase::reparseConfiguration | ( | ) | [pure virtual] |
Reparses all configuration files.
This is useful for programs that use stand alone graphical configuration tools. The base method implemented here only clears the group list and then appends the default group.
Derivative classes should clear any internal data structures and then simply call parseConfigFiles() when implementing this method.
- See also:
- parseConfigFiles()
Implemented in TDEConfig.
void TDEConfigBase::revertToDefault | ( | const TQString & | key | ) |
Reverts the entry with key key
in the current group in the application specific config file to either the system wide (default) value or the value specified in the global KDE config file.
To revert entries in the global KDE config file, the global KDE config file should be opened explicitly in a separate config object.
- Parameters:
-
key The key of the entry to revert.
- Since:
- 3.2
Definition at line 1809 of file tdeconfigbase.cpp.
void TDEConfigBase::rollback | ( | bool | bDeep = true |
) | [virtual] |
Mark the config object as "clean," i.e.
don't write dirty entries at destruction time. If bDeep
is false, only the global dirty flag of the TDEConfig object gets cleared. If you then call writeEntry() again, the global dirty flag is set again and all dirty entries will be written at a subsequent sync() call.
Classes that derive from TDEConfigBase should override this method and implement storage-specific behavior, as well as calling the TDEConfigBase::rollback() explicitly in the initializer.
- Parameters:
-
bDeep If true, the dirty flags of all entries are cleared, as well as the global dirty flag.
Reimplemented in TDEConfig.
Definition at line 1787 of file tdeconfigbase.cpp.
void TDEConfigBase::setDesktopGroup | ( | ) |
Sets the group to the "Desktop Entry" group used for desktop configuration files for applications, mime types, etc.
Definition at line 104 of file tdeconfigbase.cpp.
virtual void TDEConfigBase::setDirty | ( | bool | _bDirty = true |
) | [inline, protected, virtual] |
Sets the global dirty flag of the config object.
- Parameters:
-
_bDirty How to mark the object's dirty status
Reimplemented in TDEConfigGroup.
Definition at line 1922 of file tdeconfigbase.h.
void TDEConfigBase::setDollarExpansion | ( | bool | _bExpand = true |
) | [inline] |
Turns on or off "dollar expansion" (see TDEConfigBase introduction) when reading config entries.
Dollar sign expansion is initially OFF.
- Parameters:
-
_bExpand Tf true, dollar expansion is turned on.
Definition at line 1702 of file tdeconfigbase.h.
void TDEConfigBase::setGroup | ( | const TQString & | group | ) |
Specifies the group in which keys will be read and written.
Subsequent calls to readEntry() and writeEntry() will be applied only in the activated group.
Switch back to the default group by passing a null string.
- Parameters:
-
group The name of the new group.
Definition at line 79 of file tdeconfigbase.cpp.
void TDEConfigBase::setGroup | ( | const TQCString & | pGroup | ) |
Overloaded public methods:
Definition at line 92 of file tdeconfigbase.cpp.
void TDEConfigBase::setLocale | ( | ) | [protected] |
Reads the locale and put in the configuration data struct.
Note that this should be done in the constructor, but this is not possible due to some mutual dependencies in TDEApplication::init()
Definition at line 62 of file tdeconfigbase.cpp.
void TDEConfigBase::setReadDefaults | ( | bool | b | ) |
When set, all readEntry and readXXXEntry calls return the system wide (default) values instead of the user's preference.
This is off by default.
- Since:
- 3.2
Definition at line 1793 of file tdeconfigbase.cpp.
virtual void TDEConfigBase::setReadOnly | ( | bool | _ro | ) | [inline, virtual] |
Sets the config object's read-only status.
- Parameters:
-
_ro If true, the config object will not write out any changes to disk even if it is destroyed or sync() is called.
Definition at line 1755 of file tdeconfigbase.h.
void TDEConfigBase::sync | ( | ) | [virtual] |
Flushes all changes that currently reside only in memory back to disk / permanent storage.
Dirty configuration entries are written to the most specific file available.
Asks the back end to flush out all pending writes, and then calls rollback(). No changes are made if the object has readOnly
status.
You should call this from your destructor in derivative classes.
- See also:
- rollback(), isReadOnly()
Reimplemented in KSimpleConfig, and TDEConfigGroup.
Definition at line 1770 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
bool | bValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes a boolean value.
- Parameters:
-
pKey The key to write. bValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1608 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
double | nValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
char | format = 'g' , |
|||
int | precision = 6 , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes a floating-point value.
- Parameters:
-
pKey The key to write. nValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.format format
determines the format to which the value is converted. Default is 'g'.precision precision
sets the precision with which the value is converted. Default is 6 as in TQString.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1598 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
TQ_INT64 | nValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but write a 64-bit numerical value.
- Parameters:
-
pKey The key to write. nValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1560 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
TQ_UINT64 | nValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes an unsigned 64-bit numerical value.
- Parameters:
-
pKey The key to write. nValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1575 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
const TQColor & | rColor, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but write a color entry.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write. rColor The color value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1716 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
const char * | pValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) | [inline] |
Write a (key/value) pair.
This is stored to the most specific config file when destroying the config object or when calling sync().
- Parameters:
-
pKey The key to write. pValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1000 of file tdeconfigbase.h.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
const TQStrList & | rValue, | |||
char | sep = ',' , |
|||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
writeEntry() overridden to accept a list of strings.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write rValue The list to write sep The list separator (default is ","). bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
- See also:
- writeEntry()
Definition at line 1408 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
double | nValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
char | format = 'g' , |
|||
int | precision = 6 , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes a floating-point value.
- Parameters:
-
pKey The key to write. nValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.format format
determines the format to which the value is converted. Default is 'g'.precision precision
sets the precision with which the value is converted. Default is 6 as in TQString.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1589 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
unsigned int | nValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes an unsigned numerical value.
- Parameters:
-
pKey The key to write. nValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1516 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
const TQString & | pValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a key/value pair.
This is stored in the most specific config file when destroying the config object or when calling sync().
If you want to write a path, please use writePathEntry().
- Parameters:
-
pKey The key to write. pValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1054 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
unsigned long | nValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes an unsigned long numerical value.
- Parameters:
-
pKey The key to write. nValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1546 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
const TQPoint & | rValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes a point.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write. rValue The point value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1676 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
TQ_INT64 | nValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but write a long numerical value.
- Parameters:
-
pKey The key to write. nValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1567 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
const TQStringList & | rValue, | |||
char | sep = ',' , |
|||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
writeEntry() overridden to accept a list of strings.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write rValue The list to write sep The list separator (default is ","). bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
- See also:
- writeEntry()
Definition at line 1448 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
const TQSize & | rValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes a size.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write. rValue The size value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1689 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
const TQDateTime & | rDateTime, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes a date and time entry.
Note: Unlike the other writeEntry() functions, the old value is not returned here!
- Parameters:
-
pKey The key to write. rDateTime The date and time value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1730 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
const TQDateTime & | rDateTime, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes a date and time entry.
Note: Unlike the other writeEntry() functions, the old value is not returned here!
- Parameters:
-
pKey The key to write. rDateTime The date and time value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1737 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
const TQString & | pValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a key/value pair.
This is stored in the most specific config file when destroying the config object or when calling sync().
- Parameters:
-
pKey The key to write. pValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1062 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
const TQValueList< int > & | rValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
writeEntry() overridden to accept a list of Integers.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write rValue The list to write bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
- See also:
- writeEntry()
Definition at line 1485 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
const char * | pValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) | [inline] |
Write a (key/value) pair.
This is stored to the most specific config file when destroying the config object or when calling sync().
- Parameters:
-
pKey The key to write. pValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 979 of file tdeconfigbase.h.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
const TQRect & | rValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes a rectangle.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write. rValue The rectangle value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1654 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
const TQStrList & | rValue, | |||
char | sep = ',' , |
|||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
writeEntry() overridden to accept a list of strings.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write rValue The list to write sep The list separator (default is ","). bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
- See also:
- writeEntry()
Definition at line 1401 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
const TQValueList< int > & | rValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
writeEntry() overridden to accept a list of Integers.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write rValue The list to write bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
- See also:
- writeEntry()
Definition at line 1491 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
long | nValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but write a long numerical value.
- Parameters:
-
pKey The key to write. nValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1531 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
TQ_UINT64 | nValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes an unsigned 64-bit numerical value.
- Parameters:
-
pKey The key to write. nValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1582 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
unsigned long | nValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes an unsigned long numerical value.
- Parameters:
-
pKey The key to write. nValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1553 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
const TQColor & | rColor, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but write a color entry.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write. rColor The color value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1708 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
const TQFont & | rFont, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes a font value.
- Parameters:
-
pKey The key to write. rFont The font value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1632 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
const TQVariant & | rValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
writeEntry() Overridden to accept a property.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write rValue The property to write bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
- See also:
- writeEntry()
Definition at line 1285 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
const TQPoint & | rValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes a point.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write. rValue The point value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1669 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
int | nValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Write a (key/value) pair.
Same as above, but writes a numerical value.
- Parameters:
-
pKey The key to write. nValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1508 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
long | nValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but write a long numerical value.
- Parameters:
-
pKey The key to write. nValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1538 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
const TQVariant & | rValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
writeEntry() Overridden to accept a property.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write rValue The property to write bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
- See also:
- writeEntry()
Definition at line 1278 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
int | nValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Write a (key/value) pair.
Same as above, but writes a numerical value.
- Parameters:
-
pKey The key to write. nValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1501 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
const TQStringList & | rValue, | |||
char | sep = ',' , |
|||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
writeEntry() overridden to accept a list of strings.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write rValue The list to write sep The list separator (default is ","). bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
- See also:
- writeEntry()
Definition at line 1441 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
const TQSize & | rValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes a size.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write. rValue The size value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1696 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
unsigned int | nValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes an unsigned numerical value.
- Parameters:
-
pKey The key to write. nValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1523 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const TQString & | pKey, | |
const TQRect & | rValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes a rectangle.
Note: Unlike the other writeEntry() functions, the old value is _not_ returned here!
- Parameters:
-
pKey The key to write. rValue The rectangle value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1647 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
const TQFont & | rFont, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes a font value.
- Parameters:
-
pKey The key to write. rFont The font value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1639 of file tdeconfigbase.cpp.
void TDEConfigBase::writeEntry | ( | const char * | pKey, | |
bool | bValue, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a (key/value) pair.
Same as above, but writes a boolean value.
- Parameters:
-
pKey The key to write. bValue The value to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1616 of file tdeconfigbase.cpp.
void TDEConfigBase::writePathEntry | ( | const char * | pKey, | |
const TQString & | path, | |||
bool | bPersistent, | |||
bool | bGlobal, | |||
bool | bNLS, | |||
bool | expand | |||
) |
Writes a file path.
It is checked whether the path is located under $HOME. If so the path is written out with the user's home-directory replaced with $HOME. The path should be read back with readPathEntry()
- Parameters:
-
pKey The key to write. path The path to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.expand If expand
is true, environment variables will be expanded on read.
Definition at line 1181 of file tdeconfigbase.cpp.
void TDEConfigBase::writePathEntry | ( | const TQString & | pKey, | |
const TQString & | path, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a file path.
It is checked whether the path is located under $HOME. If so the path is written out with the user's home-directory replaced with $HOME. The path should be read back with readPathEntry()
- Parameters:
-
pKey The key to write. path The path to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1103 of file tdeconfigbase.cpp.
void TDEConfigBase::writePathEntry | ( | const char * | pKey, | |
const TQStringList & | rValue, | |||
char | sep = ',' , |
|||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
writePathEntry() overridden to accept a list of paths (strings).
It is checked whether the paths are located under $HOME. If so each of the paths are written out with the user's home-directory replaced with $HOME. The paths should be read back with readPathListEntry()
- Parameters:
-
pKey The key to write rValue The list to write sep The list separator (default is ","). bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
- See also:
- writePathEntry()
- readPathListEntry()
- Since:
- 3.1.3
Definition at line 1195 of file tdeconfigbase.cpp.
void TDEConfigBase::writePathEntry | ( | const TQString & | pKey, | |
const TQStringList & | rValue, | |||
char | sep = ',' , |
|||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
writePathEntry() overridden to accept a list of paths (strings).
It is checked whether the paths are located under $HOME. If so each of the paths are written out with the user's home-directory replaced with $HOME. The paths should be read back with readPathListEntry()
- Parameters:
-
pKey The key to write rValue The list to write sep The list separator (default is ","). bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
- See also:
- writePathEntry()
- readPathListEntry()
- Since:
- 3.1.3
Definition at line 1188 of file tdeconfigbase.cpp.
void TDEConfigBase::writePathEntry | ( | const char * | pKey, | |
const TQString & | path, | |||
bool | bPersistent = true , |
|||
bool | bGlobal = false , |
|||
bool | bNLS = false | |||
) |
Writes a file path.
It is checked whether the path is located under $HOME. If so the path is written out with the user's home-directory replaced with $HOME. The path should be read back with readPathEntry()
- Parameters:
-
pKey The key to write. path The path to write. bPersistent If bPersistent
is false, the entry's dirty flag will not be set and thus the entry will not be written to disk at deletion time.bGlobal If bGlobal
is true, the pair is not saved to the application specific config file, but to the global KDE config file.bNLS If bNLS
is true, the locale tag is added to the key when writing it back.
Definition at line 1174 of file tdeconfigbase.cpp.
Member Data Documentation
TQCString TDEConfigBase::aLocaleString [protected] |
The locale to retrieve keys under if possible, i.e en_US or fr.
Definition at line 2020 of file tdeconfigbase.h.
TDEConfigBackEnd* TDEConfigBase::backEnd [protected] |
A back end for loading/saving to disk in a particular format.
Definition at line 1999 of file tdeconfigbase.h.
bool TDEConfigBase::bDirty [protected] |
Indicates whether there are any dirty entries in the config object that need to be written back to disk.
Definition at line 2025 of file tdeconfigbase.h.
TQCString TDEConfigBase::mGroup [protected] |
The currently selected group.
Definition at line 2016 of file tdeconfigbase.h.
The documentation for this class was generated from the following files: