umlwidget.h

Go to the documentation of this file.

/*
    SPDX-License-Identifier: GPL-2.0-or-later
    SPDX-FileCopyrightText: 2002-2021 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
*/
 
#ifndef UMLWIDGET_H
#define UMLWIDGET_H
 
#include "associationwidgetlist.h"
#include "basictypes.h"
#include "optionstate.h"
#include "umlobject.h"
#include "umlwidgetlist.h"
#include "widgetbase.h"
#include "diagramproxywidget.h"
 
#include <QCursor>
#include <QFont>
 
class IDChangeLog;
class UMLDoc;
class UMLObject;
class UMLScene;
 
class QPainter;
class QFontMetrics;
 
class UMLWidget : public WidgetBase, public DiagramProxyWidget
{
    Q_OBJECT
public:
 
    friend class ToolBarStateArrow;  // for calling the mouse*Event handlers
 
    static const QSizeF DefaultMinimumSize;
    static const QSizeF DefaultMaximumSize;
    static const int defaultMargin;
    static const int selectionMarkerSize;
    static const int resizeMarkerLineCount;
 
    explicit UMLWidget(UMLScene *scene, WidgetType type = wt_UMLWidget, UMLObject *o = 0);
    explicit UMLWidget(UMLScene *scene, WidgetType type = wt_UMLWidget, Uml::ID::Type id = Uml::ID::None);
    virtual ~UMLWidget();
 
    // Copy constructor - not implemented.
    // UMLWidget(const UMLWidget& other);
 
    UMLWidget& operator=(const UMLWidget& other);
 
    bool operator==(const UMLWidget& other) const;
 
    virtual QSizeF minimumSize() const;
    void setMinimumSize(const QSizeF &size);
 
    virtual QSizeF maximumSize();
    void setMaximumSize(const QSizeF &size);
 
    virtual void setUseFillColor(bool fc);
    void setUseFillColorCmd(bool fc);
 
    virtual void setTextColor(const QColor &color);
    void setTextColorCmd(const QColor &color);
 
    virtual void setLineColor(const QColor &color);
    virtual void setLineColorCmd(const QColor &color);
 
    virtual void setLineWidth(uint width);
    void setLineWidthCmd(uint width);
 
    virtual void setFillColor(const QColor &color);
    void setFillColorCmd(const QColor &color);
 
    void setSelectedFlag(bool _select);
    virtual void setSelected(bool _select);
 
    void setScene(UMLScene *scene);
 
    virtual bool activate(IDChangeLog* changeLog = 0);
 
    void setPenFromSettings(QPainter &p);
    void setPenFromSettings(QPainter *p);
 
    virtual void setFont(const QFont &font);
    void setFontCmd(const QFont &font);
 
    bool getStartMove() const {
        return m_startMove;
    }
 
    virtual qreal getX() const;
    virtual qreal getY() const;
    virtual QPointF getPos() const;
    virtual void setX(qreal x);
    virtual void setY(qreal y);
 
    qreal height() const {
        return rect().height();
    }
 
    qreal width() const {
        return rect().width();
    }
 
    void setSize(qreal width, qreal height);
    void setSize(const QSizeF& size);
 
    virtual void resizeWidget(qreal newW, qreal newH);
    virtual void notifyParentResize();
 
    bool getIgnoreSnapToGrid() const;
    void setIgnoreSnapToGrid(bool to);
 
    virtual bool isLocatedIn(const UMLWidget *other) const;
 
    void moveByLocal(qreal dx, qreal dy);
 
    virtual void removeAssoc(AssociationWidget* pAssoc);
    virtual void addAssoc(AssociationWidget* pAssoc);
 
    AssociationWidgetList &associationWidgetList() const;
 
    bool isInstance() const {
        return m_isInstance;
    }
 
    void setIsInstance(bool isInstance) {
        m_isInstance = isInstance;
    }
 
    void setInstanceName(const QString &instanceName) {
        m_instanceName = instanceName;
    }
 
    QString instanceName() const {
        return m_instanceName;
    }
 
    Uml::ShowStereoType::Enum showStereotype() const;
    virtual void setShowStereotype(Uml::ShowStereoType::Enum flag);
    QString tags() const;
 
    virtual bool showPropertiesDialog();
 
    virtual void adjustAssocs(qreal dx, qreal dy);
    virtual void adjustUnselectedAssocs(qreal dx, qreal dy);
 
    bool isActivated() const;
    void setActivated(bool active = true);
 
    virtual void cleanup();
 
    void updateGeometry(bool withAssocs = true);
 
    void clipSize();
 
    void forceUpdateFontMetrics(QPainter *painter);
    void forceUpdateFontMetrics(QFont &font, QPainter *painter);
 
    virtual bool loadFromXMI(QDomElement &qElement);
    virtual void saveToXMI(QXmlStreamWriter& writer);
 
    QPointF startMovePosition() const;
    void setStartMovePosition(const QPointF &position);
 
