Pointer.h

Go to the documentation of this file.

/*
    This file is part of Rocs.
    Copyright 2004-2011  Tomaz Canabrava <tomaz.canabrava@gmail.com>
    Copyright 2010-2011  Wagner Reck <wagner.reck@gmail.com>
    Copyright 2012       Andreas Cord-Landwehr <cola@uni-paderborn.de>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library 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
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef POINTER_H
#define POINTER_H

#include "PointerType.h"
#include <QObject>
#include <QtScript>
#include <QString>
#include <QColor>
#include <QScriptValue>

#include "RocsCoreExport.h"
#include "CoreTypes.h"

class Data;
class PointerPrivate;
class DataStructure;
class QtScriptBackend;


class ROCSLIB_EXPORT Pointer : public QObject
{
    Q_OBJECT

    Q_PROPERTY(QScriptValue from READ start)
    Q_PROPERTY(QScriptValue to READ end)
    Q_PROPERTY(bool directed READ isDirected)
    Q_PROPERTY(QColor color READ color WRITE setColor)
    Q_PROPERTY(qreal width READ width WRITE setWidth)
    Q_PROPERTY(int type READ pointerType)

public:
    static PointerPtr create(DataStructurePtr dataStructure, DataPtr from, DataPtr to, int pointerType);

    PointerPtr getPointer() const;

    virtual ~Pointer();

    PointerType::Direction direction() const;

    bool isDirected() const;

    DataStructurePtr dataStructure() const;

    int relativeIndex() const;

    QScriptValue scriptValue() const;

    void setEngine(QScriptEngine *engine);

    DataPtr from() const;

    DataPtr to() const;

    Q_INVOKABLE QScriptValue start() const;

    Q_INVOKABLE QScriptValue end() const;

    bool isVisible() const;

    QColor color() const;

    qreal width() const;

    int pointerType() const;

    Q_INVOKABLE void remove();

    Q_INVOKABLE void self_remove();

    Q_INVOKABLE QScriptValue set_type(int type);

    Q_INVOKABLE void add_property(const QString& name, const QString& value);

    Q_INVOKABLE void remove_property(const QString& name);

Q_SIGNALS:
    void removed();

    void changed();

    void posChanged();

    void pointerTypeChanged(int pointerType);

    void directionChanged(PointerType::Direction direction);

    void propertyAdded(const QString &name);
    void propertyRemoved(const QString &name);
    void propertyChanged(const QString &name);

public Q_SLOTS:
    void setPointerType(int pointerType);

    void setColor(const QColor &color);

    void setWidth(qreal width);

    Qt::PenStyle style() const;

    void addDynamicProperty(const QString& property, const QVariant& value);

    void removeDynamicProperty(const QString& property);

    void updateDynamicProperty(const QString& property);

    void renameDynamicProperty(const QString& oldName, const QString& newName);

    void updateRelativeIndex();

    QList<QString> properties() const;

    void setVisible(bool visible);

    QScriptValue type() const;

protected:
    Pointer(DataStructurePtr parent, DataPtr from, DataPtr to, int pointerType);

    template<typename T>
    static PointerPtr create(DataStructurePtr parent, DataPtr from, DataPtr to, int pointerType) {
        PointerPtr pi(new T(parent, from, to, pointerType));
        pi->setQpointer(pi);
        pi->initialize();
        return pi;
    }

    bool eventFilter(QObject *obj, QEvent *event);

private:
    const QScopedPointer<PointerPrivate> d;

    void setQpointer(PointerPtr q);

    void initialize();
    Pointer(const Pointer&);
    Pointer& operator=(const Pointer&);
};

#endif