associationwidget.h

Go to the documentation of this file.

/*
    SPDX-License-Identifier: GPL-2.0-or-later
    SPDX-FileCopyrightText: 2002-2022 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
*/
 
#ifndef ASSOCIATIONWIDGET_H
#define ASSOCIATIONWIDGET_H
 
#include "associationline.h"
#include "associationwidgetlist.h"
#include "associationwidgetrole.h"
#include "linkwidget.h"
#include "messagewidgetlist.h"
#include "umlwidgetlist.h"
#include "widgetbase.h"
 
class ClassifierWidget;
class UMLScene;
class UMLAssociation;
class UMLAttribute;
class UMLClassifierListItem;
class UMLOperation;
 
class AssociationWidget : public WidgetBase, public LinkWidget
{
    Q_OBJECT
public:
    static AssociationWidget* create(UMLScene *scene);
    static AssociationWidget* create
                     (UMLScene *scene, UMLWidget* WidgetA,
                      Uml::AssociationType::Enum assocType, UMLWidget* WidgetB,
                      UMLObject *umlobject = 0);
 
    virtual ~AssociationWidget();
 
    virtual void setUMLObject(UMLObject *obj);
 
    //---------- LinkWidget Interface methods implementation from here on.
 
    virtual void lwSetFont(QFont font);
    virtual UMLClassifier *operationOwner();
 
    virtual UMLOperation *operation();
    virtual void setOperation(UMLOperation *op);
 
    virtual QString customOpText();
    virtual void setCustomOpText(const QString &opText);
 
    virtual void resetTextPositions();
 
    virtual void setMessageText(FloatingTextWidget *ft);
    virtual void setText(FloatingTextWidget *ft, const QString &newText);
 
    virtual bool showPropertiesDialog();
 
    virtual QString lwOperationText();
    virtual UMLClassifier *lwClassifier();
    virtual void setOperationText(const QString &op);
 
    virtual void constrainTextPos(qreal &textX, qreal &textY,
                                  qreal textWidth, qreal textHeight,
                                  Uml::TextRole::Enum tr);
 
    virtual void calculateNameTextSegment();
 
    //---------- End LinkWidget Interface methods implementation.
 
    UMLAssociation* association() const;
    UMLAttribute* attribute() const;
 
//    AssociationWidget& operator=(const AssociationWidget& other);
    bool operator==(const AssociationWidget& other) const;
    bool operator!=(AssociationWidget& other) const;
 
    FloatingTextWidget* textWidgetByRole(Uml::TextRole::Enum tr) const;
 
    FloatingTextWidget* nameWidget() const;
    QString name() const;
    void setName(const QString &strRole);
    void setStereotype(const QString &stereo);
 
    FloatingTextWidget* roleWidget(Uml::RoleType::Enum role) const;
    QString roleName(Uml::RoleType::Enum role) const;
    void setRoleName(const QString &strRole, Uml::RoleType::Enum role);
 
    QString roleDocumentation(Uml::RoleType::Enum role) const;
    void setRoleDocumentation(const QString& doc, Uml::RoleType::Enum role);
 
    FloatingTextWidget* multiplicityWidget(Uml::RoleType::Enum role) const;
    QString multiplicity(Uml::RoleType::Enum role) const;
    void setMultiplicity(const QString& text, Uml::RoleType::Enum role);
 
    Uml::Visibility::Enum visibility(Uml::RoleType::Enum role) const;
    void setVisibility(Uml::Visibility::Enum value, Uml::RoleType::Enum role);
 
    FloatingTextWidget* changeabilityWidget(Uml::RoleType::Enum role) const;
    Uml::Changeability::Enum changeability(Uml::RoleType::Enum role) const;
    void setChangeability(Uml::Changeability::Enum value, Uml::RoleType::Enum role);
 
    Uml::ID::Type widgetIDForRole(Uml::RoleType::Enum role) const;
    Uml::ID::Type widgetLocalIDForRole(Uml::RoleType::Enum role) const;
    UMLWidget* widgetForRole(Uml::RoleType::Enum role) const;
    void setWidgetForRole(UMLWidget* widget, Uml::RoleType::Enum role);
 
    bool containsAsEndpoint(UMLWidget* widget);
 
    Uml::AssociationType::Enum associationType() const;
    void setAssociationType(Uml::AssociationType::Enum type);
 
    bool isCollaboration() const;
    bool isSelf() const;
 
    QString toString() const;
 
    bool isActivated() const;
    void setActivated(bool active);
 
    const AssociationLine& associationLine() const;
    AssociationLine& associationLine();
 
    virtual bool activate(IDChangeLog *changeLog = 0);
    virtual QRectF boundingRect() const;
    virtual QPainterPath shape() const;
 
    void widgetMoved(UMLWidget* widget, qreal x, qreal y);
 
    void saveIdealTextPositions();
 