    QSizeF startResizeSize() const;
 
    virtual QSizeF calculateSize(bool withExtensions = true) const;
    void resize();
 
    bool fixedAspectRatio() const {
        return m_fixedAspectRatio;
    }
 
    void setFixedAspectRatio(bool state) {
        m_fixedAspectRatio = state;
    }
 
    bool resizable() const {
        return m_resizable;
    }
 
    void setResizable(bool state) {
        m_resizable = state;
    }
 
    typedef enum {
        FT_NORMAL = 0,
        FT_BOLD  = 1,
        FT_ITALIC = 2,
        FT_UNDERLINE = 3,
        FT_BOLD_ITALIC = 4,
        FT_BOLD_UNDERLINE = 5,
        FT_ITALIC_UNDERLINE = 6,
        FT_BOLD_ITALIC_UNDERLINE = 7,
        FT_INVALID = 8
    } FontType;
 
    virtual void setDefaultFontMetrics(QFont &font, UMLWidget::FontType fontType);
    virtual void setDefaultFontMetrics(QFont &font, UMLWidget::FontType fontType, QPainter &painter);
 
    QFontMetrics &getFontMetrics(UMLWidget::FontType fontType) const;
    void setFontMetrics(UMLWidget::FontType fontType, QFontMetrics fm);
    void setupFontType(QFont &font, UMLWidget::FontType fontType);
 
    virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
 
public Q_SLOTS:
    virtual void updateWidget();
    virtual void slotMenuSelection(QAction* action);
    virtual void slotWidgetMoved(Uml::ID::Type id);
    virtual void slotFillColorChanged(Uml::ID::Type viewID);
    virtual void slotLineColorChanged(Uml::ID::Type viewID);
    virtual void slotTextColorChanged(Uml::ID::Type viewID);
    virtual void slotLineWidthChanged(Uml::ID::Type viewID);
 
    void slotSnapToGrid();
 
signals:
    void sigWidgetMoved(Uml::ID::Type id);
 
protected:
    virtual void contextMenuEvent(QGraphicsSceneContextMenuEvent* event);
    virtual void mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event);
    virtual void mousePressEvent(QGraphicsSceneMouseEvent *event);
    virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *event);
    virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent *event);
 
    virtual void moveEvent(QGraphicsSceneMouseEvent *event);
    virtual void moveWidgetBy(qreal diffX, qreal diffY);
    virtual void constrainMovementForAllWidgets(qreal &diffX, qreal &diffY);
    virtual void constrain(qreal& width, qreal& height);
 
    virtual bool isInResizeArea(QGraphicsSceneMouseEvent *me);
    virtual QCursor resizeCursor() const;
 
    void selectSingle(QGraphicsSceneMouseEvent *me);
    void selectMultiple(QGraphicsSceneMouseEvent *me);
    void deselect(QGraphicsSceneMouseEvent *me);
    // void resetSelection();
 
    void setSelectionBounds();
 
    void resize(QGraphicsSceneMouseEvent *me);
 
    bool wasSizeChanged();
    bool wasPositionChanged();
 
    virtual void toForeground();
 
public:
    enum AddWidgetOption { NoOption = 0, SetupSize = 1, SwitchDirection = 2, ShowProperties = 4, Default = SetupSize | ShowProperties };
    Q_DECLARE_FLAGS(AddWidgetOptions, AddWidgetOption)
 
protected:
    void addConnectedWidget(UMLWidget *widget, Uml::AssociationType::Enum type = Uml::AssociationType::Association, AddWidgetOptions options = Default);
    void addConnectedUMLObject(UMLObject::ObjectType otype, Uml::AssociationType::Enum type);
    void addWidget(UMLWidget *widget, bool showProperties = true);
 
 
    QString m_instanceName;  
    bool m_isInstance;       
    Uml::ShowStereoType::Enum m_showStereotype;   
 
 
    bool           m_startMove;
    QPointF        m_startMovePostion;
    QSizeF         m_startResizeSize;
    int            m_nPosX;
    UMLDoc        *m_doc;  
    bool           m_resizable;
    QFontMetrics  *m_pFontMetrics[FT_INVALID];
    QSizeF         m_minimumSize;
    QSizeF         m_maximumSize;
 
    bool m_activated;
 
    bool m_ignoreSnapToGrid;
    bool m_ignoreSnapComponentSizeToGrid;
    bool m_fixedAspectRatio;
 
    QString m_oldStatusBarMsg;
 
    QPointF m_pressOffset;
 
    QPointF m_oldPos;
 
    qreal m_oldW, m_oldH;
 
    bool m_shiftPressed;
 
    bool m_inMoveArea, m_inResizeArea;
 
    bool m_moved, m_resized;
 
private:
    void init();
 
    mutable AssociationWidgetList m_Assocs;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(UMLWidget::AddWidgetOptions)
#endif