ProxyModelViewFilter.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: NDEVR
File: ProxyModelViewFilter
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/QTModelManager.h>
#include <NDEVR/QTModelManagerView.h>
#include <QDate>
#include <QSortFilterProxyModel>
 
namespace NDEVR
{
    class Model;
    /**--------------------------------------------------------------------------------------------------
    \brief Filters and sorts Models from a ModelManager for views such as in a table or in a tree view.
    **/
    class NDEVR_API ProxyModelViewFilter : public QSortFilterProxyModel
    {
        Q_OBJECT
    public:
        explicit ProxyModelViewFilter(QTModelManager* manager, QObject* parent = nullptr);
        explicit ProxyModelViewFilter(QTModelManagerView* view, QObject* parent = nullptr);
        QTModelManager& manager() const;
        UUID getID(const QModelIndex& index) const;
        Model model(const QModelIndex& index) const;
        QModelIndex getIndex(const Model& model) const;
        QModelIndex getIndex(const UUID& id) const;
        void setVisibleFilter(const std::function<bool(const Model&)>& filter);
        void setIsRootFilter(const std::function<bool(const Model&)>& filter);
        QIcon::Mode iconMode(const QModelIndex& index) const;
        void setRootModels(const Buffer<UUID>& ids);
        void setAllowEdits(bool allow);
        void setGreyHidden(bool grey_hidden);
        void setShowSelected(bool show_selected);
        void refreshAll();
        void invalidate();
        void setCustomHeader(const TranslatedString& header_title, const String& header_icon);
        Qt::CheckState checkState(const Model& model) const;
        void setAllowSelections(bool allow);
        QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
        Qt::ItemFlags flags(const QModelIndex& index) const override;
        QVariant data(const QModelIndex& proxyIndex, int role = Qt::DisplayRole) const override;
        bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole) override;
        void setCheckState(const Model& model, Qt::CheckState check_state);
        void clearCheckStates();
        void selectAllVisible();
        void setSelectedModelRoots(const Buffer<UUID>& roots, bool only_visible_children);
        void setCheckStateRecursive(const Model& model, Qt::CheckState check_state);
        void setCheckStateAll(Qt::CheckState check_state);
        void setCheckStateAll(GeometryType type, Qt::CheckState check_state);
        void setCheckStateAll(const String& model_type, GeometryType type, Qt::CheckState check_state);
        void setCheckStateAll(const String& model_type, Qt::CheckState check_state);
        void setCheckStateAll(const std::function<bool(const Model& model)>& model_type, Qt::CheckState check_state);
        Buffer<UUID> getSelectedModelRoots() const;
        Buffer<UUID> getModelRoots() const;
        virtual bool lessThan(const QModelIndex& left, const QModelIndex& right) const override;
        bool hasIndex(const UUID& id) const;
    private slots:
        void modelUpdatedSlot(const Buffer<UUID>& updated_ids);
    private:
        void _autosetCheckState(const Model& parent, Qt::CheckState default_check_state);
        bool filterAcceptsRow(int row, const QModelIndex& parent) const override;
        bool isTreeVisible(const Model& m) const;
        bool calculateTreeVisible(const Model& m) const;
    private:
        std::function<bool(const Model&)> m_visible_filter;
        mutable Dictionary<UUID, Qt::CheckState> m_check_states;
        mutable Dictionary<UUID, bool> m_visible_states;
        QTModelManagerView* m_view;
        TranslatedString m_custom_header_title;
        String m_custom_header_icon;
        bool m_allow_selections;
        bool m_allow_edits;
        bool m_grey_hidden;
        bool m_show_selected;
    };
 
}