qgsoptionsdialogbase.h

Go to the documentation of this file.

/***************************************************************************
    qgsoptionsdialogbase.h - base vertical tabs option dialog
 
    ---------------------
    begin                : March 24, 2013
    copyright            : (C) 2013 by Larry Shaffer
    email                : larrys at dakcarto dot com
 ***************************************************************************
 *                                                                         *
 *   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 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSOPTIONSDIALOGBASE_H
#define QGSOPTIONSDIALOGBASE_H
 
#include <functional>
 
#include "qgis_gui.h"
#include "qgsguiutils.h"
#include "qgssettings.h"
 
#include <QDialog>
#include <QPointer>
#include <QSortFilterProxyModel>
#include <QStyledItemDelegate>
 
class QDialogButtonBox;
class QListWidget;
class QModelIndex;
class QPalette;
class QPainter;
class QStackedWidget;
class QStyleOptionViewItem;
class QSplitter;
class QStandardItem;
class QTreeView;
class QStandardItemModel;
 
class QgsFilterLineEdit;
class QgsOptionsDialogHighlightWidget;
 
#ifndef SIP_RUN
class GUI_EXPORT QgsOptionsProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
  public:
    QgsOptionsProxyModel( QObject *parent );
 
    void setPageHidden( int page, bool hidden );
    QModelIndex pageNumberToSourceIndex( int page ) const;
    int sourceIndexToPageNumber( const QModelIndex &index ) const;
    bool filterAcceptsRow( int source_row, const QModelIndex &source_parent ) const override;
 
  private:
    QMap<int, bool> mHiddenPages;
};
#endif
 

 
class GUI_EXPORT QgsOptionsDialogBase : public QDialog
{
    Q_OBJECT
 
  public:
    QgsOptionsDialogBase( const QString &settingsKey, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags fl = Qt::WindowFlags(), QgsSettings *settings = nullptr );
    ~QgsOptionsDialogBase() override;

    void initOptionsBase( bool restoreUi = true, const QString &title = QString() );
 
    // set custom QgsSettings pointer if dialog used outside QGIS (in plugin)
    void setSettings( QgsSettings *settings );

    void restoreOptionsBaseUi( const QString &title = QString() );

    void restoreLastPage();

    void resizeAlltabs( int index );

    bool iconOnly() const { return mIconOnly; }

    void setCurrentPage( const QString &page );

    void addPage( const QString &title, const QString &tooltip, const QIcon &icon, QWidget *widget SIP_TRANSFER, const QStringList &path = QStringList(), const QString &key = QString() );

    void insertPage(
      const QString &title, const QString &tooltip, const QIcon &icon, QWidget *widget SIP_TRANSFER, const QString &before, const QStringList &path = QStringList(), const QString &key = QString()
    );
 
  public slots:

    void searchText( const QString &text );
 
  protected slots:
    virtual void updateOptionsListVerticalTabs();
    virtual void optionsStackedWidget_CurrentChanged( int index );
    virtual void optionsStackedWidget_WidgetRemoved( int index );
 
    void warnAboutMissingObjects();
 
  protected:
    void showEvent( QShowEvent *e ) override;
    void paintEvent( QPaintEvent *e ) override;
 
    virtual void updateWindowTitle();

    void registerTextSearchWidgets();

    QStandardItem *createItem( const QString &name, const QString &tooltip, const QString &icon ) SIP_SKIP;
 
    QList<QPair<QgsOptionsDialogHighlightWidget *, int>> mRegisteredSearchWidgets;
 
    QString mOptsKey;
    bool mInit = false;
    QListWidget *mOptListWidget = nullptr;
    QTreeView *mOptTreeView = nullptr;
    QStandardItemModel *mOptTreeModel = nullptr;
    QgsOptionsProxyModel *mTreeProxyModel = nullptr;
 
    QStackedWidget *mOptStackedWidget = nullptr;
    QSplitter *mOptSplitter = nullptr;
    QDialogButtonBox *mOptButtonBox = nullptr;
    QgsFilterLineEdit *mSearchLineEdit = nullptr;
    QString mDialogTitle;
    bool mIconOnly = false;
    // pointer to app or custom, external QgsSettings
    // QPointer in case custom settings obj gets deleted while dialog is open
    QPointer<QgsSettings> mSettings;
    bool mDelSettings = false;
 
  private:
    void setListToItemAtIndex( int index );
};
 
#endif // QGSOPTIONSDIALOGBASE_H