ShapeList.h

Go to the documentation of this file.

#ifndef ShapeList_H
#define ShapeList_H

#include <QDebug>
#include <QObject>
#include <QList>
#include <QMetaType>

#include "Shape.h"
#include "ShapeDisplayProperties.h"
#include "SerialNumberList.h"
#include "WorkOrder.h"
#include "XmlStackedHandler.h"

class QStringList;
class QXmlStreamWriter;

namespace Isis {
  class FileName;
  class XmlStackedHandlerReader;

  class ShapeList : public QObject, public QList<Shape *> {
    Q_OBJECT

    public:
      ShapeList(QString name, QString path, QObject *parent = NULL);
      explicit ShapeList(QObject *parent = NULL);
      explicit ShapeList(QList<Shape *>, QObject *parent = NULL);
      explicit ShapeList(Project *project,
                         XmlStackedHandlerReader *xmlReader, QObject *parent = NULL);
      explicit ShapeList(QStringList &);
      ShapeList(const ShapeList &);
      ~ShapeList();

      SerialNumberList serialNumberList();

      // These are overridden (-ish) in order to add notifications to the list changing
      void append(Shape * const & value);
      void append(const QList<Shape *> &value);

      void clear();

      iterator erase(iterator pos);
      iterator erase(iterator begin, iterator end);

      void insert(int i, Shape * const & value);
      iterator insert(iterator before, Shape * const & value);

      void prepend(Shape * const & value);
      void push_back(Shape * const & value);
      void push_front(Shape * const & value);
      int removeAll(Shape * const & value);
      void removeAt(int i);
      void removeFirst();
      void removeLast();
      bool removeOne(Shape * const & value);
      void swap(QList<Shape *> &other);
      Shape *takeAt(int i);
      Shape *takeFirst();
      Shape *takeLast();

      ShapeList &operator+=(const QList<Shape *> &other);
      ShapeList &operator+=(Shape * const &other);
      ShapeList &operator<<(const QList<Shape *> &other);
      ShapeList &operator<<(Shape * const &other);
      ShapeList &operator=(const QList<Shape *> &rhs);

      // This is our own assignment, but it needs to notify just like the operator=(QList)
      ShapeList &operator=(const ShapeList &rhs);

      // Done overriding (-ish)

      void setName(QString newName);
      void setPath(QString newPath);

      QString name() const;
      QString path() const;

      void deleteFromDisk(Project *project);
      void save(QXmlStreamWriter &stream, const Project *project, FileName newProjectRoot) const;


    signals:
      void countChanged(int newCount);

    private:
      class XmlHandler : public XmlStackedHandler {
        public:
          XmlHandler(ShapeList *shapeList, Project *project);

          virtual bool startElement(const QString &namespaceURI, const QString &localName,
                                    const QString &qName, const QXmlAttributes &atts);
          virtual bool endElement(const QString &namespaceURI, const QString &localName,
                                  const QString &qName);

        private:
          Q_DISABLE_COPY(XmlHandler);

          ShapeList *m_shapeList;
          Project *m_project;
      };


      class CopyShapeDataFunctor : public std::unary_function<Shape * const &, void *> {
        public:
          CopyShapeDataFunctor(const Project *project, FileName newProjectRoot);
          CopyShapeDataFunctor(const CopyShapeDataFunctor &other);
          ~CopyShapeDataFunctor();

          void *operator()(Shape * const &shapeToCopy);

          CopyShapeDataFunctor &operator=(const CopyShapeDataFunctor &rhs);

        private:
          const Project *m_project;
          FileName m_newProjectRoot;
      };

    private slots:

    private:
      QString m_name;

      QString m_path;
  };

}

Q_DECLARE_METATYPE(Isis::ShapeList *);

#endif