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

umldoc.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 UMLDOC_H
#define UMLDOC_H

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

// system includes
#include <typeinfo>

// qt includes
#include <qdatastream.h>
#include <qmap.h>
#include <qdict.h>
#include <qptrstack.h>

// kde includes
#include <kurl.h>
#include <kdockwidget.h>
#include <kpopupmenu.h>

// app includes
#include "umlnamespace.h"
#include "optionstate.h"
#include "umlobjectlist.h"
#include "umlassociationlist.h"
#include "umlclassifierlist.h"
#include "umlviewlist.h"
#include "umlstereotypelist.h"

#define ENC_UNKNOWN 0
#define ENC_UNICODE 1
#define ENC_OLD_ENC 2


// forward declarations
class QDomNode;
class QFile;
class QSplitter;

class KPrinter;

class DocWindow;
class IDChangeLog;
class ObjectWidget;
class UMLWidget;
class UMLPackage;
class UMLFolder;

class UMLDoc : public QObject {
    Q_OBJECT
public:
    UMLDoc();

    ~UMLDoc();

    void init();

    void addView(UMLView *view);

    void removeView(UMLView *view , bool enforceOneView = true );

    void setMainViewID(Uml::IDType viewID);

    void setModified(bool _m=true, bool addToUndo=true);

    bool isModified() {
        return m_modified;
    }

    bool saveModified();

    bool newDocument();

    void closeDocument();

    bool openDocument(const KURL& url, const char *format=0);

    bool saveDocument(const KURL& url, const char *format=0);

    const KURL& URL() const;

    void setURL(const KURL& url);

    void setupSignals();

    bool isUnique(const QString &name);

    bool isUnique(const QString &name, UMLPackage *package);

    UMLStereotype* findOrCreateStereotype(const QString &name);

    UMLAssociation* createUMLAssociation(UMLObject *a, UMLObject *b, Uml::Association_Type type);

    void addAssociation(UMLAssociation *pAssoc);

    void removeAssociation(UMLAssociation *pAssoc, bool doSetModified = true);

    UMLAssociation * findAssociation(Uml::Association_Type assocType,
                                     const UMLObject *roleAObj,
                                     const UMLObject *roleBObj,
                                     bool *swap = NULL);

    void createDiagram(UMLFolder *folder, Uml::Diagram_Type type, bool askForName = true);

    void removeUMLObject(UMLObject*o);

    void renameDiagram(Uml::IDType id);

    void renameUMLObject(UMLObject *o);

    void renameChildUMLObject(UMLObject *o);


    void  changeCurrentView(Uml::IDType id);

    void removeDiagram(Uml::IDType id);

    UMLObject* findObjectById(Uml::IDType id);

    UMLObject* findUMLObject(const QString &name,
                             Uml::Object_Type type = Uml::ot_UMLObject,
                             UMLObject *currentObj = NULL);

    UMLObject* findObjectByAuxId(const QString &idStr);

    UMLClassifier * findUMLClassifier (const QString &name);

    UMLStereotype * findStereotype(const QString &name);

    UMLView * findView(Uml::IDType id);

    UMLView * findView(Uml::Diagram_Type type, const QString &name,
                       bool searchAllScopes = false);

    void setName(const QString& name);

    QString getName() const;

    Uml::IDType getModelID() const;

    virtual void saveToXMI(QIODevice& file);

    short getEncoding(QIODevice & file);

    virtual bool loadFromXMI(QIODevice& file, short encode = ENC_UNKNOWN);

    bool validateXMIHeader(QDomNode& headerNode);

    bool loadUMLObjectsFromXMI( QDomElement & element );

    void loadExtensionsFromXMI(QDomNode & node);

    bool loadDiagramsFromXMI( QDomNode & node );

    void signalDiagramRenamed(UMLView * pView );

    void removeAllViews();

    void signalUMLObjectCreated(UMLObject * o);

    UMLFolder * getDatatypeFolder() {
        return m_datatypeRoot;
    }

    UMLClassifierList getConcepts(bool includeNested = true);

    UMLClassifierList getClasses(bool includeNested = true);

    UMLClassifierList getClassesAndInterfaces(bool includeNested = true);

    UMLClassifierList getInterfaces(bool includeNested = true);

    UMLClassifierList getDatatypes();

    UMLAssociationList getAssociations();

    void print(KPrinter * pPrinter);

    UMLViewList getViewIterator();

    bool assignNewIDs(UMLObject* Obj);

    bool addUMLObject(UMLObject * object);

    bool addUMLView(UMLView * pView );

    UMLFolder *getRootFolder(Uml::Model_Type mt);

    Uml::Model_Type rootFolderType(UMLObject *obj);

    UMLFolder *currentRoot();

    void setCurrentRoot(Uml::Model_Type rootType);

    virtual IDChangeLog* getChangeLog();

    void endPaste();

    void beginPaste();

    Uml::IDType assignNewID(Uml::IDType OldID);

    QString getDocumentation() const {
        return m_Doc;
    }

    void setDocumentation(const QString &doc) {
        m_Doc = doc;
    }

    void activateAllViews();

    void settingsChanged(Settings::OptionState optionState);


    int getFileVersion(void) {return version;}

    void loadUndoData();

    void loadRedoData();

    void addToUndoStack();

    void clearUndoStack();

    void clearRedoStack();

    QString uniqViewName(const Uml::Diagram_Type type);

    bool loading() const;

    void setLoading(bool state = true);

    void addDefaultDatatypes();

    void createDatatype(const QString &name);

    UMLStereotype * findStereotypeById(Uml::IDType id);

    void addStereotype(const UMLStereotype *s);

    void removeStereotype(const UMLStereotype *s);

    void addDefaultStereotypes();

    const UMLStereotypeList& getStereotypes();

    void writeToStatusBar(const QString &text);

    void resolveTypes();

private:
    void initSaveTimer();

    UMLFolder *m_root[Uml::N_MODELTYPES];
    UMLFolder *m_datatypeRoot;

    UMLStereotypeList m_stereoList;

    QString m_Name; 
    Uml::IDType m_modelID; 
    int m_count;   
    bool m_modified;
    KURL m_doc_url;

    IDChangeLog* m_pChangeLog;

    bool m_bLoading;

    QString m_Doc;

    QTimer * m_pAutoSaveTimer;

    int version;

    QPtrList<QDataStream> undoStack;

    QPtrList<QDataStream> redoStack;

    Uml::IDType m_nViewID;

    bool m_bTypesAreResolved;

    KPopupMenu* m_pTabPopupMenu;

    UMLFolder * m_pCurrentRoot;

public slots:

    void slotRemoveUMLObject(UMLObject*o);

    void slotAutoSave();

    void slotDiagramPopupMenu(QWidget* umlview, const QPoint& point);

signals:
    void sigDiagramCreated(Uml::IDType id);
    void sigDiagramRemoved(Uml::IDType id);
    void sigDiagramRenamed(Uml::IDType t);
    void sigDiagramChanged(Uml::Diagram_Type);

    void sigObjectCreated(UMLObject *);
    void sigObjectRemoved(UMLObject *);

    void sigResetStatusbarProgress();

    void sigSetStatusbarProgressSteps(int totalSteps);


    void sigSetStatusbarProgress(int stepPosition);

    void sigWriteToStatusBar(const QString &text);

    void sigCurrentViewChanged();


};

#endif // UMLDOC_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:00 2007 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003