KQuickManagedConfigModule Class Reference

Inheritance diagram for KQuickManagedConfigModule:

Public Slots
void	defaults () override
void	load () override
void	save () override
Public Slots inherited from KQuickConfigModule
void	pop ()
void	push (const QString &fileName, const QVariantMap &initialProperties=QVariantMap())
void	push (QQuickItem *item)
QQuickItem *	takeLast ()

Public Member Functions
	~KQuickManagedConfigModule () override
Public Member Functions inherited from KQuickConfigModule
	~KQuickConfigModule () override
int	columnWidth () const
int	currentIndex () const
int	depth () const
std::shared_ptr< QQmlEngine >	engine () const
QString	errorString () const
QQuickItem *	mainUi ()
void	setColumnWidth (int width)
void	setCurrentIndex (int index)
QQuickItem *	subPage (int index) const
Public Member Functions inherited from KAbstractConfigModule
	KAbstractConfigModule (QObject *parent, const KPluginMetaData &metaData)
Q_SIGNAL void	activationRequested (const QVariantList &args)
QString	authActionName () const
Q_SIGNAL void	authActionNameChanged ()
Buttons	buttons () const
Q_SIGNAL void	buttonsChanged ()
virtual void	defaults ()
bool	defaultsIndicatorsVisible () const
Q_SIGNAL void	defaultsIndicatorsVisibleChanged ()
QString	description () const
virtual void	load ()
KPluginMetaData	metaData () const
QString	name () const
bool	needsAuthorization () const
bool	needsSave () const
Q_SIGNAL void	needsSaveChanged ()
bool	representsDefaults () const
Q_SIGNAL void	representsDefaultsChanged ()
virtual void	save ()
void	setAuthActionName (const QString &action)
void	setButtons (const Buttons btn)
void	setDefaultsIndicatorsVisible (bool visible)
void	setNeedsSave (bool needs)
void	setRepresentsDefaults (bool defaults)
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

Protected Slots
void	registerSettings (KCoreConfigSkeleton *skeleton)
void	settingsChanged ()

Protected Member Functions
	KQuickManagedConfigModule (QObject *parent, const KPluginMetaData &metaData)
Protected Member Functions inherited from KQuickConfigModule
	KQuickConfigModule (QObject *parent, const KPluginMetaData &metaData)
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)

Additional Inherited Members
Public Types inherited from KAbstractConfigModule
enum	Button {   NoAdditionalButton = 0 , Help = 1 , Default = 2 , Apply = 4 ,   Export = 8 }
typedef QFlags< Button >	Buttons
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from KQuickConfigModule
int	columnWidth
int	currentIndex
int	depth
QQuickItem *	mainUi
Properties inherited from KAbstractConfigModule
KAbstractConfigModule::Buttons	buttons
bool	defaultsIndicatorsVisible
QString	description
QString	name
bool	needsAuthorization
bool	needsSave
bool	representsDefaults
Properties inherited from QObject
	objectName
Signals inherited from KQuickConfigModule
void	columnWidthChanged (int width)
void	currentIndexChanged (int index)
void	depthChanged (int index)
void	mainUiReady ()
void	pagePushed (QQuickItem *page)
void	pageRemoved ()
Static Public Member Functions inherited from KQuickConfigModule
static KQuickConfigModule *	qmlAttachedProperties (QObject *object)
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)

Detailed Description

The base class for configuration modules using KConfigXT settings.

We are assuming here that SettingsObject is a class generated from a kcfg file and that it will be somehow exposed as a constant property to be used from the QML side. It will be automatically discovered by ManagedConfigModule which will update the saveNeeded and defaults inherited properties by itself. Thus by inheriting from this class you shall not try to manage those properties yourselves. By passing in "this" as a parent, we prevent memory leaks and allow KQuickManagedConfigModule to automatically find the created settings object.

The constructor of the ConfigModule then looks like this:

YourConfigModule::YourConfigModule(QObject *parent, const KPluginMetaData &metaData)
  : ManagedConfigModule(parent, metaData)
  , m_settingsObject(new SettingsObject(this))
{
}

Since

6.0

Definition at line 40 of file kquickmanagedconfigmodule.h.

Constructor & Destructor Documentation

~KQuickManagedConfigModule()

KQuickManagedConfigModule::~KQuickManagedConfigModule ( )

overridedefault

Destroys the module.

KQuickManagedConfigModule()

KQuickManagedConfigModule::KQuickManagedConfigModule ( QObject * parent, const KPluginMetaData & metaData )

explicitprotected

Base class for all KControlModules.

Use KQuickConfigModuleLoader to instantiate this class

Note

do not emit changed signals here, since they are not yet connected to any slot.

Definition at line 28 of file kquickmanagedconfigmodule.cpp.

Member Function Documentation

defaults

void KQuickManagedConfigModule::defaults ( )

overrideslot

Sets the configuration to sensible default values.

This method is called when the user clicks the "Default" button. It should set the display to useful values.

By default this will reset to defaults the child setting objects of this module.

Definition at line 54 of file kquickmanagedconfigmodule.cpp.

load

void KQuickManagedConfigModule::load ( )

overrideslot

Load the configuration data into the module.

This method is invoked whenever the module should read its configuration (most of the times from a config file) and update the user interface. This happens when the user clicks the "Reset" button in the control center, to undo all of his changes and restore the currently valid settings. It is also called right after construction.

By default this will load the settings from the child setting objects of this module.

Definition at line 36 of file kquickmanagedconfigmodule.cpp.

registerSettings

void KQuickManagedConfigModule::registerSettings ( KCoreConfigSkeleton * skeleton )

protectedslot

Allow to register manually settings class generated from a kcfg file.

Used by derived class when automatic discovery is not possible. After skeleton is registered it will automatically call settingsChanged().

Definition at line 96 of file kquickmanagedconfigmodule.cpp.

save

void KQuickManagedConfigModule::save ( )

overrideslot

Save the configuration data.

The save method stores the config information as shown in the user interface in the config files. It is called when the user clicks "Apply" or "Ok".

By default this will save the child setting objects of this module.

Definition at line 45 of file kquickmanagedconfigmodule.cpp.

settingsChanged

void KQuickManagedConfigModule::settingsChanged ( )

protectedslot

Forces the module to reevaluate the saveNeeded and representsDefault state.

This is required for some modules which might have some settings managed outside of KConfigXT objects.

Definition at line 73 of file kquickmanagedconfigmodule.cpp.

---

The documentation for this class was generated from the following files:

• kquickmanagedconfigmodule.h
• kquickmanagedconfigmodule.cpp