dconfigdlgmodels.h

Go to the documentation of this file.

/* ============================================================
 *
 * 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.
 *
 * Copyright (C) 2009-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2007      by Matthias Kretz <kretz at kde dot org>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_DCONFIG_DLG_MODELS_H
#define DIGIKAM_DCONFIG_DLG_MODELS_H
 
// Qt includes
 
#include <QAbstractItemModel>
#include <QWidget>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DConfigDlgModelPrivate;
 
class DConfigDlgModel : public QAbstractItemModel
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(DConfigDlgModel)
 
public:
 
    enum Role
    {
        HeaderRole = Qt::UserRole + 1,
 
        WidgetRole
    };
 
    explicit DConfigDlgModel(QObject* const parent = nullptr);
 
    ~DConfigDlgModel() override;
 
protected:
 
    DConfigDlgModel(DConfigDlgModelPrivate& dd, QObject* const parent);
 
protected:
 
    DConfigDlgModelPrivate* const d_ptr;
};
 
// --------------------------------------------------------------------------
 
class DIGIKAM_EXPORT DConfigDlgWdgItem : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString name READ name WRITE setName)
    Q_PROPERTY(QString header READ header WRITE setHeader)
    Q_PROPERTY(QIcon icon READ icon WRITE setIcon)
    Q_PROPERTY(bool checkable READ isCheckable WRITE setCheckable)
    Q_PROPERTY(bool checked READ isChecked WRITE setChecked)
    Q_PROPERTY(bool enabled READ isEnabled WRITE setEnabled)
 
public:
 
    explicit DConfigDlgWdgItem(QWidget* widget);
 
    DConfigDlgWdgItem(QWidget* widget, const QString& name);
 
    ~DConfigDlgWdgItem() override;
 
    QWidget* widget() const;
 
    void setName(const QString& name);
 
    QString name() const;
 
    void setHeader(const QString& header);
 
    QString header() const;
 
    void setIcon(const QIcon& icon);
 
    QIcon icon() const;
 
    void setCheckable(bool checkable);
 
    bool isCheckable() const;
 
    bool isChecked() const;
 
    bool isEnabled() const;
 
public Q_SLOTS:
 
    void setEnabled(bool);
 
    void setChecked(bool checked);
 
Q_SIGNALS:
 
    void changed();
 
    void toggled(bool checked);
 
private:
 
    class Private;
    Private* const d;
};
 
// --------------------------------------------------------------------------
 
class DConfigDlgWdgModelPrivate;
 
class DConfigDlgWdgModel : public DConfigDlgModel
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(DConfigDlgWdgModel)
 
public:
 
    explicit DConfigDlgWdgModel(QObject* const parent = nullptr);
 
    ~DConfigDlgWdgModel() override;
 
    DConfigDlgWdgItem* addPage(QWidget* widget, const QString& name);
 
    void addPage(DConfigDlgWdgItem* item);
 
    DConfigDlgWdgItem* insertPage(DConfigDlgWdgItem* before, QWidget* widget, const QString& name);
 
    void insertPage(DConfigDlgWdgItem* before, DConfigDlgWdgItem* item);
 
    DConfigDlgWdgItem* addSubPage(DConfigDlgWdgItem* parent, QWidget* widget, const QString& name);
 
    void addSubPage(DConfigDlgWdgItem* parent, DConfigDlgWdgItem* item);
 
    void removePage(DConfigDlgWdgItem* item);
 
    int columnCount(const QModelIndex& parent = QModelIndex()) const                        override;
    QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const               override;
    bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole)  override;
    Qt::ItemFlags flags(const QModelIndex& index) const                                     override;
    QModelIndex index(int row, int column, const QModelIndex& parent = QModelIndex()) const override;
    QModelIndex parent(const QModelIndex& index) const                                      override;
    int rowCount(const QModelIndex& parent = QModelIndex()) const                           override;
 
    DConfigDlgWdgItem* item(const QModelIndex& index) const;
 
    QModelIndex index(const DConfigDlgWdgItem* item) const;
 
Q_SIGNALS:
 
    void toggled(DConfigDlgWdgItem* page, bool checked);
 
private:
 
    Q_PRIVATE_SLOT(d_func(), void _k_itemChanged())
    Q_PRIVATE_SLOT(d_func(), void _k_itemToggled(bool))
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DCONFIG_DLG_MODELS_H