AbstractAspect.h

Go to the documentation of this file.

/***************************************************************************
    File                 : AbstractAspect.h
    Project              : SciDAVis
    --------------------------------------------------------------------
    Copyright            : (C) 2007 by Knut Franke, Tilman Benkert
    Email (use @ for *)  : knut.franke*gmx.de, thzs*gmx.net
    Description          : Base class for all persistent objects in a Project.

 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *  This program is free software; you can redistribute it and/or modify   *
 *  it under the terms of the GNU General Public License as published by   *
 *  the Free Software Foundation; either version 2 of the License, or      *
 *  (at your option) any later version.                                    *
 *                                                                         *
 *  This program is distributed in the hope that it will be useful,        *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
 *  GNU General Public License for more details.                           *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the Free Software           *
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor,                    *
 *   Boston, MA  02110-1301  USA                                           *
 *                                                                         *
 ***************************************************************************/
#ifndef ABSTRACT_ASPECT_H
#define ABSTRACT_ASPECT_H

#include <QObject>
#include <QDateTime>

class AspectPrivate;
class Project;
class QUndoStack;
class QString;
class QDateTime;
class QUndoCommand;
class QIcon;
class QMenu;
namespace future{
class Folder;
}
class XmlStreamReader;
#ifdef Q_OS_MAC32
// A hack in Qt 4.4 and later forces us to include QXmlStream* headers on MacOS instead of simple
// forward declarations. See
// http://lists.trolltech.com/qt-interest/2008-07/thread00798-0.html
#include <QXmlStreamWriter>
#else
class QXmlStreamWriter;
#endif
class QAction;


class AbstractAspect : public QObject
{
    Q_OBJECT

    public:
        class Private;
        friend class Private;

        AbstractAspect(const QString &name);
        virtual ~AbstractAspect();

        AbstractAspect * parentAspect() const;

        future::Folder * folder();

        bool isDescendantOf(AbstractAspect *other);

        void addChild(AbstractAspect* child);
        void insertChild(AbstractAspect *child, int index);

        void removeChild(AbstractAspect* child, bool detach=false);

        void removeChild(int index);
        AbstractAspect* child(int index) const;
        int childCount() const;
        int indexOfChild(const AbstractAspect * child) const;
        int index() const { return parentAspect() ? parentAspect()->indexOfChild(this) : 0; }
        void moveChild(int from, int to);
        void reparentChild(AbstractAspect *new_parent, AbstractAspect *child, int d_new_index);
        void reparentChild(AbstractAspect *new_parent, AbstractAspect *child);
        QList<AbstractAspect *> descendantsThatInherit(const char *class_name);
        virtual void removeAllChildAspects();

        virtual const Project *project() const { return parentAspect() ? parentAspect()->project() : 0; }
        virtual Project *project() { return parentAspect() ? parentAspect()->project() : 0; }
        virtual QString path() const { return parentAspect() ? parentAspect()->path() + "/" + name() : "";  }

        virtual QIcon icon() const;

        virtual QMenu *createContextMenu() const;

        QString name() const;
        QString comment() const;

        QString captionSpec() const;
        QDateTime creationTime() const;
        QString caption() const;




        virtual QUndoStack *undoStack() const { return parentAspect() ? parentAspect()->undoStack() : 0; }
        void exec(QUndoCommand *command);
        void beginMacro(const QString& text);
        void endMacro();

        static QVariant global(const QString &key);
        static void setGlobal(const QString &key, const QVariant &value);
        static void setGlobalDefault(const QString &key, const QVariant &value);



        virtual void save(QXmlStreamWriter *) const {};

        virtual bool load(XmlStreamReader *) { return false; };
    protected:

        bool readBasicAttributes(XmlStreamReader * reader);
        void writeBasicAttributes(QXmlStreamWriter * writer) const;
        void writeCommentElement(QXmlStreamWriter * writer) const;
        bool readCommentElement(XmlStreamReader * reader);

    public slots:
        void setName(const QString &value);
        void setComment(const QString &value);

        void setCaptionSpec(const QString &value);
        virtual void remove() { if(parentAspect()) parentAspect()->removeChild(parentAspect()->indexOfChild(this)); }
        QString uniqueNameFor(const QString &current_name) const;

    public:
        void importV0x0001XXCreationTime(const QString& str)
        {
            setCreationTime(QDateTime::fromString(str, Qt::LocalDate));
        }


    signals:
        void aspectDescriptionAboutToChange(const AbstractAspect *aspect);
        void aspectDescriptionChanged(const AbstractAspect *aspect);
        void aspectAboutToBeAdded(const AbstractAspect *parent, int index);
        void aspectAdded(const AbstractAspect *aspect);
        void aspectAdded(const AbstractAspect *parent, int index);
        void aspectAboutToBeRemoved(const AbstractAspect *aspect);
        void aspectAboutToBeRemoved(const AbstractAspect *parent, int index);
        void aspectRemoved(const AbstractAspect *parent, int index);
        void statusInfo(const QString &text);

    protected:

        void setCreationTime(const QDateTime& time);

        virtual void completeAspectInsertion(AbstractAspect * aspect, int index) { Q_UNUSED(aspect); Q_UNUSED(index); }

        virtual void prepareAspectRemoval(AbstractAspect * aspect) { Q_UNUSED(aspect); }

        void info(const QString &text) { emit statusInfo(text); }

    private:
        Private * d_aspect_private;
};

#endif // ifndef ABSTRACT_ASPECT_H