umbrello API Documentation
	Overview Class Hierarchy Classes Classes (annotated) Members Namespaces Source Files

umlview.h

/***************************************************************************
 *                                                                         *
 *   This program 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.                                   *
 *                                                                         *
 *   copyright (C) 2002-2007                                               *
 *   Umbrello UML Modeller Authors <uml-devel@uml.sf.net>                  *
 ***************************************************************************/

#ifndef UMLVIEW_H
#define UMLVIEW_H

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

// system includes
#include <kurl.h>
#include <qdom.h>
#include <qcanvas.h>

//local includes
#include "umlobjectlist.h"
#include "umlwidgetlist.h"
#include "associationwidgetlist.h"
#include "messagewidgetlist.h"
#include "optionstate.h"
#include "worktoolbar.h"

// forward declarations
class ClassOptionsPage;
class IDChangeLog;
class ListPopupMenu;
class FloatingTextWidget;
class ObjectWidget;
class UMLFolder;
class UMLApp;
class UMLDoc;
class UMLAttribute;
class UMLCanvasObject;
class UMLClassifier;
class UMLViewImageExporter;

class KPrinter;
class ToolBarState;
class ToolBarStateFactory;

class UMLView : public QCanvasView {
    Q_OBJECT
public:
    friend class UMLViewImageExporterModel;

    UMLView(UMLFolder *parentFolder);

    virtual ~UMLView();

    // Accessors and other methods dealing with loaded/saved data

    UMLFolder *getFolder() {
        return m_pFolder;
    }

    void setFolder(UMLFolder *folder) {
        m_pFolder = folder;
    }

    QString getDoc() const {
        return m_Documentation;
    }

    void setDoc( const QString &doc ) {
        m_Documentation = doc;
    }

    QString getName() const;

    void setName(const QString &name);

    Uml::Diagram_Type getType() const {
        return m_Type;
    }

    void setType( Uml::Diagram_Type type ) {
        m_Type = type;
    }

    QColor getFillColor() const;

    void setFillColor( const QColor &color );

    QColor getLineColor() const;

    void setLineColor( const QColor &color );

    uint getLineWidth() const;

    void setLineWidth( uint width );

    Uml::IDType getID() const {
        return m_nID;
    }

    void setID( Uml::IDType id ) {
        m_nID = id;
    }

    int getZoom() const {
        return m_nZoom;
    }

    void setZoom(int zoom);

    int getCanvasHeight() const {
        return m_nCanvasHeight;
    }

    void setCanvasHeight(int height) {
        m_nCanvasHeight = height;
    }

    int getCanvasWidth() const {
        return m_nCanvasWidth;
    }

    void setCanvasWidth(int width) {
        m_nCanvasWidth = width;
    }

    bool getSnapToGrid() const {
        return m_bUseSnapToGrid;
    }

    void setSnapToGrid( bool bSnap );

    bool getSnapComponentSizeToGrid() const {
        return m_bUseSnapComponentSizeToGrid;
    }

    int getSnapX() const {
        return m_nSnapX;
    }

    int getSnapY() const {
        return m_nSnapY;
    }

    int snappedX(int x);

    int snappedY(int y);

    bool getShowSnapGrid() const;

    void setShowSnapGrid( bool bShow );

    void setSnapComponentSizeToGrid( bool bSnap );

    bool getUseFillColor() const;

    void setUseFillColor(bool ufc);

    QFont getFont() const;

    void setFont(QFont font, bool changeAllWidgets = false);

    bool getShowOpSig() const;

    void setShowOpSig(bool bShowOpSig);

    const Settings::OptionState& getOptionState() const {
        return m_Options;
    }

    void setOptionState( const Settings::OptionState& options) {
        m_Options = options;
    }

    AssociationWidgetList& getAssociationList() {
        return m_AssociationList;
    }

    UMLWidgetList& getWidgetList() {
        return m_WidgetList;
    }

    MessageWidgetList& getMessageList() {
        return m_MessageList;
    }

    // End of accessors and methods that only deal with loaded/saved data

    int currentZoom();

    void print(KPrinter *pPrinter, QPainter & pPainter);

    void hideEvent(QHideEvent *he);

    void showEvent(QShowEvent *se);

    void checkMessages(ObjectWidget * w);

