dconfigdlg.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) 1999-2001 by Mirko Boehm <mirko at kde dot org>
 * Copyright (C) 1999-2001 by Espen Sand <espen at kde dot org>
 * Copyright (C) 1999-2001 by Holger Freyther <freyther at kde dot org>
 * Copyright (C) 2005-2006 by Olivier Goffart <ogoffart at kde dot org>
 * 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_H
#define DIGIKAM_DCONFIG_DLG_H
 
// Qt includes
 
#include <QDialog>
#include <QDialogButtonBox>
 
// Local includes
 
#include "dconfigdlgwidgets.h"
#include "digikam_export.h"
 
namespace Digikam
{
 
class DConfigDlgPrivate;
 
class DIGIKAM_EXPORT DConfigDlg : public QDialog
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(DConfigDlg)
 
public:
 
    enum FaceType
    {
        Auto   = DConfigDlgView::Auto,
        Plain  = DConfigDlgView::Plain,
        List   = DConfigDlgView::List,
        Tree   = DConfigDlgView::Tree,
        Tabbed = DConfigDlgView::Tabbed
    };
 
public:
 
    explicit DConfigDlg(QWidget* const parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags());
 
    ~DConfigDlg()                                                     override;
 
    void setFaceType(FaceType faceType);
 
    DConfigDlgWdgItem* addPage(QWidget* const widget, const QString& name);
 
    void addPage(DConfigDlgWdgItem* const item);
 
    DConfigDlgWdgItem* insertPage(DConfigDlgWdgItem* const before, QWidget* const widget, const QString& name);
 
    void insertPage(DConfigDlgWdgItem* const before, DConfigDlgWdgItem* const item);
 
    DConfigDlgWdgItem* addSubPage(DConfigDlgWdgItem* const parent, QWidget* const widget, const QString& name);
 
    void addSubPage(DConfigDlgWdgItem* const parent, DConfigDlgWdgItem* const item);
 
    void removePage(DConfigDlgWdgItem* const item);
 
    void setCurrentPage(DConfigDlgWdgItem* const item);
 
    DConfigDlgWdgItem* currentPage()                            const;
 
    void setStandardButtons(QDialogButtonBox::StandardButtons buttons);
 
    QPushButton* button(QDialogButtonBox::StandardButton which) const;
 
    void addActionButton(QAbstractButton* const button);
 
Q_SIGNALS:
 
    void currentPageChanged(DConfigDlgWdgItem* current, DConfigDlgWdgItem* before);
 
    void pageRemoved(DConfigDlgWdgItem* page);
 
protected:
 
    DConfigDlg(DConfigDlgWdg* const widget, QWidget* const parent, Qt::WindowFlags flags = Qt::WindowFlags());
    DConfigDlg(DConfigDlgPrivate& dd, DConfigDlgWdg* const widget, QWidget* const parent, Qt::WindowFlags flags = Qt::WindowFlags());
 
    DConfigDlgWdg* pageWidget();
 
    const DConfigDlgWdg* pageWidget()                           const;
 
    void setPageWidget(DConfigDlgWdg* const widget);
 
    QDialogButtonBox* buttonBox();
 
    const QDialogButtonBox* buttonBox()                         const;
 
    void setButtonBox(QDialogButtonBox* const box);
 
protected:
 
    DConfigDlgPrivate* const d_ptr;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DCONFIG_DLG_H