KCModule
#include <KCModule>

Public Types | |
enum | Button { NoAdditionalButton = 0, Help = 1, Default = 2, Apply = 4, Export = 8 } |
typedef QFlags< Button > | Buttons |
![]() | |
enum | RenderFlag |
![]() | |
enum | PaintDeviceMetric |
Signals | |
void | changed (bool state) |
void | defaulted (bool state) |
void | defaultsIndicatorsVisibleChanged (bool show) |
void | quickHelpChanged () |
void | rootOnlyMessageChanged (bool use, QString message) |
Public Slots | |
virtual void | defaults () |
virtual void | load () |
virtual void | save () |
void | setDefaultsIndicatorsVisible (bool show) |
Public Member Functions | |
KCModule (const KAboutData *aboutData, QWidget *parent=nullptr, const QVariantList &args=QVariantList()) | |
KCModule (QWidget *parent=nullptr, const QVariantList &args=QVariantList()) | |
~KCModule () override | |
virtual const KAboutData * | aboutData () const |
Buttons | buttons () const |
KAboutData | componentData () const |
QList< KConfigDialogManager * > | configs () const |
bool | defaultsIndicatorsVisible () const |
QString | exportText () const |
bool | needsAuthorization () const |
virtual QString | quickHelp () const |
QString | rootOnlyMessage () const |
void | setAboutData (const KAboutData *about) |
void | setExportText (const QString &) |
void | setNeedsAuthorization (bool needsAuth) |
bool | useRootOnlyMessage () const |
![]() | |
QWidget (QWidget *parent, Qt::WindowFlags f) | |
bool | acceptDrops () const const |
QString | accessibleDescription () const const |
QString | accessibleName () const const |
QList< QAction * > | actions () const const |
void | activateWindow () |
void | addAction (QAction *action) |
void | addActions (QList< QAction * > actions) |
void | adjustSize () |
bool | autoFillBackground () const const |
QPalette::ColorRole | backgroundRole () const const |
QBackingStore * | backingStore () const const |
QSize | baseSize () const const |
QWidget * | childAt (const QPoint &p) const const |
QWidget * | childAt (int x, int y) const const |
QRect | childrenRect () const const |
QRegion | childrenRegion () const const |
void | clearFocus () |
void | clearMask () |
bool | close () |
QMargins | contentsMargins () const const |
QRect | contentsRect () const const |
Qt::ContextMenuPolicy | contextMenuPolicy () const const |
QCursor | cursor () const const |
void | customContextMenuRequested (const QPoint &pos) |
WId | effectiveWinId () const const |
void | ensurePolished () const const |
Qt::FocusPolicy | focusPolicy () const const |
QWidget * | focusProxy () const const |
QWidget * | focusWidget () const const |
const QFont & | font () const const |
QFontInfo | fontInfo () const const |
QFontMetrics | fontMetrics () const const |
QPalette::ColorRole | foregroundRole () const const |
QRect | frameGeometry () const const |
QSize | frameSize () const const |
const QRect & | geometry () const const |
void | getContentsMargins (int *left, int *top, int *right, int *bottom) const const |
QPixmap | grab (const QRect &rectangle) |
void | grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags) |
void | grabKeyboard () |
void | grabMouse () |
void | grabMouse (const QCursor &cursor) |
int | grabShortcut (const QKeySequence &key, Qt::ShortcutContext context) |
QGraphicsEffect * | graphicsEffect () const const |
QGraphicsProxyWidget * | graphicsProxyWidget () const const |
bool | hasEditFocus () const const |
bool | hasFocus () const const |
virtual bool | hasHeightForWidth () const const |
bool | hasMouseTracking () const const |
bool | hasTabletTracking () const const |
int | height () const const |
virtual int | heightForWidth (int w) const const |
void | hide () |
Qt::InputMethodHints | inputMethodHints () const const |
virtual QVariant | inputMethodQuery (Qt::InputMethodQuery query) const const |
void | insertAction (QAction *before, QAction *action) |
void | insertActions (QAction *before, QList< QAction * > actions) |
bool | isActiveWindow () const const |
bool | isAncestorOf (const QWidget *child) const const |
bool | isEnabled () const const |
bool | isEnabledTo (const QWidget *ancestor) const const |
bool | isEnabledToTLW () const const |
bool | isFullScreen () const const |
bool | isHidden () const const |
bool | isMaximized () const const |
bool | isMinimized () const const |
bool | isModal () const const |
bool | isTopLevel () const const |
bool | isVisible () const const |
bool | isVisibleTo (const QWidget *ancestor) const const |
bool | isWindow () const const |
bool | isWindowModified () const const |
QLayout * | layout () const const |
Qt::LayoutDirection | layoutDirection () const const |
QLocale | locale () const const |
void | lower () |
QPoint | mapFrom (const QWidget *parent, const QPoint &pos) const const |
QPoint | mapFromGlobal (const QPoint &pos) const const |
QPoint | mapFromParent (const QPoint &pos) const const |
QPoint | mapTo (const QWidget *parent, const QPoint &pos) const const |
QPoint | mapToGlobal (const QPoint &pos) const const |
QPoint | mapToParent (const QPoint &pos) const const |
QRegion | mask () const const |
int | maximumHeight () const const |
QSize | maximumSize () const const |
int | maximumWidth () const const |
int | minimumHeight () const const |
QSize | minimumSize () const const |
virtual QSize | minimumSizeHint () const const |
int | minimumWidth () const const |
void | move (const QPoint &) |
void | move (int x, int y) |
QWidget * | nativeParentWidget () const const |
QWidget * | nextInFocusChain () const const |
QRect | normalGeometry () const const |
void | overrideWindowFlags (Qt::WindowFlags flags) |
virtual QPaintEngine * | paintEngine () const const override |
const QPalette & | palette () const const |
QWidget * | parentWidget () const const |
QPoint | pos () const const |
QWidget * | previousInFocusChain () const const |
QWIDGETSIZE_MAX QWIDGETSIZE_MAX | |
void | raise () |
QRect | rect () const const |
void | releaseKeyboard () |
void | releaseMouse () |
void | releaseShortcut (int id) |
void | removeAction (QAction *action) |
void | render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags) |
void | render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags) |
void | repaint () |
void | repaint (const QRect &rect) |
void | repaint (const QRegion &rgn) |
void | repaint (int x, int y, int w, int h) |
void | resize (const QSize &) |
void | resize (int w, int h) |
bool | restoreGeometry (const QByteArray &geometry) |
QByteArray | saveGeometry () const const |
QScreen * | screen () const const |
void | scroll (int dx, int dy) |
void | scroll (int dx, int dy, const QRect &r) |
void | setAcceptDrops (bool on) |
void | setAccessibleDescription (const QString &description) |
void | setAccessibleName (const QString &name) |
void | setAttribute (Qt::WidgetAttribute attribute, bool on) |
void | setAutoFillBackground (bool enabled) |
void | setBackgroundRole (QPalette::ColorRole role) |
void | setBaseSize (const QSize &) |
void | setBaseSize (int basew, int baseh) |
void | setContentsMargins (const QMargins &margins) |
void | setContentsMargins (int left, int top, int right, int bottom) |
void | setContextMenuPolicy (Qt::ContextMenuPolicy policy) |
void | setCursor (const QCursor &) |
void | setDisabled (bool disable) |
void | setEditFocus (bool enable) |
void | setEnabled (bool) |
void | setFixedHeight (int h) |
void | setFixedSize (const QSize &s) |
void | setFixedSize (int w, int h) |
void | setFixedWidth (int w) |
void | setFocus () |
void | setFocus (Qt::FocusReason reason) |
void | setFocusPolicy (Qt::FocusPolicy policy) |
void | setFocusProxy (QWidget *w) |
void | setFont (const QFont &) |
void | setForegroundRole (QPalette::ColorRole role) |
void | setGeometry (const QRect &) |
void | setGeometry (int x, int y, int w, int h) |
void | setGraphicsEffect (QGraphicsEffect *effect) |
void | setHidden (bool hidden) |
void | setInputMethodHints (Qt::InputMethodHints hints) |
void | setLayout (QLayout *layout) |
void | setLayoutDirection (Qt::LayoutDirection direction) |
void | setLocale (const QLocale &locale) |
void | setMask (const QBitmap &bitmap) |
void | setMask (const QRegion ®ion) |
void | setMaximumHeight (int maxh) |
void | setMaximumSize (const QSize &) |
void | setMaximumSize (int maxw, int maxh) |
void | setMaximumWidth (int maxw) |
void | setMinimumHeight (int minh) |
void | setMinimumSize (const QSize &) |
void | setMinimumSize (int minw, int minh) |
void | setMinimumWidth (int minw) |
void | setMouseTracking (bool enable) |
void | setPalette (const QPalette &) |
void | setParent (QWidget *parent) |
void | setParent (QWidget *parent, Qt::WindowFlags f) |
void | setShortcutAutoRepeat (int id, bool enable) |
void | setShortcutEnabled (int id, bool enable) |
void | setSizeIncrement (const QSize &) |
void | setSizeIncrement (int w, int h) |
void | setSizePolicy (QSizePolicy) |
void | setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical) |
void | setStatusTip (const QString &) |
void | setStyle (QStyle *style) |
void | setStyleSheet (const QString &styleSheet) |
void | setTabletTracking (bool enable) |
void | setToolTip (const QString &) |
void | setToolTipDuration (int msec) |
void | setUpdatesEnabled (bool enable) |
void | setupUi (QWidget *widget) |
virtual void | setVisible (bool visible) |
void | setWhatsThis (const QString &) |
void | setWindowFilePath (const QString &filePath) |
void | setWindowFlag (Qt::WindowType flag, bool on) |
void | setWindowFlags (Qt::WindowFlags type) |
void | setWindowIcon (const QIcon &icon) |
void | setWindowIconText (const QString &) |
void | setWindowModality (Qt::WindowModality windowModality) |
void | setWindowModified (bool) |
void | setWindowOpacity (qreal level) |
void | setWindowRole (const QString &role) |
void | setWindowState (Qt::WindowStates windowState) |
void | setWindowTitle (const QString &) |
void | show () |
void | showFullScreen () |
void | showMaximized () |
void | showMinimized () |
void | showNormal () |
QSize | size () const const |
virtual QSize | sizeHint () const const |
QSize | sizeIncrement () const const |
QSizePolicy | sizePolicy () const const |
void | stackUnder (QWidget *w) |
QString | statusTip () const const |
QStyle * | style () const const |
QString | styleSheet () const const |
bool | testAttribute (Qt::WidgetAttribute attribute) const const |
QString | toolTip () const const |
int | toolTipDuration () const const |
QWidget * | topLevelWidget () const const |
bool | underMouse () const const |
void | ungrabGesture (Qt::GestureType gesture) |
void | unsetCursor () |
void | unsetLayoutDirection () |
void | unsetLocale () |
void | update () |
void | update (const QRect &rect) |
void | update (const QRegion &rgn) |
void | update (int x, int y, int w, int h) |
void | updateGeometry () |
bool | updatesEnabled () const const |
QRegion | visibleRegion () const const |
QString | whatsThis () const const |
int | width () const const |
QWidget * | window () const const |
QString | windowFilePath () const const |
Qt::WindowFlags | windowFlags () const const |
QWindow * | windowHandle () const const |
QIcon | windowIcon () const const |
void | windowIconChanged (const QIcon &icon) |
QString | windowIconText () const const |
void | windowIconTextChanged (const QString &iconText) |
Qt::WindowModality | windowModality () const const |
qreal | windowOpacity () const const |
QString | windowRole () const const |
Qt::WindowStates | windowState () const const |
QString | windowTitle () const const |
void | windowTitleChanged (const QString &title) |
Qt::WindowType | windowType () const const |
WId | winId () const const |
int | x () const const |
int | y () const const |
![]() | |
QObject (QObject *parent) | |
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 () |
void | dumpObjectInfo () const const |
void | dumpObjectTree () |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegExp ®Exp, 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 |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
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_DISABLE_COPY (Class) | |
Q_DISABLE_COPY_MOVE (Class) | |
Q_DISABLE_MOVE (Class) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
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 | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
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 | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds time, Qt::TimerType timerType) |
QThread * | thread () const const |
![]() | |
int | colorCount () const const |
int | depth () const const |
int | devicePixelRatio () const const |
qreal | devicePixelRatioF () const const |
int | height () const const |
int | heightMM () const const |
int | logicalDpiX () const const |
int | logicalDpiY () const const |
bool | paintingActive () const const |
int | physicalDpiX () const const |
int | physicalDpiY () const const |
int | width () const const |
int | widthMM () const const |
Protected Slots | |
void | changed () |
void | markAsChanged () |
void | widgetChanged () |
Detailed Description
The base class for configuration modules.
Configuration modules are realized as plugins that are loaded only when needed.
The module in principle is a simple widget displaying the item to be changed. The module has a very small interface.
All the necessary glue logic and the GUI bells and whistles are provided by the control center and must not concern the module author.
To write a config module, you have to create a library that contains a factory function like the following:
The constructor of the KCModule then looks like this:
If you want to make the KCModule available only conditionally (i.e. show in the list of available modules only if some test succeeds) then you can use Hidden in the .desktop file. An example:
The example executes the given code in a shell and uses the stdout output for the Hidden value (so it's either Hidden=true or Hidden=false).
See http://techbase.kde.org/Development/Tutorials/KCM_HowTo for more detailed documentation.
Definition at line 82 of file kcmodule.h.
Member Typedef Documentation
◆ Buttons
typedef QFlags< Button > KCModule::Buttons |
Stores a combination of Button values.
Definition at line 100 of file kcmodule.h.
Member Enumeration Documentation
◆ Button
enum KCModule::Button |
An enumeration type for the buttons used by this module.
You should only use Help, Default and Apply. The rest is obsolete. NoAdditionalButton can be used when we do not want have other button that Ok Cancel
Definition at line 96 of file kcmodule.h.
Constructor & Destructor Documentation
◆ KCModule() [1/2]
|
explicit |
Base class for all KControlModules.
- Note
- do not emit changed signals here, since they are not yet connected to any slot.
- Parameters
-
aboutData becomes owned by the KCModule
- Deprecated:
- since 5.85, use other constructor and setAboutData()
Definition at line 68 of file kcmodule.cpp.
◆ KCModule() [2/2]
|
explicit |
Base class for all KControlModules.
- Note
- do not emit changed signals here, since they are not yet connected to any slot.
Definition at line 76 of file kcmodule.cpp.
◆ ~KCModule()
|
override |
Destroys the module.
Definition at line 210 of file kcmodule.cpp.
Member Function Documentation
◆ aboutData()
|
virtual |
This is generally only called for the KBugReport.
If you override you should have it return a pointer to a constant.
- Returns
- the KAboutData for this module
- Deprecated:
- since 5.90. Use the KPluginMetaData the KCModule was instantiated from.
Definition at line 286 of file kcmodule.cpp.
◆ addConfig() [1/2]
|
protected |
Adds a KConfigskeleton config
to watch the widget widget
.
This function is useful if you need to handle multiple configuration files.
- Returns
- a pointer to the KConfigDialogManager in use
- Parameters
-
config the KConfigSkeleton to use widget the widget to watch
- Deprecated:
- since 5.84, use addConfig(KCoreConfigSkeleton *config, QWidget *widget);
Definition at line 119 of file kcmodule.cpp.
◆ addConfig() [2/2]
|
protected |
Adds a KCoreConfigskeleton config
to watch the widget widget
.
This function is useful if you need to handle multiple configuration files.
- Returns
- a pointer to the KCoreConfigDialogManager in use
- Parameters
-
config the KCoreConfigSkeleton to use widget the widget to watch
Definition at line 106 of file kcmodule.cpp.
◆ buttons()
KCModule::Buttons KCModule::buttons | ( | ) | const |
Indicate which buttons will be used.
The return value is a value or'ed together from the Button enumeration type.
- See also
- KCModule::setButtons
Definition at line 96 of file kcmodule.cpp.
◆ changed [1/2]
|
protectedslot |
Calling this slot is equivalent to emitting changed(true).
- Deprecated:
- Since 5.64, use markAsChanged
Definition at line 323 of file kcmodule.cpp.
◆ changed [2/2]
|
signal |
Indicate that the state of the modules contents has changed.
This signal is emitted whenever the state of the configuration shown in the module changes. It allows the module container to keep track of unsaved changes.
◆ componentData()
KAboutData KCModule::componentData | ( | ) | const |
- Deprecated:
- since 5.90.
Use the KPluginMetaData the KCModule was instantiated from.
Definition at line 335 of file kcmodule.cpp.
◆ configs()
QList< KConfigDialogManager * > KCModule::configs | ( | ) | const |
- Returns
- a list of KConfigDialogManager's in use, if any.
Definition at line 366 of file kcmodule.cpp.
◆ defaulted
|
signal |
Indicate that the state of the modules contents matches the default settings.
This signal is emitted whenever the state of the configuration shown in the module changes. It allows the module container to keep track of defaults.
- Since
- 5.65
◆ defaults
|
virtualslot |
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.
If you use KConfigXT, you do not have to reimplement this function since the fetching and settings of default values is done automatically. However, if you reimplement and also are using KConfigXT, remember to call the base function at the very end of your reimplementation.
Reimplemented in KCModuleContainer.
Definition at line 233 of file kcmodule.cpp.
◆ defaultsIndicatorsVisible()
bool KCModule::defaultsIndicatorsVisible | ( | ) | const |
Returns whether an indicator is shown when a setting differs from default.
- Since
- 5.73
Definition at line 166 of file kcmodule.cpp.
◆ defaultsIndicatorsVisibleChanged
|
signal |
Emitted when show defaults indicators changed.
- Since
- 5.73
◆ exportText()
QString KCModule::exportText | ( | ) | const |
Returns the value set by setExportText();.
- Deprecated:
- since 5.0, obsolete feature
Definition at line 342 of file kcmodule.cpp.
◆ load
|
virtualslot |
Load the configuration data into the module.
The load method sets the user interface elements of the module to reflect the current settings stored in the configuration files.
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.
Reimplemented in KCModuleContainer, and KSettings::PluginPage.
Definition at line 217 of file kcmodule.cpp.
◆ managedWidgetChangeState()
|
protected |
Returns the changed state of automatically managed widgets in this dialog.
Definition at line 250 of file kcmodule.cpp.
◆ managedWidgetDefaultState()
|
protected |
Returns the defaulted state of automatically managed widgets in this dialog.
- Since
- 5.65
Definition at line 261 of file kcmodule.cpp.
◆ markAsChanged
|
protectedslot |
Calling this slot is equivalent to emitting changed(true).
- Since
- 5.64
Definition at line 329 of file kcmodule.cpp.
◆ needsAuthorization()
bool KCModule::needsAuthorization | ( | ) | const |
Returns the value previously set with setNeedsAuthorization() or setAuthAction().
By default it's false
.
- Returns
true
if the module's save() method requires authorization,false
otherwise
Definition at line 148 of file kcmodule.cpp.
◆ quickHelp()
|
virtual |
Return a quick-help text.
This method may be called when the module is docked. The quick help would generally be used as "what's this" text if the view container supports the "what's this" system. The quick-help text should contain a short description of the module and links to the module's help files. You can use QML formatting tags in the text.
- Note
- make sure the quick help text gets translated (use i18n()).
Definition at line 361 of file kcmodule.cpp.
◆ quickHelpChanged
|
signal |
Indicate that the module's quickhelp has changed.
Emit this signal whenever the module's quickhelp changes. Modules implemented as tabbed dialogs might want to implement per-tab quickhelp for example.
◆ rootOnlyMessage()
QString KCModule::rootOnlyMessage | ( | ) | const |
Get the RootOnly message for this module.
When the module must be run as root, or acts differently for root and a normal user, it is sometimes useful to customize the message that appears at the top of the module when used as a normal user. This function returns this customized message. If none has been set, a default message will be used.
- See also
- KCModule::setRootOnlyMessage
Definition at line 306 of file kcmodule.cpp.
◆ rootOnlyMessageChanged
|
signal |
Indicate that the module's root message has changed.
Emits this signal whenever the module's root message changes.
- Since
- 4.4
◆ save
|
virtualslot |
Save the configuration data.
The save method stores the config information as shown in the user interface in the config files.
If necessary, this method also updates the running system, e.g. by restarting applications. This normally does not apply for KSettings::Dialog modules where the updating is taken care of by KSettings::Dispatcher.
save is called when the user clicks "Apply" or "Ok".
If you use KConfigXT, saving is taken care off automatically and you do not need to load manually. However, if you for some reason reimplement it and also are using KConfigXT, you must call this function, otherwise the saving of KConfigXT options will not work. Call it at the very end of your reimplementation, to avoid changed() signals getting emitted when you modify widgets.
Reimplemented in KCModuleContainer, and KSettings::PluginPage.
Definition at line 225 of file kcmodule.cpp.
◆ setAboutData()
void KCModule::setAboutData | ( | const KAboutData * | about | ) |
This sets the KAboutData returned by aboutData() The about data is now owned by KCModule.
Definition at line 292 of file kcmodule.cpp.
◆ setButtons()
|
protected |
Sets the buttons to display.
Help: shows a "Help" button.
Default: shows a "Use Defaults" button.
Apply: in kcontrol this will show an "Apply" and "Reset" button, in kcmshell this will show an "Ok", "Apply", "Reset" and "Cancel" button.
If Apply is not specified, kcmshell will show a "Close" button.
- See also
- KCModule::buttons
Definition at line 101 of file kcmodule.cpp.
◆ setDefaultsIndicatorsVisible
|
slot |
Show an indicator when settings value differ from default.
- Since
- 5.73
Definition at line 153 of file kcmodule.cpp.
◆ setExportText()
void KCModule::setExportText | ( | const QString & | text | ) |
Sets the export QString value, used for exporting data.
- Deprecated:
- since 5.0, obsolete feature
Definition at line 349 of file kcmodule.cpp.
◆ setNeedsAuthorization()
void KCModule::setNeedsAuthorization | ( | bool | needsAuth | ) |
Set if the module's save() method requires authorization to be executed.
The module can set this property to true
if it requires authorization. It will still have to execute the action itself using the KAuth library, so this method is not technically needed to perform the action, but using this and/or the setAuthAction() method will ensure that hosting applications like System Settings or kcmshell behave correctly.
Called with true
, this method will set the action to "org.kde.kcontrol.name.save" where "name" is aboutData()->appName() return value. This default action won't be set if the aboutData() object is not valid.
Note that called with false
, this method will reset the action name set with setAuthAction().
- Parameters
-
needsAuth Tells if the module's save() method requires authorization to be executed.
Definition at line 132 of file kcmodule.cpp.
◆ setQuickHelp()
|
protected |
Sets the quick help.
Definition at line 355 of file kcmodule.cpp.
◆ setRootOnlyMessage()
|
protected |
Sets the RootOnly message.
This message will be shown at the top of the module if useRootOnlyMessage is set. If no message is set, a default one will be used.
- See also
- KCModule::rootOnlyMessage
Definition at line 300 of file kcmodule.cpp.
◆ setUseRootOnlyMessage()
|
protected |
Change whether or not the RootOnly message should be shown.
Following the value of on
, the RootOnly message will be shown or not.
- See also
- KCModule::useRootOnlyMessage
Definition at line 311 of file kcmodule.cpp.
◆ unmanagedWidgetChangeState()
|
protected |
Call this method when your manually managed widgets change state between changed and not changed.
Definition at line 272 of file kcmodule.cpp.
◆ unmanagedWidgetDefaultState()
|
protected |
Call this method when your manually managed widgets change state between defaulted and not defaulted.
- Since
- 5.65
Definition at line 278 of file kcmodule.cpp.
◆ useRootOnlyMessage()
bool KCModule::useRootOnlyMessage | ( | ) | const |
Tell if KControl should show a RootOnly message when run as a normal user.
In some cases, the module don't want a RootOnly message to appear (for example if it has already one). This function tells KControl if a RootOnly message should be shown
- See also
- KCModule::setUseRootOnlyMessage
Definition at line 317 of file kcmodule.cpp.
◆ widgetChanged
|
protectedslot |
A managed widget was changed, the widget settings and the current settings are compared and a corresponding changed() signal is emitted.
Definition at line 240 of file kcmodule.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Jan 31 2023 03:52:06 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.