umbrello  2.35.3
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
associationwidget.h
Go to the documentation of this file.
1 /*
2  SPDX-License-Identifier: GPL-2.0-or-later
3  SPDX-FileCopyrightText: 2002-2022 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
4 */
5 
6 #ifndef ASSOCIATIONWIDGET_H
7 #define ASSOCIATIONWIDGET_H
8 
9 #include "associationline.h"
10 #include "associationwidgetlist.h"
11 #include "associationwidgetrole.h"
12 #include "linkwidget.h"
13 #include "messagewidgetlist.h"
14 #include "umlwidgetlist.h"
15 #include "widgetbase.h"
16 
17 class ClassifierWidget;
18 class UMLScene;
19 class UMLAssociation;
20 class UMLAttribute;
22 class UMLOperation;
23 
46 class AssociationWidget : public WidgetBase, public LinkWidget
47 {
48  Q_OBJECT
49 public:
50  static AssociationWidget* create(UMLScene *scene);
52  (UMLScene *scene, UMLWidget* WidgetA,
53  Uml::AssociationType::Enum assocType, UMLWidget* WidgetB,
54  UMLObject *umlobject = 0);
55 
56  virtual ~AssociationWidget();
57 
58  virtual void setUMLObject(UMLObject *obj);
59 
60  //---------- LinkWidget Interface methods implementation from here on.
61 
62  virtual void lwSetFont(QFont font);
63  virtual UMLClassifier *operationOwner();
64 
65  virtual UMLOperation *operation();
66  virtual void setOperation(UMLOperation *op);
67 
68  virtual QString customOpText();
69  virtual void setCustomOpText(const QString &opText);
70 
71  virtual void resetTextPositions();
72 
73  virtual void setMessageText(FloatingTextWidget *ft);
74  virtual void setText(FloatingTextWidget *ft, const QString &newText);
75 
76  virtual bool showPropertiesDialog();
77 
78  virtual QString lwOperationText();
79  virtual UMLClassifier *lwClassifier();
80  virtual void setOperationText(const QString &op);
81 
82  virtual void constrainTextPos(qreal &textX, qreal &textY,
83  qreal textWidth, qreal textHeight,
85 
86  virtual void calculateNameTextSegment();
87 
88  //---------- End LinkWidget Interface methods implementation.
89 
90  UMLAssociation* association() const;
91  UMLAttribute* attribute() const;
92 
93 // AssociationWidget& operator=(const AssociationWidget& other);
94  bool operator==(const AssociationWidget& other) const;
95  bool operator!=(AssociationWidget& other) const;
96 
98 
100  QString name() const;
101  void setName(const QString &strRole);
102  void setStereotype(const QString &stereo);
103 
105  QString roleName(Uml::RoleType::Enum role) const;
106  void setRoleName(const QString &strRole, Uml::RoleType::Enum role);
107 
108  QString roleDocumentation(Uml::RoleType::Enum role) const;
109  void setRoleDocumentation(const QString& doc, Uml::RoleType::Enum role);
110 
112  QString multiplicity(Uml::RoleType::Enum role) const;
113  void setMultiplicity(const QString& text, Uml::RoleType::Enum role);
114 
117 
121 
125  void setWidgetForRole(UMLWidget* widget, Uml::RoleType::Enum role);
126 
127  bool containsAsEndpoint(UMLWidget* widget);
128 
131 
132  bool isCollaboration() const;
133  bool isSelf() const;
134 
135  QString toString() const;
136 
137  bool isActivated() const;
138  void setActivated(bool active);
139 
140  const AssociationLine& associationLine() const;
142 
143  virtual bool activate(IDChangeLog *changeLog = 0);
144  virtual QRectF boundingRect() const;
145  virtual QPainterPath shape() const;
146 
147  void widgetMoved(UMLWidget* widget, qreal x, qreal y);
148 
149  void saveIdealTextPositions();
150 
151  UMLWidget* onWidget(const QPointF &p);
152  bool onAssociation(const QPointF& point);
153  bool onAssocClassLine(const QPointF& point);
154 
155  void createAssocClassLine();
156  void createAssocClassLine(ClassifierWidget* classifierWidget,
157  int linePathSegmentIndex);
158 
159  void selectAssocClassLine(bool sel = true);
160  void removeAssocClassLine();
161  void computeAssocClassLine();
162 
163  void setXEntireAssoc(qreal x);
164  void setYEntireAssoc(qreal y);
165 
166  void moveMidPointsBy(qreal x, qreal y);
167  void moveEntireAssoc(qreal x, qreal y);
168 
169  QFont font() const;
170 
171  virtual void setTextColor(const QColor &color);
172  virtual void setLineColor(const QColor &color);
173  virtual void setLineWidth(uint width);
174 
175  void calculateEndingPoints();
176 
177  void clipSize();
178 
179  bool loadFromXMI(QDomElement& qElement, const UMLWidgetList& widgets,
180  const MessageWidgetList* messages);
181  virtual bool loadFromXMI(QDomElement& qElement);
182  virtual void saveToXMI(QXmlStreamWriter& writer);
183 
184  void cleanup();
185 
186  bool isPointAddable();
187  bool isPointRemovable();
188  bool isAutoLayouted();
189  bool isLayoutChangeable();
190 
191  virtual void mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event);
192  virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *event);
193  virtual void mousePressEvent(QGraphicsSceneMouseEvent *event);
194  virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent *event);
195 
196  virtual void setSelected(bool _select);
197 
198 public Q_SLOTS: //:TODO: all virtual?
199  virtual void slotMenuSelection(QAction* action);
201  void slotAttributeChanged();
202 
203  void syncToModel();
204 
205 protected:
206  virtual void contextMenuEvent(QGraphicsSceneContextMenuEvent *event);
207 
208  virtual void hoverEnterEvent(QGraphicsSceneHoverEvent *event);
209  virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent *event);
210  virtual void hoverMoveEvent(QGraphicsSceneHoverEvent *event);
211 
212 private:
215  void setTextPositionRelatively(Uml::TextRole::Enum role, const QPointF &oldPosition);
216  void setFloatingText(Uml::TextRole::Enum role, const QString& text, FloatingTextWidget* &ft);
217 
218  AssociationWidget(UMLScene *scene);
219 
220  void setUMLAssociation(UMLAssociation * assoc);
221 
223 
224  static Uml::Region::Enum findPointRegion(const QRectF& rect, const QPointF& pos);
225  static bool findIntercept(const QRectF& rect, const QPointF& point, QPointF& result);
226  static QLineF::IntersectType intersect(const QRectF &rect, const QLineF &line,
227  QPointF* intersectionPoint);
228 
229  void moveEvent(QGraphicsSceneMouseEvent *me);
230 
232 
233  static QPointF swapXY(const QPointF &p);
234 
235  static QPointF midPoint(const QPointF& p0, const QPointF& p1);
236 
239  void createPointsException();
240  void updatePointsException();
241 
242  static bool setStartAndEndPoint(AssociationWidget *assocwidget, UMLWidget *pWidget);
243 
244  static void updateAssociations(UMLWidget *pWidget, AssociationWidgetList list);
245 
246  void setChangeWidget(const QString &strChangeWidget, Uml::RoleType::Enum role);
247 
248  bool checkAddPoint(const QPointF &scenePos);
249  bool checkRemovePoint(const QPointF &scenePos);
250  bool checkAutoLayoutSpline();
251 
252  bool linePathStartsAt(const UMLWidget* widget) const;
253  bool linePathEndsAt (const UMLWidget* widget) const;
254 
255  bool m_activated;
256 
265 
266  QPointF m_oldNamePoint;
271  QPointF m_oldRoleAPoint;
272  QPointF m_oldRoleBPoint;
273 
275  QGraphicsLineItem *m_pAssocClassLine;
276  QGraphicsRectItem *m_pAssocClassLineSel0;
277  QGraphicsRectItem *m_pAssocClassLineSel1;
278 
284  QPointF m_eventScenePos;
285 
286 };
287 
288 #endif
QList< QPointer< AssociationWidget > > AssociationWidgetList
Definition: associationwidgetlist.h:15
Definition: associationline.h:101
Definition: associationwidgetrole.h:27
This class represents an association inside a diagram. Bugs and comments to umbrello-devel@kde....
Definition: associationwidget.h:47
Uml::ID::Type widgetLocalIDForRole(Uml::RoleType::Enum role) const
Definition: associationwidget.cpp:1505
QPointF m_oldChangeAPoint
Position of role A changeability floatingtext saved by saveIdealTextPositions()
Definition: associationwidget.h:269
void setXEntireAssoc(qreal x)
Definition: associationwidget.cpp:3281
virtual QRectF boundingRect() const
Definition: associationwidget.cpp:3340
QPointF calculateTextPosition(Uml::TextRole::Enum role)
Definition: associationwidget.cpp:2140
void syncToModel()
Definition: associationwidget.cpp:1734
virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent *event)
Definition: associationwidget.cpp:3436
void setWidgetForRole(UMLWidget *widget, Uml::RoleType::Enum role)
Definition: associationwidget.cpp:798
void cleanup()
Definition: associationwidget.cpp:1281
void createPointsSelfAssociation()
Definition: associationwidget.cpp:1913
virtual void slotMenuSelection(QAction *action)
Definition: associationwidget.cpp:2604
void setTextPosition(Uml::TextRole::Enum role)
Definition: associationwidget.cpp:2396
void setActivated(bool active)
Definition: associationwidget.cpp:1726
virtual void setOperationText(const QString &op)
Definition: associationwidget.cpp:458
void slotAttributeChanged()
Definition: associationwidget.cpp:3374
void moveEntireAssoc(qreal x, qreal y)
Definition: associationwidget.cpp:3321
virtual void setLineColor(const QColor &color)
Definition: associationwidget.cpp:2840
void moveMidPointsBy(qreal x, qreal y)
Definition: associationwidget.cpp:3305
virtual void setOperation(UMLOperation *op)
Definition: associationwidget.cpp:305
void setYEntireAssoc(qreal y)
Definition: associationwidget.cpp:3293
QPointF m_eventScenePos
holds scene pos of contextMenuEvent()
Definition: associationwidget.h:284
bool isCollaboration() const
Definition: associationwidget.cpp:1415
static bool setStartAndEndPoint(AssociationWidget *assocwidget, UMLWidget *pWidget)
Definition: associationwidget.cpp:3008
void mergeAssociationDataIntoUMLRepresentation()
Definition: associationwidget.cpp:1768
FloatingTextWidget * m_nameWidget
displays the name of this association
Definition: associationwidget.h:283
static AssociationWidget * create(UMLScene *scene)
Definition: associationwidget.cpp:105
AssociationWidgetRole m_role[2]
Definition: associationwidget.h:282
bool isAutoLayouted()
Definition: associationwidget.cpp:1344
Uml::Visibility::Enum visibility(Uml::RoleType::Enum role) const
Definition: associationwidget.cpp:1088
void setMultiplicity(const QString &text, Uml::RoleType::Enum role)
Definition: associationwidget.cpp:1075
bool checkAddPoint(const QPointF &scenePos)
Definition: associationwidget.cpp:2862
QString name() const
Definition: associationwidget.cpp:880
virtual UMLOperation * operation()
Definition: associationwidget.cpp:296
void computeAssocClassLine()
Definition: associationwidget.cpp:2517
QPointF m_oldRoleAPoint
Position of role A name floatingtext saved by saveIdealTextPositions()
Definition: associationwidget.h:271
bool linePathStartsAt(const UMLWidget *widget) const
Definition: associationwidget.cpp:1196
bool isPointAddable()
Return state if the association line point in the vicinity of the last context menu event position is...
Definition: associationwidget.cpp:1321
virtual QString customOpText()
Definition: associationwidget.cpp:320
virtual bool showPropertiesDialog()
Definition: associationwidget.cpp:417
UMLWidget * onWidget(const QPointF &p)
Definition: associationwidget.cpp:3207
FloatingTextWidget * changeabilityWidget(Uml::RoleType::Enum role) const
Definition: associationwidget.cpp:841
void createPointsException()
Definition: associationwidget.cpp:1967
void createAssocClassLine()
Definition: associationwidget.cpp:2472
virtual void setSelected(bool _select)
Definition: associationwidget.cpp:3170
virtual void constrainTextPos(qreal &textX, qreal &textY, qreal textWidth, qreal textHeight, Uml::TextRole::Enum tr)
Definition: associationwidget.cpp:2250
void updatePointsSelfAssociation()
Definition: associationwidget.cpp:1940
UMLAssociation * association() const
Definition: associationwidget.cpp:518
QPointF m_oldMultiBPoint
Position of role B multiplicity floatingtext saved by saveIdealTextPositions()
Definition: associationwidget.h:268
UMLAttribute * attribute() const
Definition: associationwidget.cpp:531
virtual void resetTextPositions()
Definition: associationwidget.cpp:338
void calculateEndingPoints()
Definition: associationwidget.cpp:1648
QGraphicsLineItem * m_pAssocClassLine
used for connecting assoc. class
Definition: associationwidget.h:275
QFont font() const
Definition: associationwidget.cpp:2788
FloatingTextWidget * nameWidget() const
Definition: associationwidget.cpp:823
QString roleName(Uml::RoleType::Enum role) const
Definition: associationwidget.cpp:955
bool isPointRemovable()
Return state if the association line point in the vicinity of the last context menu event position is...
Definition: associationwidget.cpp:1336
void setUMLAssociation(UMLAssociation *assoc)
Definition: associationwidget.cpp:1366
void setAssociationType(Uml::AssociationType::Enum type)
Definition: associationwidget.cpp:1449
QGraphicsRectItem * m_pAssocClassLineSel0
selection decoration for the start point of the assoc. class line
Definition: associationwidget.h:276
void clipSize()
Definition: associationwidget.cpp:3385
bool m_activated
flag which is true if the activate method has been called for this class instance
Definition: associationwidget.h:255
virtual void mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event)
Definition: associationwidget.cpp:1556
bool linePathEndsAt(const UMLWidget *widget) const
Definition: associationwidget.cpp:1229
Uml::AssociationType::Enum m_associationType
is only used if m_pObject is not set
Definition: associationwidget.h:281
static Uml::Region::Enum findPointRegion(const QRectF &rect, const QPointF &pos)
Definition: associationwidget.cpp:2072
virtual void setMessageText(FloatingTextWidget *ft)
Definition: associationwidget.cpp:369
static QPointF swapXY(const QPointF &p)
Definition: associationwidget.cpp:2129
QString roleDocumentation(Uml::RoleType::Enum role) const
Definition: associationwidget.cpp:1008
static QLineF::IntersectType intersect(const QRectF &rect, const QLineF &line, QPointF *intersectionPoint)
Definition: associationwidget.cpp:2991
UMLWidget * widgetForRole(Uml::RoleType::Enum role) const
Definition: associationwidget.cpp:1273
const AssociationLine & associationLine() const
Definition: associationwidget.cpp:656
void setRoleName(const QString &strRole, Uml::RoleType::Enum role)
Definition: associationwidget.cpp:968
bool containsAsEndpoint(UMLWidget *widget)
Definition: associationwidget.cpp:1407
void setTextPositionRelatively(Uml::TextRole::Enum role, const QPointF &oldPosition)
Definition: associationwidget.cpp:2420
bool operator!=(AssociationWidget &other) const
Definition: associationwidget.cpp:648
void setRoleDocumentation(const QString &doc, Uml::RoleType::Enum role)
Definition: associationwidget.cpp:997
bool checkAutoLayoutSpline()
Definition: associationwidget.cpp:2944
bool onAssociation(const QPointF &point)
Definition: associationwidget.cpp:3257
virtual void mousePressEvent(QGraphicsSceneMouseEvent *event)
Definition: associationwidget.cpp:2566
virtual UMLClassifier * operationOwner()
Definition: associationwidget.cpp:277
virtual void setText(FloatingTextWidget *ft, const QString &newText)
Definition: associationwidget.cpp:388
QString toString() const
Definition: associationwidget.cpp:1523
static QPointF midPoint(const QPointF &p0, const QPointF &p1)
Definition: associationwidget.cpp:2226
virtual void lwSetFont(QFont font)
Definition: associationwidget.cpp:263
FloatingTextWidget * multiplicityWidget(Uml::RoleType::Enum role) const
Definition: associationwidget.cpp:813
bool loadFromXMI(QDomElement &qElement, const UMLWidgetList &widgets, const MessageWidgetList *messages)
Definition: associationwidget.cpp:3509
bool onAssocClassLine(const QPointF &point)
Definition: associationwidget.cpp:3229
void removeAssocClassLine()
Definition: associationwidget.cpp:2455
Uml::AssociationType::Enum associationType() const
Definition: associationwidget.cpp:1436
virtual UMLClassifier * lwClassifier()
Definition: associationwidget.cpp:445
void saveIdealTextPositions()
Definition: associationwidget.cpp:1821
virtual void hoverEnterEvent(QGraphicsSceneHoverEvent *event)
Definition: associationwidget.cpp:3428
void selectAssocClassLine(bool sel=true)
Definition: associationwidget.cpp:2555
void setStereotype(const QString &stereo)
Definition: associationwidget.cpp:927
bool operator==(const AssociationWidget &other) const
Definition: associationwidget.cpp:599
virtual void setLineWidth(uint width)
Definition: associationwidget.cpp:2851
QPointF m_oldChangeBPoint
Position of role B changeability floatingtext saved by saveIdealTextPositions()
Definition: associationwidget.h:270
AssociationWidget(UMLScene *scene)
Definition: associationwidget.cpp:75
void setVisibility(Uml::Visibility::Enum value, Uml::RoleType::Enum role)
Definition: associationwidget.cpp:1102
bool isActivated() const
Definition: associationwidget.cpp:1718
static void updateAssociations(UMLWidget *pWidget, AssociationWidgetList list)
Definition: associationwidget.cpp:3113
void slotClassifierListItemRemoved(UMLClassifierListItem *obj)
Definition: associationwidget.cpp:3360
virtual void setUMLObject(UMLObject *obj)
Definition: associationwidget.cpp:218
QPointF m_oldNamePoint
Position of name floatingtext saved by saveIdealTextPositions()
Definition: associationwidget.h:266
AssociationLine m_associationLine
the definition points for the association line
Definition: associationwidget.h:279
FloatingTextWidget * roleWidget(Uml::RoleType::Enum role) const
Definition: associationwidget.cpp:833
Uml::Changeability::Enum changeability(Uml::RoleType::Enum role) const
Definition: associationwidget.cpp:1131
virtual void saveToXMI(QXmlStreamWriter &writer)
Definition: associationwidget.cpp:3452
void setName(const QString &strRole)
Definition: associationwidget.cpp:891
int m_unNameLineSegment
Definition: associationwidget.h:264
bool isLayoutChangeable()
Definition: associationwidget.cpp:1358
ClassifierWidget * m_associationClass
used if we have an assoc. class
Definition: associationwidget.h:280
virtual QPainterPath shape() const
Definition: associationwidget.cpp:3348
void setChangeWidget(const QString &strChangeWidget, Uml::RoleType::Enum role)
Definition: associationwidget.cpp:1158
virtual void calculateNameTextSegment()
Definition: associationwidget.cpp:478
static bool findIntercept(const QRectF &rect, const QPointF &point, QPointF &result)
Definition: associationwidget.cpp:3131
void setFloatingText(Uml::TextRole::Enum role, const QString &text, FloatingTextWidget *&ft)
Definition: associationwidget.cpp:1029
virtual void hoverMoveEvent(QGraphicsSceneHoverEvent *event)
Definition: associationwidget.cpp:3444
void moveEvent(QGraphicsSceneMouseEvent *me)
Definition: associationwidget.cpp:1568
void widgetMoved(UMLWidget *widget, qreal x, qreal y)
Definition: associationwidget.cpp:1835
virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent *event)
Definition: associationwidget.cpp:2596
bool isSelf() const
Definition: associationwidget.cpp:1426
Uml::ID::Type widgetIDForRole(Uml::RoleType::Enum role) const
Definition: associationwidget.cpp:1485
int m_nLinePathSegmentIndex
anchor for m_pAssocClassLine
Definition: associationwidget.h:274
QGraphicsRectItem * m_pAssocClassLineSel1
selection decoration for the end point of the assoc. class line
Definition: associationwidget.h:277
FloatingTextWidget * textWidgetByRole(Uml::TextRole::Enum tr) const
Definition: associationwidget.cpp:851
QPointF m_oldRoleBPoint
Position of role B name floatingtext saved by saveIdealTextPositions()
Definition: associationwidget.h:272
virtual QString lwOperationText()
Definition: associationwidget.cpp:434
bool checkRemovePoint(const QPointF &scenePos)
Definition: associationwidget.cpp:2911
void setChangeability(Uml::Changeability::Enum value, Uml::RoleType::Enum role)
Definition: associationwidget.cpp:1142
QPointF m_oldMultiAPoint
Position of role A multiplicity floatingtext saved by saveIdealTextPositions()
Definition: associationwidget.h:267
QString multiplicity(Uml::RoleType::Enum role) const
Definition: associationwidget.cpp:1064
Uml::TextRole::Enum calculateNameType(Uml::TextRole::Enum defaultRoleType)
Definition: associationwidget.cpp:1248
virtual void contextMenuEvent(QGraphicsSceneContextMenuEvent *event)
Definition: associationwidget.cpp:3400
virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *event)
Definition: associationwidget.cpp:2953
virtual ~AssociationWidget()
Definition: associationwidget.cpp:206
virtual void setTextColor(const QColor &color)
Definition: associationwidget.cpp:2816
void updatePointsException()
Definition: associationwidget.cpp:1991
virtual void setCustomOpText(const QString &opText)
Definition: associationwidget.cpp:329
virtual bool activate(IDChangeLog *changeLog=0)
Definition: associationwidget.cpp:674
Common implementation for class widget and interface widget.
Definition: classifierwidget.h:28
Displays a line of text or an operation.
Definition: floatingtextwidget.h:32
Definition: idchangelog.h:22
Interface to FloatingTextWidget for AssociationWidget and MessageWidget.
Definition: linkwidget.h:32
Sets up association information.
Definition: association.h:29
Sets up attribute information.
Definition: attribute.h:23
A base class for classifier list items (e.g. attributes)
Definition: classifierlistitem.h:25
Information for a non-graphical Concept/Class.
Definition: classifier.h:35
The base class for UML objects.
Definition: umlobject.h:70
Definition: operation.h:20
Definition: umlscene.h:65
The base class for graphical UML objects.
Definition: umlwidget.h:36
Common base class for UMLWidget and AssociationWidget.
Definition: widgetbase.h:101
QRectF rect() const
Definition: widgetbase.cpp:844
QList< QPointer< MessageWidget > > MessageWidgetList
Definition: messagewidgetlist.h:13
QString newText(UMLObject::ObjectType type)
Definition: model_utils.cpp:648
Enum
Definition: basictypes.h:92
Enum
Definition: basictypes.h:202
std::string Type
Definition: basictypes.h:371
Enum
Definition: basictypes.h:330
Enum
Definition: basictypes.h:236
Enum
Definition: basictypes.h:176
Enum
Definition: basictypes.h:45
QList< QPointer< UMLWidget > > UMLWidgetList
Definition: umlwidgetlist.h:13