    UMLWidget* onWidget(const QPointF &p);
    bool onAssociation(const QPointF& point);
    bool onAssocClassLine(const QPointF& point);
 
    void createAssocClassLine();
    void createAssocClassLine(ClassifierWidget* classifierWidget,
                              int linePathSegmentIndex);
 
    void selectAssocClassLine(bool sel = true);
    void removeAssocClassLine();
    void computeAssocClassLine();
 
    void setXEntireAssoc(qreal x);
    void setYEntireAssoc(qreal y);
 
    void moveMidPointsBy(qreal x, qreal y);
    void moveEntireAssoc(qreal x, qreal y);
 
    QFont font() const;
 
    virtual void setTextColor(const QColor &color);
    virtual void setLineColor(const QColor &color);
    virtual void setLineWidth(uint width);
 
    void calculateEndingPoints();
 
    void clipSize();
 
    bool loadFromXMI(QDomElement& qElement, const UMLWidgetList& widgets,
                     const MessageWidgetList* messages);
    virtual bool loadFromXMI(QDomElement& qElement);
    virtual void saveToXMI(QXmlStreamWriter& writer);
 
    void cleanup();
 
    bool isPointAddable();
    bool isPointRemovable();
    bool isAutoLayouted();
    bool isLayoutChangeable();
 
    virtual void mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event);
    virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *event);
    virtual void mousePressEvent(QGraphicsSceneMouseEvent *event);
    virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent *event);
 
    virtual void setSelected(bool _select);
 
public Q_SLOTS:  //:TODO: all virtual?
    virtual void slotMenuSelection(QAction* action);
    void slotClassifierListItemRemoved(UMLClassifierListItem* obj);
    void slotAttributeChanged();
 
    void syncToModel();
 
protected:
    virtual void contextMenuEvent(QGraphicsSceneContextMenuEvent *event);
 
    virtual void hoverEnterEvent(QGraphicsSceneHoverEvent *event);
    virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent *event);
    virtual void hoverMoveEvent(QGraphicsSceneHoverEvent *event);
 
private:
    QPointF calculateTextPosition(Uml::TextRole::Enum role);
    void setTextPosition(Uml::TextRole::Enum role);
    void setTextPositionRelatively(Uml::TextRole::Enum role, const QPointF &oldPosition);
    void setFloatingText(Uml::TextRole::Enum role, const QString& text, FloatingTextWidget* &ft);
 
    AssociationWidget(UMLScene *scene);
 
    void setUMLAssociation(UMLAssociation * assoc);
 
    void mergeAssociationDataIntoUMLRepresentation();
 
    static Uml::Region::Enum findPointRegion(const QRectF& rect, const QPointF& pos);
    static bool findIntercept(const QRectF& rect, const QPointF& point, QPointF& result);
    static QLineF::IntersectType intersect(const QRectF &rect, const QLineF &line,
                                           QPointF* intersectionPoint);
 
    void moveEvent(QGraphicsSceneMouseEvent *me);
 
    Uml::TextRole::Enum calculateNameType(Uml::TextRole::Enum defaultRoleType);
 
    static QPointF swapXY(const QPointF &p);
 
    static QPointF midPoint(const QPointF& p0, const QPointF& p1);
 
    void createPointsSelfAssociation();
    void updatePointsSelfAssociation();
    void createPointsException();
    void updatePointsException();
 
    static bool setStartAndEndPoint(AssociationWidget *assocwidget, UMLWidget *pWidget);
 
    static void updateAssociations(UMLWidget *pWidget, AssociationWidgetList list);
 
    void setChangeWidget(const QString &strChangeWidget, Uml::RoleType::Enum role);
 
    bool checkAddPoint(const QPointF &scenePos);
    bool checkRemovePoint(const QPointF &scenePos);
    bool checkAutoLayoutSpline();
 
    bool linePathStartsAt(const UMLWidget* widget) const;
    bool linePathEndsAt  (const UMLWidget* widget) const;
 
    bool m_activated;   
 
    int                 m_unNameLineSegment;
 
    QPointF m_oldNamePoint;    
    QPointF m_oldMultiAPoint;  
    QPointF m_oldMultiBPoint;  
    QPointF m_oldChangeAPoint; 
    QPointF m_oldChangeBPoint; 
    QPointF m_oldRoleAPoint;   
    QPointF m_oldRoleBPoint;   
 
    int m_nLinePathSegmentIndex;               
    QGraphicsLineItem *m_pAssocClassLine;      
    QGraphicsRectItem *m_pAssocClassLineSel0;  
    QGraphicsRectItem *m_pAssocClassLineSel1;  
 
    AssociationLine   m_associationLine;     
    ClassifierWidget *m_associationClass;    
    Uml::AssociationType::Enum m_associationType;  
    AssociationWidgetRole  m_role[2];
    FloatingTextWidget* m_nameWidget;  
    QPointF m_eventScenePos;           
 
};
 
#endif