    UMLWidget * findWidget(Uml::IDType id);

    AssociationWidget * findAssocWidget(Uml::IDType id);

    AssociationWidget * findAssocWidget(Uml::Association_Type at,
                                        UMLWidget *pWidgetA, UMLWidget *pWidgetB);

    AssociationWidget * findAssocWidget(UMLWidget *pWidgetA,
                                        UMLWidget *pWidgetB, const QString& roleNameB);

    void removeWidget(UMLWidget * o);

    void setSelected(UMLWidget * w, QMouseEvent * me);

    void clearSelected();

    void moveSelectedBy(int dX, int dY);

    int getSelectCount(bool filterText = false) const;

    void selectionUseFillColor(bool useFC);

    void selectionSetFont( const QFont &font );

    void selectionSetLineColor( const QColor &color );

    void selectionSetLineWidth( uint width );

    void selectionSetFillColor( const QColor &color );

    void selectionToggleShow(int sel);

    void deleteSelection();

    void selectAll();

    Uml::IDType getLocalID();

    bool widgetOnDiagram(Uml::IDType id);

    bool isSavedInSeparateFile();

    QPoint & getPos() {
        return m_Pos;
    }

    void setPos(const QPoint &_pos) {
        m_Pos = _pos;
    }

    void setMenu();

    void resetToolbar() {
        emit sigResetToolBar();
    }

    bool getPaste() const {
        return m_bPaste;
    }

    void setPaste(bool paste) {
        m_bPaste = paste;
    }

    UMLObjectList getUMLObjects();

    void activate();

    AssociationWidgetList getSelectedAssocs();

    bool getSelectedWidgets(UMLWidgetList& WidgetList, bool filterText = true);

    void activateAfterLoad( bool bUseLog = false );

    void endPartialWidgetPaste();
    void beginPartialWidgetPaste();

    void removeAssoc(AssociationWidget* pAssoc);

    void removeAssociations(UMLWidget* pWidget);

    void selectAssociations(bool bSelect);

    void getWidgetAssocs(UMLObject* Obj, AssociationWidgetList & Associations);

    void removeAllAssociations();

    void removeAllWidgets();

    void showDocumentation( UMLObject * object, bool overwrite );

    void showDocumentation( UMLWidget * widget, bool overwrite );

    void showDocumentation( AssociationWidget * widget, bool overwrite );

    void updateDocumentation( bool clear );

    void getDiagram(const QRect &rect, QPixmap & diagram);

    void  getDiagram(const QRect &area, QPainter & painter);

    void copyAsImage(QPixmap*& pix);

    UMLViewImageExporter* getImageExporter();

    bool addAssociation( AssociationWidget* pAssoc , bool isPasteOperation = false);

    void removeAssocInViewAndDoc(AssociationWidget* assoc);

    bool addWidget( UMLWidget * pWidget , bool isPasteOperation = false);

    QPoint getPastePoint();

    void resetPastePoint();

    void setStartedCut() {
        m_bStartedCut = true;
    }

    void createAutoAssociations( UMLWidget * widget );

    void createAutoAttributeAssociations(UMLWidget *widget);

    void updateContainment(UMLCanvasObject *self);

    void setSnapX( int x) {
        m_nSnapX = x;
        canvas() -> setAllChanged();
    }

    void setSnapY( int y) {
        m_nSnapY = y;
        canvas() -> setAllChanged();
    }

    bool showPropDialog();

    void setClassWidgetOptions( ClassOptionsPage * page );

    void checkSelections();

    bool checkUniqueSelection();

    void clearDiagram();

    void toggleSnapToGrid();

    void toggleSnapComponentSizeToGrid();

    void toggleShowGrid();

    void fileLoaded();

    void setCanvasSize(int width, int height);

    void resizeCanvasToItems();

    static const int defaultCanvasSize;

    // Load/Save interface:

    virtual void saveToXMI( QDomDocument & qDoc, QDomElement & qElement );

    virtual bool loadFromXMI( QDomElement & qElement );

    bool loadUISDiagram(QDomElement & qElement);

    UMLWidget* loadWidgetFromXMI(QDomElement& widgetElement);

    void addObject(UMLObject *object);

    void selectWidgets(int px, int py, int qx, int qy);

    ObjectWidget * onWidgetLine( const QPoint &point );

    UMLWidget* getFirstMultiSelectedWidget() {
        return m_SelectedList.first();
    }

    UMLWidget *getWidgetAt(QPoint p);

    void setupNewWidget(UMLWidget *w);

    bool getCreateObject() const {
        return m_bCreateObject;
    }

    void setCreateObject(bool bCreate) {
        m_bCreateObject = bCreate;
    }

    void emitRemovePopupMenu() {
        emit sigRemovePopupMenu();
    }

    int generateCollaborationId();

protected:

    // Methods and members related to loading/saving

    bool loadWidgetsFromXMI( QDomElement & qElement );

    bool loadMessagesFromXMI( QDomElement & qElement );

    bool loadAssociationsFromXMI( QDomElement & qElement );

    bool loadUisDiagramPresentation(QDomElement & qElement);

    Uml::IDType m_nLocalID;

    Uml::IDType m_nID;

    Uml::Diagram_Type m_Type;

    QString m_Name;

    QString m_Documentation;

    Settings::OptionState m_Options;

    MessageWidgetList m_MessageList;

    UMLWidgetList m_WidgetList;

    AssociationWidgetList m_AssociationList;

    int m_nSnapX;

    int m_nSnapY;

    bool m_bUseSnapToGrid;

    bool m_bUseSnapComponentSizeToGrid;

    bool m_bShowSnapGrid;

    int m_nZoom;

    int m_nCanvasWidth;

    int m_nCanvasHeight;

    // End of methods and members related to loading/saving

    void closeEvent ( QCloseEvent * e );

    void contentsDragEnterEvent(QDragEnterEvent* mouseEvent);

    void contentsDropEvent(QDropEvent* mouseEvent);


    QRect getDiagramRect();


    void init();

    void contentsMouseReleaseEvent(QMouseEvent* mouseEvent);

    void contentsMouseMoveEvent(QMouseEvent* mouseEvent);

    void contentsMouseDoubleClickEvent(QMouseEvent* mouseEvent);

    void contentsMousePressEvent(QMouseEvent* mouseEvent);


    void selectWidgetsOfAssoc (AssociationWidget * a);

    void makeSelected (UMLWidget * uw);

    void updateComponentSizes();

    void findMaxBoundingRectangle(const FloatingTextWidget* ft,
                                  int& px, int& py, int& qx, int& qy);

    void forceUpdateWidgetFontMetrics(QPainter *painter);

    int m_nCollaborationId;

    QPoint m_Pos;
    bool m_bCreateObject, m_bDrawSelectedOnly, m_bPaste;
    ListPopupMenu * m_pMenu;
    UMLWidgetList m_SelectedList;

    bool m_bStartedCut;

private:
    UMLFolder *m_pFolder;

    bool m_bChildDisplayedDoc;

    ToolBarStateFactory* m_pToolBarStateFactory;
    ToolBarState* m_pToolBarState;

    IDChangeLog * m_pIDChangesLog;

    bool m_bActivated;

    bool m_bPopupShowing;

    QPoint m_PastePoint;

    UMLDoc* m_pDoc;

    UMLViewImageExporter* m_pImageExporter;

    void createAutoAttributeAssociation(UMLClassifier *type,
                                        UMLAttribute *attr,
                                        UMLWidget *widget);

public slots:

    void zoomIn();
    void zoomOut();

    void slotToolBarChanged(int c);
    void slotObjectCreated(UMLObject * o);
    void slotObjectRemoved(UMLObject * o);

    void slotMenuSelection(int sel);

    void slotRemovePopupMenu();

    void slotActivate();

    void slotCutSuccessful();

    void slotShowView();

    void show();

signals:
    void sigResetToolBar();
    void sigColorChanged( Uml::IDType );
    void sigRemovePopupMenu();
    void sigClearAllSelected();
    void sigLineWidthChanged( Uml::IDType );
    void sigSnapToGridToggled(bool);
    void sigSnapComponentSizeToGridToggled(bool);
    void sigShowGridToggled(bool);

    void sigAssociationRemoved(AssociationWidget*);

    void sigWidgetRemoved(UMLWidget*);
};

#endif // UMLVIEW_H

This file is part of the documentation for umbrello Version 3.1.0.

Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Jun 26 08:08:01 2007 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003