KCModuleData

Search for usage in LXR

#include <kcmoduledata.h>

Inheritance diagram for KCModuleData:

Signals

void aboutToLoad (QPrivateSignal)
 
void loaded ()
 

Public Member Functions

 KCModuleData (QObject *parent=nullptr)
 
virtual bool isDefaults () const
 
virtual bool matchesQuery (const QString &query) const
 
virtual void revertToDefaults ()
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () 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
 
qobject_cast (const QObject *object)
 
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)
 
QThreadthread () const const
 

Protected Slots

void autoRegisterSkeletons ()
 
void registerSkeleton (KCoreConfigSkeleton *skeleton)
 

Additional Inherited Members

- Public Types inherited from QObject
typedef  QObjectList
 
- Properties inherited from QObject
 objectName
 
- 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 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

A base class that offers information about a KCModule state.

Author
Benjamin Port benja.nosp@m.min..nosp@m.port@.nosp@m.enio.nosp@m.ka.co.nosp@m.m
Since
5.74

Definition at line 25 of file kcmoduledata.h.

Constructor & Destructor Documentation

◆ KCModuleData()

KCModuleData::KCModuleData ( QObject * parent = nullptr)
explicit

Definition at line 26 of file kcmoduledata.cpp.

Member Function Documentation

◆ aboutToLoad

void KCModuleData::aboutToLoad ( QPrivateSignal )
signal

Internal use.

Triggers the emit of

See also
loaded() signal. This is the default behavior. To handle when loaded() is emitted in subclass, disconnect this signal in derived constructor.

◆ autoRegisterSkeletons

void KCModuleData::autoRegisterSkeletons ( )
protectedslot

Automatically register child skeletons Call it in your subclass constructor after skeleton creation.

Definition at line 67 of file kcmoduledata.cpp.

◆ isDefaults()

bool KCModuleData::isDefaults ( ) const
virtual

Checks if the configuration is identical to the default one.

Returns
true if the module configuration is in the default state, false otherwise

Definition at line 50 of file kcmoduledata.cpp.

◆ loaded

void KCModuleData::loaded ( )
signal

This signal is emitted when KCModuleData is loaded.

◆ matchesQuery()

bool KCModuleData::matchesQuery ( const QString & query) const
virtual

Checks if this module matches a given query.

Parameters
querythe text user search for, it is not expected to be a regex pattern but a full text search.
Returns
true if this module matches a given query, false otherwise

Definition at line 75 of file kcmoduledata.cpp.

◆ registerSkeleton

void KCModuleData::registerSkeleton ( KCoreConfigSkeleton * skeleton)
protectedslot

Allow to register manually skeleton class.

Used by derived class when automatic discovery is not possible.

Definition at line 41 of file kcmoduledata.cpp.

◆ revertToDefaults()

void KCModuleData::revertToDefaults ( )
virtual

Revert module to default values and save them.

Definition at line 59 of file kcmoduledata.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:02:19 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.