btbookshelfwidget.h

Go to the documentation of this file.

/*********
*
* In the name of the Father, and of the Son, and of the Holy Spirit.
*
* This file is part of BibleTime's source code, https://bibletime.info/
*
* Copyright 1999-2021 by the BibleTime developers.
* The BibleTime source code is licensed under the GNU General Public License
* version 2.0.
*
**********/
 
#pragma once
 
#include <QWidget>
 
#include <memory>
#include <QObject>
#include <QString>
#include <QStringList>
#include <Qt>
 
 
class BtBookshelfFilterModel;
class BtBookshelfGroupingMenu;
class BtBookshelfTreeModel;
class BtBookshelfView;
class QAbstractItemModel;
class QAction;
class QActionGroup;
class QEvent;
class QHBoxLayout;
class QLabel;
class QLineEdit;
class QMenu;
class QModelIndex;
class QToolButton;
 
class BtBookshelfWidget: public QWidget {
    Q_OBJECT
    public:
        explicit BtBookshelfWidget(QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags());
 
        void setSourceModel(std::shared_ptr<QAbstractItemModel> model);
 
        // Getters for models:
        BtBookshelfTreeModel * treeModel() const { return m_treeModel; }
        BtBookshelfFilterModel * postFilterModel() const
        { return m_postFilterModel; }
 
        // Setters for models:
        void setTreeModel(BtBookshelfTreeModel *model);
 
        // Getters for widgets:
        QWidget * leftCornerWidget() const { return m_leftCornerWidget; }
        QLabel * nameFilterLabel() const { return m_nameFilterLabel; }
        QLineEdit * nameFilterEdit() const { return m_nameFilterEdit; }
        QToolButton * groupingButton() const { return m_groupingButton; }
        QToolButton * showHideButton() const { return m_showHideButton; }
        QWidget * rightCornerWidget() const { return m_rightCornerWidget; }
        BtBookshelfView * treeView() const { return m_treeView; }
        BtBookshelfGroupingMenu * groupingMenu() const
        { return m_groupingMenu; }
        QMenu * contextMenu() const { return m_contextMenu; }
        QMenu * itemContextMenu() const { return m_itemContextMenu; }
 
        // Setters for widgets:
        void setLeftCornerWidget(QWidget *w);
        void setRightCornerWidget(QWidget *w);
 
        // Getters for actions:
        QAction * showHideAction() const { return m_showHideAction; }
 
        // Setters for context menus:
        void setContextMenu(QMenu * newMenu) { m_contextMenu = newMenu; }
        void setItemContextMenu(QMenu * newMenu)
        { m_itemContextMenu = newMenu; }
 
        bool eventFilter(QObject *object, QEvent *event) override;
 
        void loadBookshelfState();
        void saveBookshelfState();
 
    protected:
        void findExpanded(const QModelIndex& index, QString prefix, QStringList * expandedPaths);
        void initActions();
        void initMenus();
        void initWidgets();
        void restoreExpanded(const QModelIndex& index, const QStringList& nodeList);
        void retranslateUi();
 
    private:
        // Models:
        std::shared_ptr<QAbstractItemModel> m_sourceModel;
        BtBookshelfTreeModel   *m_treeModel;
        BtBookshelfFilterModel *m_postFilterModel;
 
        // Widgets:
        QHBoxLayout     *m_toolBar;
        QWidget         *m_leftCornerWidget;
        QWidget         *m_rightCornerWidget;
        QLabel          *m_nameFilterLabel;
        QLineEdit       *m_nameFilterEdit;
        QToolButton     *m_groupingButton;
        QToolButton     *m_showHideButton;
        BtBookshelfView *m_treeView;
 
        // Popup menus:
        QMenu *m_contextMenu;
        BtBookshelfGroupingMenu *m_groupingMenu;
        QAction *m_showHideAction;
        QMenu *m_itemContextMenu;
        QActionGroup *m_itemActionGroup;
        QAction *m_itemOpenAction;
        QAction *m_itemSearchAction;
        QMenu   *m_itemEditMenu;
        QAction *m_itemEditPlainAction;
        QAction *m_itemEditHtmlAction;
        QAction *m_itemUnlockAction;
        QAction *m_itemAboutAction;
};