KConfigBase

Search for usage in LXR

#include <KConfigBase>

Inheritance diagram for KConfigBase:

Public Types

enum  AccessMode { NoAccess, ReadOnly, ReadWrite }
 
enum  WriteConfigFlag {
  Persistent = 0x01, Global = 0x02, Localized = 0x04, Notify = 0x08 | Persistent,
  Normal = Persistent
}
 
typedef QFlags< WriteConfigFlagWriteConfigFlags
 

Public Member Functions

virtual ~KConfigBase ()
 
virtual AccessMode accessMode () const =0
 
void deleteGroup (const QString &group, WriteConfigFlags flags=Normal)
 
void deleteGroup (const QByteArray &group, WriteConfigFlags flags=Normal)
 
void deleteGroup (const char *group, WriteConfigFlags flags=Normal)
 
KConfigGroup group (const QString &group)
 
KConfigGroup group (const QByteArray &group)
 
KConfigGroup group (const char *group)
 
const KConfigGroup group (const QString &group) const
 
const KConfigGroup group (const QByteArray &group) const
 
const KConfigGroup group (const char *group) const
 
virtual QStringList groupList () const =0
 
bool hasGroup (const QString &group) const
 
bool hasGroup (const char *group) const
 
bool hasGroup (const QByteArray &group) const
 
bool isGroupImmutable (const QString &group) const
 
bool isGroupImmutable (const QByteArray &group) const
 
bool isGroupImmutable (const char *group) const
 
virtual bool isImmutable () const =0
 
virtual void markAsClean ()=0
 
virtual bool sync ()=0
 

Protected Member Functions

virtual void deleteGroupImpl (const QByteArray &group, WriteConfigFlags flags=Normal)=0
 
virtual KConfigGroup groupImpl (const QByteArray &group)=0
 
virtual const KConfigGroup groupImpl (const QByteArray &group) const =0
 
virtual bool hasGroupImpl (const QByteArray &group) const =0
 
virtual bool isGroupImmutableImpl (const QByteArray &group) const =0
 
virtual void virtual_hook (int id, void *data)
 

Detailed Description

Interface to interact with configuration.

KConfigBase allows a component of an application to persists its configuration without the component knowing if it is storing the configuration into a top level KConfig or a KConfigGroup inside a KConfig instance.

Definition at line 30 of file kconfigbase.h.

Member Typedef Documentation

Stores a combination of WriteConfigFlag values.

Definition at line 67 of file kconfigbase.h.

Member Enumeration Documentation

Possible return values for accessMode().

Definition at line 175 of file kconfigbase.h.

Flags to control write entry.

See also
WriteConfigFlags
Enumerator
Persistent 

Save this entry when saving the config object.

Global 

Save the entry to the global KDE config file instead of the application specific config file.

Localized 

Add the locale tag to the key when writing it.

Notify 

Notify remote KConfigWatchers of changes (requires DBus support) Implied persistent.

Since
5.51
Normal 

Save the entry to the application specific config file without a locale tag.

This is the default.

Definition at line 37 of file kconfigbase.h.

Constructor & Destructor Documentation

KConfigBase::~KConfigBase ( )
virtual

Destructs the KConfigBase object.

Definition at line 91 of file kconfigbase.cpp.

Member Function Documentation

virtual AccessMode KConfigBase::accessMode ( ) const
pure virtual

Returns the access mode 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).

Returns
the access mode of the app-config object

Implemented in KConfig, and KConfigGroup.

void KConfigBase::deleteGroup ( const QString group,
WriteConfigFlags  flags = Normal 
)

Delete group.

This marks group as deleted in the config object. This effectively removes any cascaded values from config files earlier in the stack.

Definition at line 66 of file kconfigbase.cpp.

void KConfigBase::deleteGroup ( const QByteArray group,
WriteConfigFlags  flags = Normal 
)

Overload for deleteGroup(const QString&, WriteConfigFlags)

Parameters
groupname of group to delete, encoded in UTF-8

Definition at line 61 of file kconfigbase.cpp.

void KConfigBase::deleteGroup ( const char *  group,
WriteConfigFlags  flags = Normal 
)

Overload for deleteGroup(const QString&, WriteConfigFlags)

Parameters
groupname of group to delete, encoded in UTF-8

Definition at line 71 of file kconfigbase.cpp.

virtual void KConfigBase::deleteGroupImpl ( const QByteArray group,
WriteConfigFlags  flags = Normal 
)
protectedpure virtual
Parameters
groupname of group, encoded in UTF-8

Implemented in KConfigGroup, and KConfig.

KConfigGroup KConfigBase::group ( const QString group)

Returns an object for the named subgroup.

Parameters
groupthe group to open. Pass an empty string here to the KConfig object to obtain a handle on the root group.
Returns
config group object for the given group name.

Definition at line 36 of file kconfigbase.cpp.

KConfigGroup KConfigBase::group ( const QByteArray group)

Overload for group(const QString&)

Parameters
groupname of group, encoded in UTF-8

Definition at line 31 of file kconfigbase.cpp.

KConfigGroup KConfigBase::group ( const char *  group)

Overload for group(const QString&)

Parameters
groupname of group, encoded in UTF-8

Definition at line 41 of file kconfigbase.cpp.

const KConfigGroup KConfigBase::group ( const QString group) const

Const overload for group(const QString&)

Definition at line 51 of file kconfigbase.cpp.

const KConfigGroup KConfigBase::group ( const QByteArray group) const

Const overload for group(const QString&)

Parameters
groupname of group, encoded in UTF-8

Definition at line 46 of file kconfigbase.cpp.

const KConfigGroup KConfigBase::group ( const char *  group) const

Const overload for group(const QString&)

Parameters
groupname of group, encoded in UTF-8

Definition at line 56 of file kconfigbase.cpp.

virtual KConfigGroup KConfigBase::groupImpl ( const QByteArray group)
protectedpure virtual
Parameters
groupname of group, encoded in UTF-8

Implemented in KConfigGroup, and KConfig.

virtual const KConfigGroup KConfigBase::groupImpl ( const QByteArray group) const
protectedpure virtual
Parameters
groupname of group, encoded in UTF-8

Implemented in KConfigGroup, and KConfig.

virtual QStringList KConfigBase::groupList ( ) const
pure virtual

Returns a list of groups that are known about.

Returns
The list of groups.

Implemented in KConfig, and KConfigGroup.

bool KConfigBase::hasGroup ( const QString group) const

Returns true if the specified group is known about.

Parameters
groupname of group to search for
Returns
true if the group exists.

Definition at line 16 of file kconfigbase.cpp.

bool KConfigBase::hasGroup ( const char *  group) const

Overload for hasGroup(const QString&) const.

Parameters
groupname of group to search for, encoded in UTF-8

Definition at line 21 of file kconfigbase.cpp.

bool KConfigBase::hasGroup ( const QByteArray group) const

Overload for hasGroup(const QString&) const.

Parameters
groupname of group to search for, encoded in UTF-8

Definition at line 26 of file kconfigbase.cpp.

virtual bool KConfigBase::hasGroupImpl ( const QByteArray group) const
protectedpure virtual
Parameters
groupname of group, encoded in UTF-8

Implemented in KConfigGroup, and KConfig.

bool KConfigBase::isGroupImmutable ( const QString group) const

Can changes be made to the entries in group?

Parameters
groupThe group to check for immutability.
Returns
false if the entries in group can be modified, otherwise true

Definition at line 81 of file kconfigbase.cpp.

bool KConfigBase::isGroupImmutable ( const QByteArray group) const

Overload for isGroupImmutable(const QString&) const.

Parameters
groupname of group, encoded in UTF-8

Definition at line 76 of file kconfigbase.cpp.

bool KConfigBase::isGroupImmutable ( const char *  group) const

Overload for isGroupImmutable(const QString&) const.

Parameters
groupname of group, encoded in UTF-8

Definition at line 86 of file kconfigbase.cpp.

virtual bool KConfigBase::isGroupImmutableImpl ( const QByteArray group) const
protectedpure virtual
Parameters
groupname of group, encoded in UTF-8

Implemented in KConfigGroup, and KConfig.

virtual bool KConfigBase::isImmutable ( ) const
pure virtual

Checks whether this configuration object can be modified.

Returns
whether changes may be made to this configuration object.

Implemented in KConfigGroup, and KConfig.

virtual void KConfigBase::markAsClean ( )
pure virtual

Reset the dirty flags of all entries in the entry map, so the values will not be written to disk on a later call to sync().

Implemented in KConfig, and KConfigGroup.

virtual bool KConfigBase::sync ( )
pure virtual

Syncs the configuration object that this group belongs to.

Unrelated concurrent changes to the same file are merged and thus not overwritten. Note however, that this object is not automatically updated with those changes.

Implemented in KConfig, and KConfigGroup.

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

Virtual hook, used to add new "virtual" functions while maintaining binary compatibility.

Unused in this class.

Reimplemented in KConfig.

Definition at line 99 of file kconfigbase.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Fri Oct 22 2021 22:50:08 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.