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

KDEUI

Classes | Public Member Functions

KConfigSkeleton Class Reference

Class for handling preferences settings for an application. More...

#include <kconfigskeleton.h>

Inheritance diagram for KConfigSkeleton:
Inheritance graph
[legend]

List of all members.

Classes

class  ItemColor
 Class for handling a color preferences item. More...
class  ItemFont
 Class for handling a font preferences item. More...

Public Member Functions

 KConfigSkeleton (const QString &configname=QString(), QObject *parent=0)
 KConfigSkeleton (KSharedConfig::Ptr config, QObject *parent=0)
ItemColor * addItemColor (const QString &name, QColor &reference, const QColor &defaultValue=QColor(128, 128, 128), const QString &key=QString())
ItemFont * addItemFont (const QString &name, QFont &reference, const QFont &defaultValue=QFont(), const QString &key=QString())

Detailed Description

Class for handling preferences settings for an application.

Author:
Cornelius Schumacher

This class extends KCoreConfigSkeleton by support for GUI types.

Definition at line 40 of file kconfigskeleton.h.


Constructor & Destructor Documentation

KConfigSkeleton::KConfigSkeleton ( const QString &  configname = QString(),
QObject *  parent = 0 
) [explicit]

Constructor.

Parameters:
confignamename of config file. If no name is given, the default config file as returned by KGlobal::config() is used.

Definition at line 26 of file kconfigskeleton.cpp.

KConfigSkeleton::KConfigSkeleton ( KSharedConfig::Ptr  config,
QObject *  parent = 0 
) [explicit]

Constructor.

Parameters:
configconfiguration object to use.

Definition at line 31 of file kconfigskeleton.cpp.


Member Function Documentation

KConfigSkeleton::ItemColor * KConfigSkeleton::addItemColor ( const QString &  name,
QColor &  reference,
const QColor &  defaultValue = QColor(128, 128, 128),
const QString &  key = QString() 
)

Register an item of type QColor.

Parameters:
nameName used to identify this setting. Names must be unique.
referencePointer to the variable, which is set by readConfig() calls and read by writeConfig() calls.
defaultValueDefault value, which is used when the config file does not yet contain the key of this item.
keyKey used in config file. If key is null, name is used as key.
Returns:
The created item

Definition at line 101 of file kconfigskeleton.cpp.

KConfigSkeleton::ItemFont * KConfigSkeleton::addItemFont ( const QString &  name,
QFont &  reference,
const QFont &  defaultValue = QFont(),
const QString &  key = QString() 
)

Register an item of type QFont.

Parameters:
nameName used to identify this setting. Names must be unique.
referencePointer to the variable, which is set by readConfig() calls and read by writeConfig() calls.
defaultValueDefault value, which is used when the config file does not yet contain the key of this item.
keyKey used in config file. If key is null, name is used as key.
Returns:
The created item

Definition at line 111 of file kconfigskeleton.cpp.


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

KDEUI

Skip menu "KDEUI"
  • 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
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.7.3
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