• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDECore

KEntryMap Class Reference

#include <kconfigdata.h>

Inheritance diagram for KEntryMap:
QMap

List of all members.

Public Types

enum  EntryOption {
  EntryDirty = 1, EntryGlobal = 2, EntryImmutable = 4, EntryDeleted = 8,
  EntryExpansion = 16, EntryRawKey = 32, EntryDefault = (SearchDefaults<<16), EntryLocalized = (SearchLocalized<<16)
}
enum  SearchFlag { SearchDefaults = 1, SearchLocalized = 2 }

Public Member Functions

ConstIterator findEntry (const QByteArray &group, const QByteArray &key=QByteArray(), SearchFlags flags=SearchFlags()) const
Iterator findEntry (const QByteArray &group, const QByteArray &key=QByteArray(), SearchFlags flags=SearchFlags())
Iterator findExactEntry (const QByteArray &group, const QByteArray &key=QByteArray(), SearchFlags flags=SearchFlags())
QString getEntry (const QByteArray &group, const QByteArray &key, const QString &defaultValue=QString(), SearchFlags flags=SearchFlags(), bool *expand=0) const
bool getEntryOption (const QByteArray &group, const QByteArray &key, SearchFlags flags, EntryOption option) const
bool getEntryOption (const ConstIterator &it, EntryOption option) const
bool hasEntry (const QByteArray &group, const QByteArray &key=QByteArray(), SearchFlags flags=SearchFlags()) const
void revertEntry (const QByteArray &group, const QByteArray &key, SearchFlags flags=SearchFlags())
void setEntry (const QByteArray &group, const QByteArray &key, const QString &value, EntryOptions options)
bool setEntry (const QByteArray &group, const QByteArray &key, const QByteArray &value, EntryOptions options)
void setEntryOption (const QByteArray &group, const QByteArray &key, SearchFlags flags, EntryOption option, bool bf)
void setEntryOption (Iterator it, EntryOption option, bool bf)

Detailed Description

type specifying a map of entries (key,value pairs). The keys are actually a key in a particular config file group together with the group name.

For internal use only.

Definition at line 144 of file kconfigdata.h.


Member Enumeration Documentation

enum KEntryMap::EntryOption
Enumerator:
EntryDirty 
EntryGlobal 
EntryImmutable 
EntryDeleted 
EntryExpansion 
EntryRawKey 
EntryDefault 
EntryLocalized 

Definition at line 153 of file kconfigdata.h.

enum KEntryMap::SearchFlag
Enumerator:
SearchDefaults 
SearchLocalized 

Definition at line 147 of file kconfigdata.h.


Member Function Documentation

ConstIterator KEntryMap::findEntry ( const QByteArray &  group,
const QByteArray &  key = QByteArray(),
SearchFlags  flags = SearchFlags() 
) const [inline]

Definition at line 196 of file kconfigdata.h.

Iterator KEntryMap::findEntry ( const QByteArray &  group,
const QByteArray &  key = QByteArray(),
SearchFlags  flags = SearchFlags() 
) [inline]

Definition at line 178 of file kconfigdata.h.

Iterator KEntryMap::findExactEntry ( const QByteArray &  group,
const QByteArray &  key = QByteArray(),
SearchFlags  flags = SearchFlags() 
) [inline]

Definition at line 165 of file kconfigdata.h.

QString KEntryMap::getEntry ( const QByteArray &  group,
const QByteArray &  key,
const QString &  defaultValue = QString(),
SearchFlags  flags = SearchFlags(),
bool *  expand = 0 
) const [inline]

Definition at line 344 of file kconfigdata.h.

bool KEntryMap::getEntryOption ( const QByteArray &  group,
const QByteArray &  key,
SearchFlags  flags,
EntryOption  option 
) const [inline]

Definition at line 400 of file kconfigdata.h.

bool KEntryMap::getEntryOption ( const ConstIterator &  it,
EntryOption  option 
) const [inline]

Definition at line 377 of file kconfigdata.h.

bool KEntryMap::hasEntry ( const QByteArray &  group,
const QByteArray &  key = QByteArray(),
SearchFlags  flags = SearchFlags() 
) const [inline]

Definition at line 366 of file kconfigdata.h.

void KEntryMap::revertEntry ( const QByteArray &  group,
const QByteArray &  key,
SearchFlags  flags = SearchFlags() 
) [inline]

Definition at line 436 of file kconfigdata.h.

void KEntryMap::setEntry ( const QByteArray &  group,
const QByteArray &  key,
const QString &  value,
EntryOptions  options 
) [inline]

Definition at line 338 of file kconfigdata.h.

bool KEntryMap::setEntry ( const QByteArray &  group,
const QByteArray &  key,
const QByteArray &  value,
EntryOptions  options 
) [inline]

Returns true if the entry gets dirtied or false in other case.

Definition at line 217 of file kconfigdata.h.

void KEntryMap::setEntryOption ( const QByteArray &  group,
const QByteArray &  key,
SearchFlags  flags,
EntryOption  option,
bool  bf 
) [inline]

Definition at line 430 of file kconfigdata.h.

void KEntryMap::setEntryOption ( Iterator  it,
EntryOption  option,
bool  bf 
) [inline]

Definition at line 406 of file kconfigdata.h.


The documentation for this class was generated from the following file:
  • kconfigdata.h

KDECore

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal