BasicTreeModel.h++

Go to the documentation of this file.

#ifndef __libquark_gui_BasicTreeModel_hxx
#define __libquark_gui_BasicTreeModel_hxx

#include <QBuffer>
#include <QDataStream>
#include <QDebug>
#include <QIcon>
#include <QMimeData>
#include <QStringList>
#include <QVector>

#include <quark/BasicTreeModelBase.h++>

namespace quark {
namespace gui {

template<class T, class IS = QDataStream, class OS = QDataStream>
class BasicTreeModel : public BasicTreeModelBase
{
  public:

  virtual ~BasicTreeModel();

  virtual int columnCount(const QModelIndex &parent = QModelIndex()) const;
  virtual int rowCount(const QModelIndex &parent = QModelIndex()) const;

  virtual QVariant headerData(int section, Qt::Orientation orientation,
                              int role = Qt::DisplayRole) const;

  virtual QVariant data(const QModelIndex &index, int role = Qt::DisplayRole)
    const;
  virtual bool setData(const QModelIndex &index, const QVariant &value,
                       int role = Qt::EditRole);

  virtual bool hasChildren(const QModelIndex &parent = QModelIndex()) const;
  virtual QModelIndex index(int row, int column,
                            const QModelIndex &parent = QModelIndex()) const;
  virtual QModelIndex parent(const QModelIndex &index) const;

  virtual bool canFetchMore(const QModelIndex &index) const;
  virtual void fetchMore(const QModelIndex &index);

  virtual Qt::ItemFlags flags(const QModelIndex & index) const;

  virtual bool removeRows(int row, int count,
                          const QModelIndex &parent = QModelIndex());

  virtual QStringList mimeTypes() const;
  virtual QMimeData *mimeData(const QModelIndexList &indexes) const;
  virtual bool dropMimeData(const QMimeData *mimeData, Qt::DropAction action,
                            int row, int column, const QModelIndex &parent);

  void clear();
  bool isEmpty() const;
  void addItem(T *parent, T *item);
  void insertItemAt(T *parent, int index, T *item);
  void setItems(T *parent, QList<T *> items);
  T *getItemAt(const T *parent, int index) const;
  T *takeItemAt(const T *parent, int index);
  T* getRootItem() const;

  void removeItem(T *item);
  void removeChildItem(T *parent, int index);
  int itemCount(const T *parent) const;
  void updateItem(T *item);
  int indexOf(const T *parent, const T *item) const;

  T *getParentItem(const T *item) const;

  T* getItemForIndex(const QModelIndex& index) const;
  void unloadItemsForIndex(const QModelIndex& parent);
  QModelIndex getIndexForItem(const T *item) const;

  virtual bool isLeaf(const T &item) const = 0;

  virtual QVariant getFieldValue(const T &item, int field) const = 0;

  virtual bool write(OS &stream) const;
  virtual bool read(IS &stream);

  protected:

  typedef BasicTreeModelBase::Option Option;
  typedef BasicTreeModelBase::Options Options;

  BasicTreeModel(T *root, Options options = 0, QObject *parent = NULL);

  virtual QIcon getIcon(const T &item) const;

  virtual Qt::AlignmentFlag getFieldAlignment(const T &item, int field) const;
  virtual QString getFieldToolTip(const T &item, int field) const;

  virtual bool setFieldValue(T *item, int field, const QVariant &value);

  virtual bool isDraggable(const T &item) const;
  virtual bool isDroppable(const T &item) const;
  virtual bool isRootDroppable() const;
  virtual bool isDynamic(const T &item) const;

  virtual void loadChildren(T *parent);

  virtual void onItemReparented(T *item, T *parent);

  virtual bool dropOtherMimeData(const QMimeData *mimeData,
                                 Qt::DropAction action, int row,
                                 int column, const QModelIndex &parent);
  virtual QString itemMimeType() const;
  virtual QStringList otherMimeTypes() const;

  virtual void writeProlog(OS &stream) const;
  virtual void writeItem(const T &item, OS &stream) const;
  virtual void writeEndItem(const T &item, OS &stream) const;
  virtual void writeEpilog(OS &stream) const;

  virtual bool readProlog(IS &stream);
  virtual T *readItem(IS &stream);
  virtual void readEndItem(T *item, IS &stream);
  virtual bool readEpilog(IS &stream);

  private:

  struct Node;

  bool readInto(IS &stream, const QModelIndex &parent, int row);
  inline Node *nodeForIndex(const QModelIndex &index) const;
  QModelIndex indexForNode(const Node *node) const;
  bool serialize(const Node *node, OS &stream, bool childrenOnly = false)
      const;
  bool deserialize(Node *node, IS &stream);
  void addNodesToMap(Node *node);
  void removeNodesFromMap(Node *node);

  Node *_root;
  QMap<const T *, Node *> _nodeMap;
};

#include <quark/BasicTreeModelImpl.h++>

} // namespace gui
} // namespace quark

#endif // __libquark_gui_BasicTableModel_hxx