KConfigSkeleton
KConfigSkeleton Class Reference
#include <KConfigSkeleton>
Inheritance diagram for KConfigSkeleton:
Classes | |
class | ItemColor |
class | ItemFont |
Public Member Functions | |
KConfigSkeleton (const QString &configname=QString(), QObject *parent=nullptr) | |
KConfigSkeleton (KSharedConfig::Ptr config, QObject *parent=nullptr) | |
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()) |
Public Member Functions inherited from KCoreConfigSkeleton | |
KCoreConfigSkeleton (const QString &configname=QString(), QObject *parent=nullptr) | |
KCoreConfigSkeleton (KSharedConfig::Ptr config, QObject *parent=nullptr) | |
~KCoreConfigSkeleton () override | |
void | addItem (KConfigSkeletonItem *item, const QString &name=QString()) |
ItemBool * | addItemBool (const QString &name, bool &reference, bool defaultValue=false, const QString &key=QString()) |
ItemDateTime * | addItemDateTime (const QString &name, QDateTime &reference, const QDateTime &defaultValue=QDateTime(), const QString &key=QString()) |
ItemDouble * | addItemDouble (const QString &name, double &reference, double defaultValue=0.0, const QString &key=QString()) |
ItemInt * | addItemInt (const QString &name, qint32 &reference, qint32 defaultValue=0, const QString &key=QString()) |
ItemIntList * | addItemIntList (const QString &name, QList< int > &reference, const QList< int > &defaultValue=QList< int >(), const QString &key=QString()) |
ItemLongLong * | addItemLongLong (const QString &name, qint64 &reference, qint64 defaultValue=0, const QString &key=QString()) |
ItemPassword * | addItemPassword (const QString &name, QString &reference, const QString &defaultValue=QLatin1String(""), const QString &key=QString()) |
ItemPath * | addItemPath (const QString &name, QString &reference, const QString &defaultValue=QLatin1String(""), const QString &key=QString()) |
ItemPoint * | addItemPoint (const QString &name, QPoint &reference, const QPoint &defaultValue=QPoint(), const QString &key=QString()) |
ItemPointF * | addItemPointF (const QString &name, QPointF &reference, const QPointF &defaultValue=QPointF(), const QString &key=QString()) |
ItemProperty * | addItemProperty (const QString &name, QVariant &reference, const QVariant &defaultValue=QVariant(), const QString &key=QString()) |
ItemRect * | addItemRect (const QString &name, QRect &reference, const QRect &defaultValue=QRect(), const QString &key=QString()) |
ItemRectF * | addItemRectF (const QString &name, QRectF &reference, const QRectF &defaultValue=QRectF(), const QString &key=QString()) |
ItemSize * | addItemSize (const QString &name, QSize &reference, const QSize &defaultValue=QSize(), const QString &key=QString()) |
ItemSizeF * | addItemSizeF (const QString &name, QSizeF &reference, const QSizeF &defaultValue=QSizeF(), const QString &key=QString()) |
ItemString * | addItemString (const QString &name, QString &reference, const QString &defaultValue=QLatin1String(""), const QString &key=QString()) |
ItemStringList * | addItemStringList (const QString &name, QStringList &reference, const QStringList &defaultValue=QStringList(), const QString &key=QString()) |
ItemUInt * | addItemUInt (const QString &name, quint32 &reference, quint32 defaultValue=0, const QString &key=QString()) |
ItemULongLong * | addItemULongLong (const QString &name, quint64 &reference, quint64 defaultValue=0, const QString &key=QString()) |
void | clearItems () |
KConfig * | config () |
const KConfig * | config () const |
QString | currentGroup () const |
KConfigSkeletonItem * | findItem (const QString &name) const |
bool | isDefaults () const |
Q_INVOKABLE bool | isImmutable (const QString &name) const |
bool | isSaveNeeded () const |
KConfigSkeletonItem::List | items () const |
void | load () |
void | read () |
void | removeItem (const QString &name) |
void | setCurrentGroup (const QString &group) |
virtual void | setDefaults () |
void | setSharedConfig (KSharedConfig::Ptr pConfig) |
KSharedConfig::Ptr | sharedConfig () const |
virtual bool | useDefaults (bool b) |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () const const |
Additional Inherited Members | |
Public Types inherited from QObject | |
typedef | QObjectList |
Properties inherited from QObject | |
objectName | |
Signals inherited from KCoreConfigSkeleton | |
void | configChanged () |
Public Slots inherited from KCoreConfigSkeleton | |
bool | save () |
Static Public Member Functions inherited from QObject | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
bool | disconnect (const QMetaObject::Connection &connection) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
Protected Member Functions inherited from KCoreConfigSkeleton | |
virtual void | usrRead () |
virtual bool | usrSave () |
virtual void | usrSetDefaults () |
virtual bool | usrUseDefaults (bool b) |
Protected Member Functions inherited from QObject | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
Class for handling preferences settings for an application.
This class extends KCoreConfigSkeleton by support for GUI types.
Definition at line 27 of file kconfigskeleton.h.
Constructor & Destructor Documentation
◆ KConfigSkeleton() [1/2]
|
explicit |
Constructor.
- Parameters
-
configname name of config file. If no name is given, the default config file as returned by KSharedConfig::openConfig() is used.
Definition at line 13 of file kconfigskeleton.cpp.
◆ KConfigSkeleton() [2/2]
|
explicit |
Constructor.
- Parameters
-
config configuration object to use.
Definition at line 18 of file kconfigskeleton.cpp.
Member Function Documentation
◆ addItemColor()
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
-
name Name used to identify this setting. Names must be unique. reference Pointer to the variable, which is set by read() calls and read by save() calls. defaultValue Default value, which is used when the config file does not yet contain the key of this item. key Key used in config file. If key
is a null string,name
is used as key.
- Returns
- The created item
Definition at line 83 of file kconfigskeleton.cpp.
◆ addItemFont()
KConfigSkeleton::ItemFont * KConfigSkeleton::addItemFont | ( | const QString & | name, |
QFont & | reference, | ||
const QFont & | defaultValue = QFont(), | ||
const QString & | key = QString() ) |
Register an item of type QFont.
- Parameters
-
name Name used to identify this setting. Names must be unique. reference Pointer to the variable, which is set by read() calls and read by save() calls. defaultValue Default value, which is used when the config file does not yet contain the key of this item. key Key used in config file. If key
is a null string,name
is used as key.
- Returns
- The created item
Definition at line 91 of file kconfigskeleton.cpp.
The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:01:09 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:01:09 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.