dconfigdlgwidgets.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) 2006      by Tobias Koenig <tokoe 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_WIDGETS_H
#define DIGIKAM_DCONFIG_DLG_WIDGETS_H
 
// Qt includes
 
#include <QWidget>
 
// Local includes
 
#include "dconfigdlgmodels.h"
#include "dconfigdlgview.h"
#include "digikam_export.h"
 
namespace Digikam
{
 
class DConfigDlgWdgPrivate;
 
class DIGIKAM_EXPORT DConfigDlgWdg : public DConfigDlgView
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(DConfigDlgWdg)
 
public:
 
    explicit DConfigDlgWdg(QWidget* const parent = nullptr);
 
    ~DConfigDlgWdg() 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);
 
    void setCurrentPage(DConfigDlgWdgItem* item);
 
    DConfigDlgWdgItem* currentPage() const;
 
Q_SIGNALS:
 
    void currentPageChanged(DConfigDlgWdgItem* current, DConfigDlgWdgItem* before);
 
    void pageToggled(DConfigDlgWdgItem* page, bool checked);
 
    void pageRemoved(DConfigDlgWdgItem* page);
 
protected:
 
    DConfigDlgWdg(DConfigDlgWdgPrivate& dd, QWidget* const parent);
 
private:
 
    Q_PRIVATE_SLOT(d_func(), void _k_slotCurrentPageChanged(const QModelIndex&, const QModelIndex&))
};
 
// ----------------------------------------------------------------------------------------------------------------
 
class DConfigDlgTitle : public QWidget
{
    Q_OBJECT
    Q_PROPERTY(QString text READ text WRITE setText)
    Q_PROPERTY(QString comment READ comment WRITE setComment)
    Q_PROPERTY(QPixmap pixmap READ pixmap WRITE setPixmap)
    Q_PROPERTY(int autoHideTimeout READ autoHideTimeout WRITE setAutoHideTimeout)
 
public:
 
    enum ImageAlignment
    {
        ImageLeft,      
        ImageRight      
    };
    Q_ENUM(ImageAlignment)
 
    
    enum MessageType
    {
        PlainMessage,   
        InfoMessage,    
        WarningMessage, 
        ErrorMessage    
    };
 
public:
 
    explicit DConfigDlgTitle(QWidget* const parent = nullptr);
 
    ~DConfigDlgTitle()                  override;
 
    void setWidget(QWidget* const widget);
 
    QString text()          const;
 
    QString comment()       const;
 
    QPixmap pixmap() const;
 
    void setBuddy(QWidget* const buddy);
 
    int autoHideTimeout()   const;
 
public Q_SLOTS:
 
    void setText(const QString& text, Qt::Alignment alignment = Qt::AlignLeft | Qt::AlignVCenter);
    void setText(const QString& text, MessageType type);
 
    void setComment(const QString& comment, MessageType type = PlainMessage);
 
    void setPixmap(const QPixmap& pixmap, ImageAlignment alignment = ImageRight);
 
    void setPixmap(const QString& icon, ImageAlignment alignment = ImageRight);
 
    void setPixmap(const QIcon& icon, ImageAlignment alignment = ImageRight);
 
    void setPixmap(MessageType type, ImageAlignment alignment = ImageRight);
 
    void setAutoHideTimeout(int msecs);
 
protected:
 
    void changeEvent(QEvent*)           override;
    void showEvent(QShowEvent*)         override;
    bool eventFilter(QObject*, QEvent*) override;
 
private:
 
    class Private;
    Private* const d;
 
    Q_PRIVATE_SLOT(d, void _k_timeoutFinished())
    Q_DISABLE_COPY(DConfigDlgTitle)
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DCONFIG_DLG_WIDGETS_H