File indexing completed on 2025-01-19 03:53:50

 /* ============================================================
  *
  * This file is a part of digiKam project
  * https://www.digikam.org
  *
  * Date        : 2009-11-03
  * Description : A dialog base class which can handle multiple pages.
  *
  * SPDX-FileCopyrightText: 2009-2024 by Gilles Caulier <caulier dot gilles at gmail dot com>
  * SPDX-FileCopyrightText: 2006      by Tobias Koenig <tokoe at kde dot org>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  *
  * ============================================================ */
 
 #ifndef DIGIKAM_DCONFIG_DLG_VIEW_H
 #define DIGIKAM_DCONFIG_DLG_VIEW_H
 
 // Qt includes
 
 #include <QWidget>
 
 // Local includes
 
 #include "digikam_export.h"
 
 class QAbstractItemDelegate;
 class QAbstractItemView;
 class QModelIndex;
 class QAbstractItemModel;
 
 namespace Digikam
 {
 
 class DConfigDlgViewPrivate;
 class DConfigDlgModel;
 
 /**
  * @short A base class which can handle multiple pages.
  *
  * This class provides a widget base class which handles multiple
  * pages and allows the user to switch between these pages in
  * different ways.
  *
  * Currently, @p Auto, @p Plain, @p List, @p Tree and @p Tabbed face
  * types are available. @see DConfigDlgWdg
  *
  */
 class DIGIKAM_EXPORT DConfigDlgView : public QWidget
 {
     Q_OBJECT
     Q_PROPERTY(FaceType faceType READ faceType WRITE setFaceType)
     Q_DECLARE_PRIVATE(DConfigDlgView)
 
 public:
 
     /**
      * This enum is used to decide which type of navigation view
      * shall be used in the page view.
      *
      * @li Auto   - Depending on the number of pages in the model,
      *              the Plain (one page), the List (several pages)
      *              or the Tree face (nested pages) will be used.
      *              This is the default face type.
      * @li Plain  - No navigation view will be visible and only the
      *              first page of the model will be shown.
      *
      * @li List   - An icon list is used as navigation view.
      *
      * @li Tree   - A tree list is used as navigation view.
      *
      * @li Tabbed - A tab widget is used as navigation view.
      */
     enum FaceType
     {
         Auto,
         Plain,
         List,
         Tree,
         Tabbed
     };
     Q_ENUM(FaceType)
 
 public:
 
     /**
      * Creates a page view with given parent.
      */
     explicit DConfigDlgView(QWidget* const parent = nullptr);
 
     /**
      * Destroys the page view.
      */
     ~DConfigDlgView() override;
 
     /**
      * Sets the @p model of the page view.
      *
      * The model has to provide data for the roles defined in DConfigDlgModel::Role.
      */
     void setModel(QAbstractItemModel* model);
 
     /**
      * Returns the model of the page view.
      */
     QAbstractItemModel* model() const;
 
     /**
      * Sets the face type of the page view.
      */
     void setFaceType(FaceType faceType);
 
     /**
      * Returns the face type of the page view.
      */
     FaceType faceType() const;
 
     /**
      * Sets the page with @param index to be the current page and emits
      * the @see currentPageChanged signal.
      */
     void setCurrentPage(const QModelIndex& index);
 
     /**
      * Returns the index for the current page or an invalid index
      * if no current page exists.
      */
     QModelIndex currentPage() const;
 
     /**
      * Sets the item @param delegate which can be used customize
      * the page view.
      */
     void setItemDelegate(QAbstractItemDelegate* delegate);
 
     /**
      * Returns the item delegate of the page view.
      */
     QAbstractItemDelegate* itemDelegate() const;
 
     /**
      * Sets the @p widget which will be shown when a page is selected
      * that has no own widget set.
      */
     void setDefaultWidget(QWidget* widget);
 
 Q_SIGNALS:
 
     /**
      * This signal is emitted whenever the current page changes.
      * The previous page index is replaced by the current index.
      */
     void currentPageChanged(const QModelIndex& current, const QModelIndex& previous);
 
 protected:
 
     /**
      * Returns the navigation view, depending on the current
      * face type.
      *
      * This method can be reimplemented to provide custom
      * navigation views.
      */
     virtual QAbstractItemView* createView();
 
     /**
      * Returns whether the page header should be visible.
      *
      * This method can be reimplemented for adapting custom
      * views.
      */
     virtual bool showPageHeader() const;
 
     /**
      * Returns the position where the navigation view should be
      * located according to the page stack.
      *
      * This method can be reimplemented for adapting custom
      * views.
      */
     virtual Qt::Alignment viewPosition() const;
 
     DConfigDlgView(DConfigDlgViewPrivate& dd, QWidget* const parent);
 
 protected:
 
     DConfigDlgViewPrivate* const d_ptr;
 
 private:
 
     Q_PRIVATE_SLOT(d_func(), void _k_rebuildGui())
     Q_PRIVATE_SLOT(d_func(), void _k_modelChanged())
     Q_PRIVATE_SLOT(d_func(), void _k_pageSelected(const QItemSelection&, const QItemSelection&))
     Q_PRIVATE_SLOT(d_func(), void _k_dataChanged(const QModelIndex&, const QModelIndex&))
 };
 
 } // namespace Digikam
 
 #endif // DIGIKAM_DCONFIG_DLG_VIEW_H