umbrello  2.32.0
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
umldoc.h
Go to the documentation of this file.
1 /*
2  SPDX-License-Identifier: GPL-2.0-or-later
3  SPDX-FileCopyrightText: 2002-2020 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
4 */
5 
6 #ifndef UMLDOC_H
7 #define UMLDOC_H
8 
9 // app includes
10 #include "basictypes.h"
11 #include "optionstate.h"
12 #include "umlobject.h"
13 #include "umlobjectlist.h"
14 #include "umlassociationlist.h"
15 #include "umlclassifierlist.h"
16 #include "umlentitylist.h"
17 #include "umlviewlist.h"
18 #include "umlstereotypelist.h"
19 #include "umlpackagelist.h"
20 
21 // kde includes
22 #if QT_VERSION < 0x050000
23 #include <kurl.h>
24 #endif
25 
26 // qt includes
27 #if QT_VERSION >= 0x050000
28 #include <QUrl>
29 #endif
30 #include <QMap>
31 
32 // system includes
33 #include <typeinfo>
34 
35 #define ENC_UNKNOWN 0
36 #define ENC_UNICODE 1
37 #define ENC_WINDOWS 2
38 #define ENC_OLD_ENC 3
39 
40 // forward declarations
41 class QDomNode;
42 class QDomElement;
43 class QPrinter;
44 
45 class IDChangeLog;
46 class DiagramsModel;
47 class ObjectsModel;
48 class StereotypesModel;
49 class UMLPackage;
50 class UMLFolder;
51 class DiagramPrintPage;
52 
69 class UMLDoc : public QObject
70 {
71  Q_OBJECT
72 public:
73 
74  UMLDoc();
75  ~UMLDoc();
76 
77  void init();
78 
79  void addView(UMLView *view);
80  void removeView(UMLView *view, bool enforceOneView = true);
81  void setMainViewID(Uml::ID::Type viewID);
83  void activateAllViews();
84  void removeAllViews();
85  void removeAllObjects();
86 
87  void setModified(bool modified = true);
88  bool isModified();
89  bool saveModified();
90 
91  bool newDocument();
92  void closeDocument();
93 #if QT_VERSION >= 0x050000
94  bool openDocument(const QUrl& url, const char *format = 0);
95  bool saveDocument(const QUrl& url, const char *format = 0);
96  const QUrl& url() const;
97  void setUrl(const QUrl& url);
98 #else
99  bool openDocument(const KUrl& url, const char *format = 0);
100  bool saveDocument(const KUrl& url, const char *format = 0);
101  const KUrl& url() const;
102  void setUrl(const KUrl& url);
103 #endif
104  void setUrlUntitled();
105 
106  void setupSignals();
107 
108  bool isUnique(const QString &name);
109  bool isUnique(const QString &name, UMLPackage *package);
110 
112 
113  void addAssociation(UMLAssociation *assoc);
114  void removeAssociation(UMLAssociation *assoc, bool doSetModified = true);
116  const UMLObject *roleAObj,
117  const UMLObject *roleBObj,
118  bool *swap = 0);
119 
120  QString createDiagramName(Uml::DiagramType::Enum type, bool askForName = true);
123  const QString& name,
125 
126  void removeDiagram(Uml::ID::Type id);
128  void renameDiagram(Uml::ID::Type id);
129 
130  void removeUMLObject(UMLObject* umlobject, bool deleteObject = false);
131  void renameUMLObject(UMLObject *o);
133 
135 
136  UMLObject* findUMLObject(const QString &name,
138  UMLObject *currentObj = 0);
139 
141  const QString &name,
143 
145  const QString &name,
147 
149  const QString &name,
151 
153  const QString &name,
155 
156  UMLClassifier * findUMLClassifier(const QString &name);
157 
159  UMLView * findView(Uml::DiagramType::Enum type, const QString &name,
160  bool searchAllScopes = false);
161 
162  void setName(const QString& name);
163  QString name() const;
164 
165  void setResolution(qreal resolution);
166  qreal resolution() const;
167  qreal dpiScale() const;
168 
169  Uml::ID::Type modelID() const;
170 
171  static bool tagEq (const QString& tag, const QString& pattern);
172 
173  virtual void saveToXMI1(QIODevice& file);
174 
175  short encoding(QIODevice & file);
176 
177  virtual bool loadFromXMI1(QIODevice& file, short encode = ENC_UNKNOWN);
178 
179  bool validateXMI1Header(QDomNode& headerNode);
180 
181  bool loadUMLObjectsFromXMI1(QDomElement & element);
182  void loadExtensionsFromXMI1(QDomNode & node);
183  bool loadDiagramsFromXMI1(QDomNode & node);
184 
185  void signalDiagramRenamed(UMLView * view);
187 
188  UMLClassifierList concepts(bool includeNested = true);
189  UMLClassifierList classesAndInterfaces(bool includeNested = true);
190  UMLEntityList entities(bool includeNested = true);
191  UMLFolder * datatypeFolder() const;
192  UMLClassifierList datatypes(bool includeInactive = false);
194  UMLPackageList packages(bool includeNested = true, Uml::ModelType::Enum model = Uml::ModelType::Logical);
195 
196  void print(QPrinter * pPrinter, DiagramPrintPage * selectPage);
197 
200 
201  bool assignNewIDs(UMLObject* obj);
202 
203  bool addUMLObject(UMLObject * object);
204  bool addUMLView(UMLView * pView);
205 
208 
210  void setCurrentRoot(Uml::ModelType::Enum rootType);
211 
212  virtual IDChangeLog* changeLog();
213 
214  void beginPaste();
215  void endPaste();
216 
218 
219  void setDocumentation(const QString &doc);
220  QString documentation() const;
221 
223 
224  QString uniqueViewName(const Uml::DiagramType::Enum type);
225 
226  bool loading() const;
227  void setLoading(bool state = true);
228 
229  bool importing() const;
230  void setImporting(bool state = true);
231 
232  bool closing() const;
233 
234  void addDefaultDatatypes();
235  void createDatatype(const QString &name);
236  void removeDatatype(const QString &name);
237 
238  UMLStereotype *createStereotype(const QString &name);
239  UMLStereotype *findStereotype(const QString &name);
240  UMLStereotype *findOrCreateStereotype(const QString &name);
242  void addStereotype(UMLStereotype *s);
244  void addDefaultStereotypes();
245  const UMLStereotypeList& stereotypes() const;
246 
247  void writeToStatusBar(const QString &text);
248 
249  void resolveTypes();
250  bool loadDiagrams1();
251  void addDiagramToLoad(UMLFolder *folder, QDomNode node);
252 
256 
257  void setLoadingError(const QString &text);
258 
259 private:
260  void initSaveTimer();
261  void createDatatypeFolder();
262 
263  class Private;
265 
270 
276 
285 
286  QString m_Name;
288  int m_count;
290 #if QT_VERSION >= 0x050000
291  QUrl m_doc_url;
292 #else
293  KUrl m_doc_url;
294 #endif
299 
304 
309 
313  QString m_Doc;
314 
319 
324 
329 
336 
341 
345 
351 
355  typedef QMap<UMLFolder*, QList<QDomNode>> DiagramsMap;
357 
358 public slots:
360  void slotAutoSave();
361  void slotDiagramPopupMenu(QWidget* umlview, const QPoint& point);
362 
363 signals:
368 
369  void sigObjectCreated(UMLObject *);
370  void sigObjectRemoved(UMLObject *);
371 
376 
382  void sigSetStatusbarProgressSteps(int totalSteps);
383 
389  void sigSetStatusbarProgress(int stepPosition);
390 
394  void sigWriteToStatusBar(const QString &text);
395 
400  void sigCurrentViewChanged();
401 
402 };
403 
404 #endif // UMLDOC_H
A print dialog page.
Definition: diagramprintpage.h:33
Definition: diagramsmodel.h:21
Definition: idchangelog.h:22
Definition: objectsmodel.h:16
Definition: optionstate.h:310
Definition: stereotypesmodel.h:20
Sets up association information.
Definition: association.h:29
Information for a non-graphical Concept/Class.
Definition: classifier.h:35
Definition: umldoc.cpp:94
Definition: umldoc.h:70
QMap< UMLFolder *, QList< QDomNode > > DiagramsMap
Definition: umldoc.h:355
QString m_Name
name of this model as stored in the <UML:Model> tag
Definition: umldoc.h:286
void sigResetStatusbarProgress()
Definition: moc_umldoc.cpp:343
QString name() const
Definition: umldoc.cpp:2001
void closeDocument()
Definition: umldoc.cpp:399
KUrl m_doc_url
Definition: umldoc.h:293
UMLFolder * m_root[Uml::ModelType::N_MODELTYPES]
Definition: umldoc.h:269
void slotAutoSave()
Definition: umldoc.cpp:3351
void sigDiagramRemoved(Uml::ID::Type id)
Definition: moc_umldoc.cpp:308
void sigSetStatusbarProgress(int stepPosition)
Definition: moc_umldoc.cpp:356
const KUrl & url() const
Definition: umldoc.cpp:327
bool m_bTypesAreResolved
Definition: umldoc.h:328
void addView(UMLView *view)
Definition: umldoc.cpp:221
QString documentation() const
Definition: umldoc.cpp:3243
void sigDiagramRenamed(Uml::ID::Type t)
Definition: moc_umldoc.cpp:315
UMLAssociation * createUMLAssociation(UMLObject *a, UMLObject *b, Uml::AssociationType::Enum type)
Definition: umldoc.cpp:1459
bool newDocument()
Definition: umldoc.cpp:451
void renameUMLObject(UMLObject *o)
Definition: umldoc.cpp:1708
UMLObject * findUMLObjectRecursive(Uml::ModelType::Enum, const QString &name, UMLObject::ObjectType type=UMLObject::ot_UMLObject)
Definition: umldoc.cpp:1130
bool m_bLoading
Definition: umldoc.h:303
ObjectsModel * objectsModel()
Definition: umldoc.cpp:2556
void beginPaste()
Definition: umldoc.cpp:3202
void slotDiagramPopupMenu(QWidget *umlview, const QPoint &point)
Definition: umldoc.cpp:3492
void setResolution(qreal resolution)
Definition: umldoc.cpp:2011
UMLStereotype * findStereotypeById(Uml::ID::Type id)
Definition: umldoc.cpp:1337
UMLFolder * m_datatypeRoot
Definition: umldoc.h:275
UMLObject * findUMLObject(const QString &name, UMLObject::ObjectType type=UMLObject::ot_UMLObject, UMLObject *currentObj=0)
Definition: umldoc.cpp:1063
void removeView(UMLView *view, bool enforceOneView=true)
Definition: umldoc.cpp:260
UMLEntityList entities(bool includeNested=true)
Definition: umldoc.cpp:2985
UMLObject * findObjectById(Uml::ID::Type id)
Definition: umldoc.cpp:1034
void resolveTypes()
Definition: umldoc.cpp:2495
UMLClassifier * findUMLClassifier(const QString &name)
Definition: umldoc.cpp:1162
virtual bool loadFromXMI1(QIODevice &file, short encode=ENC_UNKNOWN)
Definition: umldoc.cpp:2272
void init()
Definition: umldoc.cpp:140
void sigDiagramChanged(Uml::DiagramType::Enum)
Definition: moc_umldoc.cpp:322
void removeAssociation(UMLAssociation *assoc, bool doSetModified=true)
Definition: umldoc.cpp:1394
void setUrlUntitled()
Definition: umldoc.cpp:336
void removeDiagram(Uml::ID::Type id)
Definition: umldoc.cpp:1799
UMLViewList viewIterator()
Definition: umldoc.cpp:3062
void removeDiagramCmd(Uml::ID::Type id)
Definition: umldoc.cpp:1823
void setDocumentation(const QString &doc)
Definition: umldoc.cpp:3253
void sigObjectCreated(UMLObject *)
Definition: moc_umldoc.cpp:329
qreal dpiScale() const
Definition: umldoc.cpp:2032
virtual void saveToXMI1(QIODevice &file)
Definition: umldoc.cpp:2058
void print(QPrinter *pPrinter, DiagramPrintPage *selectPage)
Definition: umldoc.cpp:3036
UMLStereotype * findStereotype(const QString &name)
Definition: umldoc.cpp:1308
virtual IDChangeLog * changeLog()
Definition: umldoc.cpp:3193
bool validateXMI1Header(QDomNode &headerNode)
Definition: umldoc.cpp:2577
void addDefaultStereotypes()
Definition: umldoc.cpp:1370
UMLClassifierList classesAndInterfaces(bool includeNested=true)
Definition: umldoc.cpp:2971
ObjectsModel * m_objectsModel
Definition: umldoc.h:343
void setUrl(const KUrl &url)
Definition: umldoc.cpp:313
bool loadUMLObjectsFromXMI1(QDomElement &element)
Definition: umldoc.cpp:2600
int m_count
auxiliary counter for the progress bar
Definition: umldoc.h:288
void slotRemoveUMLObject(UMLObject *o)
Definition: umldoc.cpp:1213
UMLDoc()
Definition: umldoc.cpp:105
UMLPackageList packages(bool includeNested=true, Uml::ModelType::Enum model=Uml::ModelType::Logical)
Definition: umldoc.cpp:2933
Uml::ID::Type modelID() const
Definition: umldoc.cpp:2046
DiagramsModel * diagramsModel()
Definition: umldoc.cpp:2551
Uml::ID::Type m_nViewID
Definition: umldoc.h:323
Uml::ModelType::Enum rootFolderType(UMLObject *obj)
Definition: umldoc.cpp:3177
void removeUMLObject(UMLObject *umlobject, bool deleteObject=false)
Definition: umldoc.cpp:1879
void createDatatypeFolder()
Definition: umldoc.cpp:177
StereotypesModel * m_stereotypesModel
Definition: umldoc.h:344
void setLoading(bool state=true)
Definition: umldoc.cpp:1577
bool addUMLView(UMLView *pView)
Definition: umldoc.cpp:3268
Uml::ID::Type assignNewID(Uml::ID::Type oldID)
Definition: umldoc.cpp:3229
const UMLStereotypeList & stereotypes() const
Definition: umldoc.cpp:1383
Private * m_d
Definition: umldoc.h:263
QString createDiagramName(Uml::DiagramType::Enum type, bool askForName=true)
Definition: umldoc.cpp:1615
void sigDiagramCreated(Uml::ID::Type id)
Definition: moc_umldoc.cpp:301
void writeToStatusBar(const QString &text)
Definition: umldoc.cpp:1204
bool isModified()
Definition: umldoc.cpp:3108
bool addUMLObject(UMLObject *object)
Definition: umldoc.cpp:1176
void sigObjectRemoved(UMLObject *)
Definition: moc_umldoc.cpp:336
void removeAllObjects()
Definition: umldoc.cpp:2919
void signalUMLObjectCreated(UMLObject *o)
Definition: umldoc.cpp:1979
IDChangeLog * m_pChangeLog
Definition: umldoc.h:298
Uml::ID::Type m_modelID
xmi.id of this model in the <UML:Model>
Definition: umldoc.h:287
bool assignNewIDs(UMLObject *obj)
Definition: umldoc.cpp:3121
StereotypesModel * stereotypesModel()
Definition: umldoc.cpp:2566
static bool tagEq(const QString &tag, const QString &pattern)
Definition: umldoc.cpp:3548
void setMainViewID(Uml::ID::Type viewID)
Definition: umldoc.cpp:2765
void addDiagramToLoad(UMLFolder *folder, QDomNode node)
Definition: umldoc.cpp:2543
UMLObject * findUMLObjectRaw(Uml::ModelType::Enum, const QString &name, UMLObject::ObjectType type=UMLObject::ot_UMLObject)
Definition: umldoc.cpp:1095
DiagramsModel * m_diagramsModel
Definition: umldoc.h:342
UMLViewList views(Uml::DiagramType::Enum type=Uml::DiagramType::Undefined)
Definition: umldoc.cpp:3077
qreal m_resolution
Definition: umldoc.h:350
short encoding(QIODevice &file)
Definition: umldoc.cpp:2170
QTimer * m_pAutoSaveTimer
Definition: umldoc.h:318
DiagramsMap m_diagramsToLoad
Definition: umldoc.h:356
UMLView * findView(Uml::ID::Type id)
Definition: umldoc.cpp:1001
void settingsChanged(Settings::OptionState &optionState)
Definition: umldoc.cpp:3320
void sigWriteToStatusBar(const QString &text)
Definition: moc_umldoc.cpp:363
void createDatatype(const QString &name)
Definition: umldoc.cpp:3449
void changeCurrentView(Uml::ID::Type id)
Definition: umldoc.cpp:1772
bool isUnique(const QString &name)
Definition: umldoc.cpp:1230
bool loading() const
Definition: umldoc.cpp:1568
void activateAllViews()
Definition: umldoc.cpp:3304
UMLAssociation * findAssociation(Uml::AssociationType::Enum assocType, const UMLObject *roleAObj, const UMLObject *roleBObj, bool *swap=0)
Definition: umldoc.cpp:1425
UMLStereotypeList m_stereoList
Definition: umldoc.h:284
void signalDiagramRenamed(UMLView *view)
Definition: umldoc.cpp:3410
void setImporting(bool state=true)
Definition: umldoc.cpp:1594
UMLStereotype * findOrCreateStereotype(const QString &name)
Definition: umldoc.cpp:1323
bool saveModified()
Definition: umldoc.cpp:351
bool openDocument(const KUrl &url, const char *format=0)
Definition: umldoc.cpp:494
UMLView * createDiagram(UMLFolder *folder, Uml::DiagramType::Enum type, const QString &name, Uml::ID::Type id=Uml::ID::None)
Definition: umldoc.cpp:1644
void removeAllViews()
Definition: umldoc.cpp:2905
qreal resolution() const
Definition: umldoc.cpp:2022
bool importing() const
Definition: umldoc.cpp:1586
bool m_modified
Definition: umldoc.h:289
UMLClassifierList datatypes(bool includeInactive=false)
Definition: umldoc.cpp:2999
void addAssociation(UMLAssociation *assoc)
Definition: umldoc.cpp:1477
void renameDiagram(Uml::ID::Type id)
Definition: umldoc.cpp:1676
void setupSignals()
Definition: umldoc.cpp:989
~UMLDoc()
Definition: umldoc.cpp:190
bool m_bClosing
Definition: umldoc.h:340
UMLClassifierList concepts(bool includeNested=true)
Definition: umldoc.cpp:2957
void addDefaultDatatypes()
Definition: umldoc.cpp:3427
void setCurrentRoot(Uml::ModelType::Enum rootType)
Definition: umldoc.cpp:1866
void removeStereotype(UMLStereotype *s)
Definition: umldoc.cpp:1360
UMLStereotype * createStereotype(const QString &name)
Definition: umldoc.cpp:1295
bool closing() const
Definition: umldoc.cpp:1603
UMLFolder * currentRoot()
Definition: umldoc.cpp:1842
QString m_Doc
Definition: umldoc.h:313
bool m_importing
Definition: umldoc.h:308
void removeDatatype(const QString &name)
Definition: umldoc.cpp:3474
void addStereotype(UMLStereotype *s)
Definition: umldoc.cpp:1350
void setModified(bool modified=true)
Definition: umldoc.cpp:3093
bool loadDiagrams1()
Definition: umldoc.cpp:2521
bool loadDiagramsFromXMI1(QDomNode &node)
Definition: umldoc.cpp:2854
bool saveDocument(const KUrl &url, const char *format=0)
Definition: umldoc.cpp:772
void sigCurrentViewChanged()
Definition: moc_umldoc.cpp:370
UMLAssociationList associations()
Definition: umldoc.cpp:3017
QString uniqueViewName(const Uml::DiagramType::Enum type)
Definition: umldoc.cpp:1519
UMLFolder * rootFolder(Uml::ModelType::Enum mt)
Definition: umldoc.cpp:3162
void renameChildUMLObject(UMLObject *o)
Definition: umldoc.cpp:1736
void sigSetStatusbarProgressSteps(int totalSteps)
Definition: moc_umldoc.cpp:349
void initSaveTimer()
Definition: umldoc.cpp:3331
UMLFolder * datatypeFolder() const
Definition: umldoc.cpp:2945
void loadExtensionsFromXMI1(QDomNode &node)
Definition: umldoc.cpp:2775
UMLFolder * m_pCurrentRoot
Definition: umldoc.h:335
void setName(const QString &name)
Definition: umldoc.cpp:1993
void endPaste()
Definition: umldoc.cpp:3214
void setLoadingError(const QString &text)
Definition: umldoc.cpp:2561
Non-graphical management of objects and diagrams of a Folder.
Definition: folder.h:30
The base class for UML objects.
Definition: umlobject.h:70
ObjectType
Definition: umlobject.h:76
@ ot_UMLObject
Definition: umlobject.h:78
Non-graphical information for a Package.
Definition: package.h:28
Sets up stereotype information.
Definition: stereotype.h:36
Definition: umlview.h:30
bool b
Definition: cxx11-null-pointer-constant.h:6
OptionState & optionState()
Definition: optionstate.cpp:357
Enum
Definition: basictypes.h:92
Enum
Definition: basictypes.h:63
@ Undefined
Definition: basictypes.h:66
const Type None
special value for uninitialized ID
Definition: basictypes.h:373
std::string Type
Definition: basictypes.h:371
Enum
Definition: basictypes.h:27
@ N_MODELTYPES
Definition: basictypes.h:33
@ Logical
Definition: basictypes.h:28
QString a
Definition: petalnode.cpp:13
QList< UMLAssociation * > UMLAssociationList
Definition: umlassociationlist.h:12
QList< UMLClassifier * > UMLClassifierList
Definition: umlclassifierlist.h:12
#define ENC_UNKNOWN
Definition: umldoc.h:35
QList< UMLEntity * > UMLEntityList
Definition: umlentitylist.h:12
QList< UMLPackage * > UMLPackageList
Definition: umlpackagelist.h:11
QList< UMLStereotype * > UMLStereotypeList
Definition: umlstereotypelist.h:12
QList< QPointer< UMLView > > UMLViewList
Definition: umlviewlist.h:14