PTreeModel.h

Go to the documentation of this file.

#ifndef PTREEMODEL_H_INCLUDED
#define PTREEMODEL_H_INCLUDED
/*
 * Copyright 2011-2016 Universiteit Antwerpen
 *
 * Licensed under the EUPL, Version 1.1 or  as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at: http://ec.europa.eu/idabc/eupl5
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing
 * permissions and limitations under the Licence.
 */
#include <boost/property_tree/ptree_fwd.hpp>
#include <QAbstractItemModel>
#include <vector>

class QUndoStack;

namespace SimShell {
namespace Gui {

class PTreeModel : public QAbstractItemModel
{
        Q_OBJECT
public:
        PTreeModel(boost::property_tree::ptree const& tree, QObject* parent = 0);

        PTreeModel(PTreeModel const&) =delete;

        PTreeModel & operator=(PTreeModel const&);

        virtual ~PTreeModel();

        bool IsOnlyEditData() const;

        bool MoveRow(int  old_row, QModelIndex const& old_parent, int new_row, QModelIndex const& new_parent);

        bool MoveRows(int old_row, QModelIndex const& old_parent, int new_row, QModelIndex const& new_parent, int count);

        void SetOnlyEditData(bool);

        void SetUndoStack(QUndoStack*);

        // Notice: Load() method is gone. If you want to load a different ptree,
        // simply construct a new model!

        boost::property_tree::ptree Store() const;

        // Implementation of QAbstractItemModel, see QAbstractItemModel documentation for details.
        virtual int columnCount(QModelIndex const& parent = QModelIndex()) const;
        virtual QVariant data(QModelIndex const& index, int role = Qt::DisplayRole) const;
        virtual Qt::ItemFlags flags(QModelIndex const& index) const;
        virtual QVariant headerData(int section, Qt::Orientation, int role) const;
        virtual QModelIndex index(int row, int column, QModelIndex const& parent = QModelIndex()) const;
        virtual bool insertRow(int row, QModelIndex const& parent = QModelIndex());
        virtual bool insertRows(int row, int count, QModelIndex const& parent = QModelIndex());
        virtual bool removeRow(int row, QModelIndex const& parent = QModelIndex());
        virtual bool removeRows(int row, int count, QModelIndex const& parent = QModelIndex());
        virtual QModelIndex parent(QModelIndex const& index) const;
        virtual int rowCount(QModelIndex const& parent = QModelIndex()) const;
        virtual bool setData(QModelIndex const& index, QVariant const& value, int role = Qt::EditRole);
        virtual Qt::DropActions supportedDragActions() const;
        virtual Qt::DropActions supportedDropActions() const;
        virtual QStringList mimeTypes() const;
        virtual QMimeData* mimeData(QModelIndexList const& indexes) const;
        virtual bool dropMimeData(const QMimeData* data, Qt::DropAction action, int row, int column, QModelIndex const& parent);

private:
        struct Item
        {
        public:
                Item(Item* parent = 0, QVariant const& key = QVariant(), int row = 0);
                Item(Item const&);
                Item& operator=(Item const&);
                ~Item();

                Item* GetParent();

                Item* GetChild(unsigned int i);

                Item const* GetChild(unsigned int i) const;

                int GetChildrenCount() const;

                Item const* GetParent() const;

                void InsertChild(unsigned int row, Item*);

                void Load(boost::property_tree::ptree const& t);

                void RemoveChild(unsigned int row);

                boost::property_tree::ptree Store() const;

                QVariant   key;
                QVariant   data;
                QVariant   background;
                int        row;

        private:
                Item*               parent;   // read-only
                std::vector<Item*>  children; // use public methods!
        };

        QUndoStack*   undo_stack;
        Item*         root;
        bool          only_edit_data;

        class EditKeyCommand;
        class EditDataCommand;
        class InsertRowsCommand;
        class RemoveRowsCommand;
        class MoveRowsCommand;
};

} // namespace
} // namespace

#endif // end_of_inclde_guard