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

KDECore

Classes | Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | List of all members
KConfigIniBackend Class Reference

#include <kconfigini_p.h>

Inheritance diagram for KConfigIniBackend:
Inheritance graph
[legend]

Classes

class  BufferFragment
 

Public Member Functions

 KConfigIniBackend ()
 
 ~KConfigIniBackend ()
 
KConfigBase::AccessMode accessMode () const
 
void createEnclosing ()
 
bool isLocked () const
 
bool isWritable () const
 
bool lock (const KComponentData &componentData)
 
QString nonWritableErrorMessage () const
 
ParseInfo parseConfig (const QByteArray &locale, KEntryMap &entryMap, ParseOptions options)
 
ParseInfo parseConfig (const QByteArray &locale, KEntryMap &entryMap, ParseOptions options, bool merging)
 
void setFilePath (const QString &path)
 
void unlock ()
 
bool writeConfig (const QByteArray &locale, KEntryMap &entryMap, WriteOptions options, const KComponentData &data)
 
- Public Member Functions inherited from KConfigBackend
virtual ~KConfigBackend ()
 
QString filePath () const
 
QDateTime lastModified () const
 
qint64 size () const
 

Protected Types

enum  StringType { GroupString = 0, KeyString = 1, ValueString = 2 }
 

Protected Member Functions

void writeEntries (const QByteArray &locale, QFile &file, const KEntryMap &map)
 
void writeEntries (const QByteArray &locale, QFile &file, const KEntryMap &map, bool defaultGroup, bool &firstEntry)
 
- Protected Member Functions inherited from KConfigBackend
 KConfigBackend ()
 
void setLastModified (const QDateTime &dt)
 
void setLocalFilePath (const QString &file)
 
void setSize (qint64 sz)
 

Static Protected Member Functions

static char charFromHex (const char *str, const QFile &file, int line)
 
static void printableToString (BufferFragment *aString, const QFile &file, int line)
 
static QByteArray stringToPrintable (const QByteArray &aString, StringType type)
 
static QString warningProlog (const QFile &file, int line)
 

Additional Inherited Members

- Public Types inherited from KConfigBackend
enum  ParseInfo { ParseOk, ParseImmutable, ParseOpenError }
 
enum  ParseOption { ParseGlobal = 1, ParseDefaults = 2, ParseExpansions = 4 }
 
enum  WriteOption { WriteGlobal = 1 }
 
- Static Public Member Functions inherited from KConfigBackend
static KSharedPtr< KConfigBackend > create (const KComponentData &componentData, const QString &fileName=QString(), const QString &system=QString())
 
static void registerMappings (const KEntryMap &entryMap)
 

Detailed Description

Definition at line 30 of file kconfigini_p.h.

Member Enumeration Documentation

enum KConfigIniBackend::StringType
protected
Enumerator
GroupString 
KeyString 
ValueString 

Definition at line 62 of file kconfigini_p.h.

Constructor & Destructor Documentation

KConfigIniBackend::KConfigIniBackend ( )

Definition at line 49 of file kconfigini.cpp.

KConfigIniBackend::~KConfigIniBackend ( )

Definition at line 54 of file kconfigini.cpp.

Member Function Documentation

KConfigBase::AccessMode KConfigIniBackend::accessMode ( ) const
virtual
Returns
the read/write status of the configuration object
See also
KConfigBase::AccessMode

Implements KConfigBackend.

Definition at line 563 of file kconfigini.cpp.

char KConfigIniBackend::charFromHex ( const char *  str,
const QFile &  file,
int  line 
)
staticprotected

Definition at line 680 of file kconfigini.cpp.

void KConfigIniBackend::createEnclosing ( )
virtual

Create the enclosing object of the configuration object.

For example, if the configuration object is a file, this should create the parent directory.

Implements KConfigBackend.

Definition at line 531 of file kconfigini.cpp.

bool KConfigIniBackend::isLocked ( ) const
virtual
Returns
true if the file is locked, false if it is not locked

Implements KConfigBackend.

Definition at line 593 of file kconfigini.cpp.

bool KConfigIniBackend::isWritable ( ) const
virtual

If isWritable() returns false, writeConfig() will always fail.

Returns
true if the configuration is writable, false if it is immutable

Implements KConfigBackend.

Definition at line 499 of file kconfigini.cpp.

bool KConfigIniBackend::lock ( const KComponentData &  componentData)
virtual

Lock the file.

Implements KConfigBackend.

Definition at line 574 of file kconfigini.cpp.

QString KConfigIniBackend::nonWritableErrorMessage ( ) const
virtual

When isWritable() returns false, return an error message to explain to the user why saving configuration will not work.

The return value when isWritable() returns true is undefined.

Returns
a translated user-visible explanation for the configuration object not being writable

Implements KConfigBackend.

Definition at line 526 of file kconfigini.cpp.

KConfigBackend::ParseInfo KConfigIniBackend::parseConfig ( const QByteArray &  locale,
KEntryMap &  pWriteBackMap,
ParseOptions  options 
)
virtual

Read persistent storage.

Parameters
localethe locale to read entries for (if the backend supports localized entries)
pWriteBackMapthe KEntryMap where the entries are placed
options
See also
ParseOptions
Returns
See also
ParseInfo

Implements KConfigBackend.

Definition at line 59 of file kconfigini.cpp.

KConfigBackend::ParseInfo KConfigIniBackend::parseConfig ( const QByteArray &  locale,
KEntryMap &  entryMap,
ParseOptions  options,
bool  merging 
)

Definition at line 68 of file kconfigini.cpp.

void KConfigIniBackend::printableToString ( BufferFragment *  aString,
const QFile &  file,
int  line 
)
staticprotected

Definition at line 704 of file kconfigini.cpp.

void KConfigIniBackend::setFilePath ( const QString &  path)
virtual

Set the file path.

Note
path MUST be absolute.
Parameters
paththe absolute file path

Implements KConfigBackend.

Definition at line 542 of file kconfigini.cpp.

QByteArray KConfigIniBackend::stringToPrintable ( const QByteArray &  aString,
StringType  type 
)
staticprotected

Definition at line 598 of file kconfigini.cpp.

void KConfigIniBackend::unlock ( )
virtual

Release the lock on the file.

Implements KConfigBackend.

Definition at line 587 of file kconfigini.cpp.

QString KConfigIniBackend::warningProlog ( const QFile &  file,
int  line 
)
staticprotected

Definition at line 43 of file kconfigini.cpp.

bool KConfigIniBackend::writeConfig ( const QByteArray &  locale,
KEntryMap &  entryMap,
WriteOptions  options,
const KComponentData &  data 
)
virtual

Write the dirty entries to permanent storage.

Parameters
localethe locale to write entries for (if the backend supports localized entries)
entryMapthe KEntryMap containing the config object's entries.
options
See also
WriteOptions
Parameters
datathe component that requested the write
Returns
true if the write was successful, false if writing the configuration failed

Implements KConfigBackend.

Definition at line 363 of file kconfigini.cpp.

void KConfigIniBackend::writeEntries ( const QByteArray &  locale,
QFile &  file,
const KEntryMap &  map 
)
protected

Definition at line 352 of file kconfigini.cpp.

void KConfigIniBackend::writeEntries ( const QByteArray &  locale,
QFile &  file,
const KEntryMap &  map,
bool  defaultGroup,
bool &  firstEntry 
)
protected

Definition at line 265 of file kconfigini.cpp.


The documentation for this class was generated from the following files:
  • kconfigini_p.h
  • kconfigini.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:47:10 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDECore

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

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  • kjsembed
  •   WTF
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Nepomuk-Core
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal