File indexing completed on 2024-04-14 14:18:23

 /*
     SPDX-FileCopyrightText: 2000 Matthias Elter <elter@kde.org>
     SPDX-FileCopyrightText: 2003 Daniel Molkentin <molkentin@kde.org>
     SPDX-FileCopyrightText: 2003, 2006 Matthias Kretz <kretz@kde.org>
     SPDX-FileCopyrightText: 2021 Alexander Lohnau <alexander.lohnau@gmx.de>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef KCMULTIDIALOG_H
 #define KCMULTIDIALOG_H
 
 #include <QScrollArea>
 #include <QScrollBar>
 
 #include <KPageDialog>
 #include <KPluginMetaData>
 #include <kcmoduleinfo.h>
 
 class KCMultiDialogPrivate;
 
 /**
  * @short A class that offers a KPageDialog containing arbitrary
  *        KControl Modules.
  *
  * @author Matthias Elter <elter@kde.org>, Daniel Molkentin <molkentin@kde.org>
  */
 class KCMUTILS_EXPORT KCMultiDialog : public KPageDialog
 {
     Q_OBJECT
     Q_DECLARE_PRIVATE(KCMultiDialog)
 
 public:
     /**
      * Constructs a new KCMultiDialog
      *
      * @param parent The parent widget
      **/
     explicit KCMultiDialog(QWidget *parent = nullptr);
 
     /**
      * Destructor
      **/
     ~KCMultiDialog() override;
 
 #if KCMUTILS_ENABLE_DEPRECATED_SINCE(5, 85)
     /**
      * Add a module.
      *
      * The module is added according to its KCModuleInfo::weight(). The weight determines where in the list
      * the module will appear. Lighter modules on top, heavier modules at the bottom.
      *
      * @param module Specify the name of the module that is to be added
      *               to the list of modules the dialog will show.
      *
      * @param args The arguments that should be given to the KCModule when it is created
      *
      * @returns The @see KPageWidgetItem associated with the new dialog page.
      * @deprecated Since 5.85, use @p addModule(const KPluginMetaData &metaData) instead
      **/
     KCMUTILS_DEPRECATED_VERSION(5, 85, "use addModule(const KPluginMetaData &metaData) instead")
     KPageWidgetItem *addModule(const QString &module, const QStringList &args = QStringList());
 #endif
 
     /**
      * @since 5.84
      * @overload
      */
     KPageWidgetItem *addModule(const KPluginMetaData &metaData);
 
     /**
      * Add a module to the dialog. Its position will be determined based on the @c X-KDE-Weight value.
      * @param metaData KPluginMetaData that will be used to load the plugin
      * @param args The arguments that should be given to the KCModule when it is created
      * @since 5.85
      */
     KPageWidgetItem *addModule(const KPluginMetaData &metaData, const QStringList &args); // TODO KF6 merge with overload
 
 #if KCMUTILS_ENABLE_DEPRECATED_SINCE(5, 85)
     /**
      * Add a module.
      *
      * The module is added according to its KCModuleInfo::weight(). The weight determines where in the list
      * the module will appear. Lighter modules on top, heavier modules at the bottom.
      *
      * @param moduleinfo Pass a KCModuleInfo object which will be
      *                   used for creating the module. It will be added
      *                   to the list of modules the dialog will show.
      *
      * @param parent The @see KPageWidgetItem that should appear as parents
      *               in the tree view or a 0 pointer if there is no parent.
      *
      * @param args The arguments that should be given to the KCModule when it is created
      * @deprecated Since 5.85, use @p addModule(const KPluginMetaData &metaData) instead
      **/
     KCMUTILS_DEPRECATED_VERSION(5, 85, "use addModule(const KPluginMetaData &metaData) instead")
     KPageWidgetItem *addModule(const KCModuleInfo &moduleinfo, KPageWidgetItem *parent = nullptr, const QStringList &args = QStringList());
 #endif
 
     /**
      * Removes all modules from the dialog.
      */
     void clear();
 
 Q_SIGNALS:
     /**
      * Emitted after all KCModules have been told to save their configuration.
      *
      * The applyClicked and okClicked signals are emitted before the
      * configuration is saved.
      */
     void configCommitted();
 
 #if KCMUTILS_ENABLE_DEPRECATED_SINCE(5, 85)
     /**
      * Emitted after the KCModules have been told to save their configuration.
      * It is emitted once for every instance the KCMs that were changed belong
      * to.
      *
      * You can make use of this if you have more than one component in your
      * application. componentName tells you the instance that has to reload its
      * configuration.
      *
      * The applyClicked and okClicked signals are emitted before the
      * configuration is saved.
      *
      * @param componentName The name of the instance that needs to reload its
      *                     configuration.
      * @deprecated Since 5.85, use @p KCMultiDialog::configCommitted() instead
      */
     KCMUTILS_DEPRECATED_VERSION(5, 85, "use KCMultiDialog::configCommitted() instead")
     void configCommitted(const QByteArray &componentName);
 #endif
 
 protected:
     /**
      * This constructor can be used by subclasses to provide a custom KPageWidget.
      */
     KCMultiDialog(KPageWidget *pageWidget, QWidget *parent, Qt::WindowFlags flags = Qt::WindowFlags());
     KCMultiDialog(KCMultiDialogPrivate &dd, KPageWidget *pageWidget, QWidget *parent, Qt::WindowFlags flags = Qt::WindowFlags());
 
     KCMultiDialogPrivate *const d_ptr;
 
     void closeEvent(QCloseEvent *event) override;
     void showEvent(QShowEvent *event) override;
 
 protected Q_SLOTS:
     /**
      * This slot is called when the user presses the "Default" Button.
      * You can reimplement it if needed.
      *
      * @note Make sure you call the original implementation.
      **/
     void slotDefaultClicked();
 
     /**
      * This slot is called when the user presses the "Reset" Button.
      * You can reimplement it if needed.
      *
      * @note Make sure you call the original implementation.
      */
     void slotUser1Clicked();
 
     /**
      * This slot is called when the user presses the "Apply" Button.
      * You can reimplement it if needed.
      *
      * @note Make sure you call the original implementation.
      **/
     void slotApplyClicked();
 
     /**
      * This slot is called when the user presses the "OK" Button.
      * You can reimplement it if needed.
      *
      * @note Make sure you call the original implementation.
      **/
     void slotOkClicked();
 
     /**
      * This slot is called when the user presses the "Help" Button.
      * It reads the X-DocPath field of the currently selected KControl
      * module's .desktop file to find the path to the documentation,
      * which it then attempts to load.
      *
      * You can reimplement this slot if needed.
      *
      * @note Make sure you call the original implementation.
      **/
     void slotHelpClicked();
 
 private:
     Q_PRIVATE_SLOT(d_func(), void _k_slotCurrentPageChanged(KPageWidgetItem *, KPageWidgetItem *))
     Q_PRIVATE_SLOT(d_func(), void _k_clientChanged())
     Q_PRIVATE_SLOT(d_func(), void _k_updateHeader(bool use, const QString &message))
 };
 
 /**
  * @brief Custom QScrollArea class that doesn't limit its size hint
  *
  * See original QScrollArea::sizeHint() function,
  * where the size hint is bound by 36*24 font heights
  *
  * Workaround for https://bugreports.qt.io/browse/QTBUG-10459
  */
 
 class UnboundScrollArea : public QScrollArea
 {
     Q_OBJECT
 public:
     QSize sizeHint() const override
     {
         if (widget()) {
             // Try to avoid horizontal scrollbar, which just scrolls a scrollbar width.
             // We always need to reserve space for the vertical scroll bar,
             // because we can’t know here whether vertical scrolling will be used.
             QSize withScrollbar = widget()->sizeHint();
             withScrollbar.rwidth() += verticalScrollBar()->sizeHint().width() + 4;
             return withScrollbar;
         } else {
             return QScrollArea::sizeHint();
         }
     }
 
     UnboundScrollArea(QWidget *w)
         : QScrollArea(w)
     {
     }
     ~UnboundScrollArea() override = default;
 };
 
 #endif