terminal.h

Go to the documentation of this file.

/*
    Copyright 2006-2019 The QElectroTech Team
    This file is part of QElectroTech.
    
    QElectroTech 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.
    
    QElectroTech 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 QElectroTech.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef TERMINAL_H
#define TERMINAL_H
#include <QtWidgets>
#include <QtXml>
#include "qet.h"
class Conductor;
class Diagram;
class Element;
class Terminal : public QGraphicsObject
{
        Q_OBJECT

    signals:
        void conductorWasAdded(Conductor *conductor);
        void conductorWasRemoved(Conductor *conductor);
    
        // constructors, destructor
    public:
        Terminal(QPointF,      Qet::Orientation, Element * = nullptr);
        Terminal(qreal, qreal, Qet::Orientation, Element * = nullptr);
        Terminal(QPointF,      Qet::Orientation, QString number, QString name, bool hiddenName, Element * = nullptr);
        ~Terminal() override;
    
    private:
        Terminal(const Terminal &);
    
        // methods
    public:
            //Enable the use of qgraphicsitem_cast to safely cast a QGraphicsItem into a Terminal
            //@return the QGraphicsItem type
        int type() const override { return Type; }
    
        void   paint        (QPainter *, const QStyleOptionGraphicsItem *, QWidget *) override;
        void   drawHelpLine (bool draw = true);
        QLineF HelpLine     () const;
        QRectF boundingRect () const override;
    
            // methods to manage conductors attached to the terminal
        Terminal* alignedWithTerminal () const;
        bool      addConductor        (Conductor *conductor);
        void      removeConductor     (Conductor *conductor);
        int       conductorsCount     () const;
        Diagram  *diagram             () const;
        Element  *parentElement       () const;
    
    QList<Conductor *> conductors() const;
    Qet::Orientation orientation() const;
    QPointF dockConductor() const;
    QString number() const;
    QString name() const;
    void setNumber(QString number);
    void setName(QString name, bool hiddenName);
    void updateConductor();
    bool isLinkedTo(Terminal *);
    bool canBeLinkedTo(Terminal *);
    
    // methods related to XML import/export
    static bool valideXml(QDomElement  &);
    bool fromXml (QDomElement &);
    QDomElement toXml (QDomDocument &) const;
    
    protected:
    // methods related to events management
    void hoverEnterEvent  (QGraphicsSceneHoverEvent *) override;
    void hoverMoveEvent   (QGraphicsSceneHoverEvent *) override;
    void hoverLeaveEvent  (QGraphicsSceneHoverEvent *) override;
    void mousePressEvent  (QGraphicsSceneMouseEvent *) override;
    void mouseMoveEvent   (QGraphicsSceneMouseEvent *) override;
    void mouseReleaseEvent(QGraphicsSceneMouseEvent *) override;
    
        // attributes
    public:
        enum { Type = UserType + 1002 };

        static const qreal terminalSize;
        static const qreal Z;
            // Various static colors used for hover effects
        static QColor neutralColor;
        static QColor allowedColor;
        static QColor warningColor;
        static QColor forbiddenColor;
    
    private:
        bool               m_draw_help_line;
        QGraphicsLineItem *m_help_line;
        QGraphicsLineItem *m_help_line_a;

    Element *parent_element_;
    QPointF dock_conductor_;
    QPointF dock_elmt_;
    Qet::Orientation ori_;
    QList<Conductor *> conductors_;
    QRectF *br_;
    Terminal *previous_terminal_;
    bool hovered_;
    QColor hovered_color_;
    QString number_terminal_;
    QString name_terminal_;
    bool name_terminal_hidden;
    
    private:
    void init(QPointF, Qet::Orientation, QString number, QString name, bool hiddenName);
};

inline int Terminal::conductorsCount() const {
    return(conductors_.size());
}

inline QPointF Terminal::dockConductor() const {
    return(mapToScene(dock_conductor_));
}

inline QString Terminal::number() const {
    return(number_terminal_);
}

inline QString Terminal::name() const {
    return(name_terminal_);
}

QList<Terminal *> relatedPotentialTerminal (const Terminal *terminal, const bool all_diagram = true);

#endif