• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdecore
 

tdecore

Public Member Functions | Protected Member Functions | List of all members
TDEConfigGroup Class Reference

#include <tdeconfigbase.h>

Inheritance diagram for TDEConfigGroup:
TDEConfigBase

Public Member Functions

 TDEConfigGroup (TDEConfigBase *master, const TQCString &group)
 
 TDEConfigGroup (TDEConfigBase *master, const TQString &group)
 
 TDEConfigGroup (TDEConfigBase *master, const char *group)
 
void deleteGroup (bool bGlobal=false)
 
bool groupIsImmutable () const
 
virtual void setDirty (bool _bDirty)
 
virtual void putData (const KEntryKey &_key, const KEntry &_data, bool _checkGroup=true)
 
virtual KEntry lookupData (const KEntryKey &_key) const
 
virtual void sync ()
 
- 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
 
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

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 ()
 
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)
 

Additional Inherited Members

- Public Types inherited from TDEConfigBase
enum  ConfigState { NoAccess , ReadOnly , ReadWrite }
 
- Protected Attributes inherited from TDEConfigBase
TDEConfigBackEnd * backEnd
 
TQCString mGroup
 
TQCString aLocaleString
 
bool bDirty
 
bool bLocaleInitialized
 
bool bReadOnly
 
bool bExpand
 

Detailed Description

A TDEConfigBase derived class for one specific group in a TDEConfig object.

Definition at line 2126 of file tdeconfigbase.h.

Constructor & Destructor Documentation

◆ TDEConfigGroup() [1/3]

TDEConfigGroup::TDEConfigGroup ( TDEConfigBase *  master,
const TQCString &  group 
)

Construct a config group corresponding to group in master.

group is the group name encoded in UTF-8.

Definition at line 1842 of file tdeconfigbase.cpp.

◆ TDEConfigGroup() [2/3]

TDEConfigGroup::TDEConfigGroup ( TDEConfigBase *  master,
const TQString &  group 
)

This is an overloaded constructor provided for convenience.

It behaves essentially like the above function.

Construct a config group corresponding to group in master

Definition at line 1829 of file tdeconfigbase.cpp.

◆ TDEConfigGroup() [3/3]

TDEConfigGroup::TDEConfigGroup ( TDEConfigBase *  master,
const char *  group 
)

This is an overloaded constructor provided for convenience.

It behaves essentially like the above function.

Construct a config group corresponding to group in master group is the group name encoded in UTF-8.

Definition at line 1855 of file tdeconfigbase.cpp.

Member Function Documentation

◆ deleteGroup()

void TDEConfigGroup::deleteGroup ( bool  bGlobal = false)

Delete all entries in the entire group.

Parameters
bGlobalIf bGlobal is true, the entries are not removed from the application specific config file, but from the global KDE config file.

Definition at line 1868 of file tdeconfigbase.cpp.

◆ groupIsImmutable()

bool TDEConfigGroup::groupIsImmutable ( ) const

Checks whether it is possible to change this group.

Returns
whether changes may be made to this group in this configuration file.
Since
3.4

Definition at line 1873 of file tdeconfigbase.cpp.

◆ lookupData()

KEntry TDEConfigGroup::lookupData ( const KEntryKey &  _key) const
virtual

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
_keyThe 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 1888 of file tdeconfigbase.cpp.

◆ putData()

void TDEConfigGroup::putData ( const KEntryKey &  _key,
const KEntry &  _data,
bool  _checkGroup = true 
)
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
_keyThe 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.
_datathe KEntry that is to be stored.
_checkGroupWhen false, assume that the group already exists.

Implements TDEConfigBase.

Definition at line 1883 of file tdeconfigbase.cpp.

◆ setDirty()

void TDEConfigGroup::setDirty ( bool  _bDirty)
virtual

Sets the global dirty flag of the config object.

Parameters
_bDirtyHow to mark the object's dirty status

Reimplemented from TDEConfigBase.

Definition at line 1878 of file tdeconfigbase.cpp.

◆ sync()

void TDEConfigGroup::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 from TDEConfigBase.

Definition at line 1893 of file tdeconfigbase.cpp.

◆ virtual_hook()

void TDEConfigGroup::virtual_hook ( int  id,
void *  data 
)
protectedvirtual

Reimplemented from TDEConfigBase.

Definition at line 1901 of file tdeconfigbase.cpp.

The documentation for this class was generated from the following files:
  • tdeconfigbase.h
  • tdeconfigbase.cpp

tdecore

Skip menu "tdecore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

tdecore

Skip menu "tdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdecore by doxygen 1.9.4
This website is maintained by Timothy Pearson.