DesignPropertyTable.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: DesignPropertyTable
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/DesignTableModel.h>
#include <NDEVR/Button.h>
#include <NDEVR/Translator.h>
#include <QWidget>
#include <QTableView>
#include <functional>
#include <QItemDelegate>
class QHBoxLayout;
namespace NDEVR
{
    class QTModelManager;
    class QCustomTableWidget;
    class DesignObjectSearchWidget;
    class MaterialWidget;
    /**--------------------------------------------------------------------------------------------------
    \brief A QItemDelegate for showing model properties in a QTableView
    **/
    class ModelTableDelegate : public QItemDelegate
    {
        Q_OBJECT
    public:
        explicit ModelTableDelegate(DesignSortFilterProxyModel* model, QObject* parent = nullptr);
        void paint(QPainter* painter, const QStyleOptionViewItem& option, const QModelIndex& index) const override;
        bool editorEvent(QEvent* event, QAbstractItemModel* model, const QStyleOptionViewItem& option, const QModelIndex& index) override;
        void setModel(DesignSortFilterProxyModel* model) { m_table_model = model; };
    protected:
        DesignSortFilterProxyModel* m_table_model;
        mutable MaterialWidget* m_draw_material_widget;
        mutable MaterialWidget* m_click_material_widget;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A QTableView for showing Model or DesignObject properties
    **/
    class DesignPropertyTableView : public QTableView
    {
    public:
        explicit DesignPropertyTableView(QWidget* parent = nullptr);
        void setProxyModel(DesignSortFilterProxyModel* model);
        [[nodiscard]] DesignTableModel* model() const { return m_table_model->model(); }
        QSize minimumSizeHint() const override;
        void refreshAll();
        Buffer<UUID> selectedIDs() const;
    protected:
        void dataChanged(const QModelIndex& topLeft, const QModelIndex& bottomRight, const QVector<int>& roles) override;
        void rowsInserted(const QModelIndex& parent, int start, int end) override;
    protected:
        DesignSortFilterProxyModel* m_table_model;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A base class for tables wishing to show columns of DesignObject properties.
    **/
    class NDEVR_API DesignPropertyTable : public QWidget
    {
        Q_OBJECT
    public:
        explicit DesignPropertyTable(QWidget* parent = nullptr);
        explicit DesignPropertyTable(QTModelManager* manager, QWidget* parent = nullptr);
        virtual ~DesignPropertyTable();
        void setup();
        void filterAndSetList(Buffer<UUID> models);
        void setList(const Buffer<UUID>& models);
        void addListItem(const UUID& id);
        void setupTable();
        bool event(QEvent* event) override;
        void updateRow(uint04 row);
        void setTypeAddedFilter(const String& type);
        void setAddedFilter(const std::function<bool(const Model&)>& callback);
        void addNewButton(std::function<void(Button*)> callback, const TranslatedString& new_title = _t("Add New"), const String& add_icon = "plus");
        void addOpenButton(std::function<void(Button*)> callback, const TranslatedString& new_title = _t("Open"), const String& add_icon = "open");
        void addWidget(QWidget* widget);
        virtual void setModelManager(QTModelManager* manager);
        void setColumnVisible(uint04 column, bool visible);
        uint04 addColumn(DesignObject::DesignProperty property, bool is_editable = true);
        uint04 addColumn(const DesignParameter& parameter, bool is_editable = true);
        uint04 addColumn(const TranslatedString& custom_column_name, const DesignParameter& parameter, bool is_editable = true);
        uint04 addParentPathColumn(const TranslatedString& custom_column_name = TranslatedString());
        uint04 addMaterialDataColumn(const TranslatedString& custom_column_name = TranslatedString());
        uint04 addColumn(const TranslatedString& name, const String& icon, const std::function<void(UUID)>& callback);
        uint04 addColumn(const ModelTableColumnSpec& column);
        void showSearch(bool show_search);
        void setEditable(bool editable);
        void setColumnEditable(uint04 column, bool editable);
        bool isEditable();
        Buffer<UUID> selectedIDs() const;
        void setSelectedCallback(const std::function<void(Model, PopupInfo)>& callback) { m_sort_model->setSelectedCallback(callback); };
        void setSortCallback(const std::function<bool(const Model& a, const Model& b)>& callback);
        const std::function<void(Model, PopupInfo)>& selectedCallback() const { return m_sort_model->selectedCallback(); };
    signals:
        void viewSettingsSignal();
    protected slots:
        void selected(QModelIndex index);
        void contextMenu(const QPoint &pos);
    protected:
        QWidget* m_search_widget;
        DesignObjectSearchWidget* m_search_text;
        Button* m_edit_button;
        QHBoxLayout* m_bottom_button_layout;
        DesignPropertyTableView* m_table_view;
        QTModelManager* m_manager;
        DesignTableModel* m_view_model;
        DesignSortFilterProxyModel* m_sort_model;
    };
}