umbrello  2.32.2
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
folder.h
Go to the documentation of this file.
1 /*
2  SPDX-License-Identifier: GPL-2.0-or-later
3  SPDX-FileCopyrightText: 2006-2020 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
4 */
5 
6 #ifndef UMLFOLDER_H
7 #define UMLFOLDER_H
8 
9 #include "package.h"
10 #include "umlviewlist.h"
11 #include "optionstate.h"
12 
29 class UMLFolder : public UMLPackage
30 {
31  Q_OBJECT
32 public:
33  explicit UMLFolder(const QString & name = QString(), Uml::ID::Type id = Uml::ID::None);
34  virtual ~UMLFolder();
35 
36  virtual UMLObject* clone() const;
37 
38  void setLocalName(const QString& localName);
39  QString localName() const;
40 
41  void addView(UMLView *view);
42 
43  void removeView(UMLView *view);
44 
45  void appendViews(UMLViewList& viewList, bool includeNested = true);
46 
47  void activateViews();
48 
50  UMLView* findView(Uml::DiagramType::Enum type, const QString &name, bool searchAllScopes = true);
51 
53 
54  void removeAllViews();
55 
56  void setFolderFile(const QString& fileName);
57  QString folderFile() const;
58 
59  bool showPropertiesDialog(QWidget *parent);
60 
61  void saveToXMI1(QXmlStreamWriter& writer);
62 
63  friend QDebug operator<<(QDebug out, const UMLFolder& item);
64 
65 protected:
66  void saveContents1(QXmlStreamWriter& writer);
67 
68  void save1(QXmlStreamWriter& writer);
69 
70  bool loadDiagramsFromXMI1(QDomNode& node);
71 
72  bool loadFolderFile(const QString& path);
73 
74  bool load1(QDomElement & element);
75 
76 private:
77  QString m_localName;
78 
85  QString m_folderFile;
87 
88  friend class UMLDoc;
89 };
90 
91 #endif
UMLFolder::m_localName
QString m_localName
i18n name, only used for predefined root folders
Definition: folder.h:77
document
GNU GENERAL PUBLIC LICENSE June Free Software Inc Franklin Fifth USA Everyone is permitted to copy and distribute verbatim copies of this license document
Definition: GPL-2.0-only.txt:8
datatype.h
Uml::ModelType::Enum
Enum
Definition: basictypes.h:27
UMLDoc::url
const KUrl & url() const
Definition: umldoc.cpp:327
UMLDoc::datatypeFolder
UMLFolder * datatypeFolder() const
Definition: umldoc.cpp:2959
Settings::GeneralState::tabdiagrams
bool tabdiagrams
Definition: optionstate.h:53
UMLObject::name
QString name() const
Definition: umlobject.cpp:206
umlview.h
UMLFolder::saveContents1
void saveContents1(QXmlStreamWriter &writer)
Definition: folder.cpp:266
UMLDatatype::setActive
void setActive(bool active=true)
Definition: datatype.cpp:68
UMLObject::save1
void save1(const QString &tag, QXmlStreamWriter &writer)
Definition: umlobject.cpp:850
UMLFolder::folderFile
QString folderFile() const
Definition: folder.cpp:256
UMLFolder::saveToXMI1
void saveToXMI1(QXmlStreamWriter &writer)
Definition: folder.cpp:320
UMLDatatype
Non-graphical information for a Datatype.
Definition: datatype.h:20
UMLFolder::setViewOptions
void setViewOptions(const Settings::OptionState &optionState)
Definition: folder.cpp:210
Uml::ID::None
const Type None
special value for uninitialized ID
Definition: basictypes.h:373
Uml::ModelType::Logical
@ Logical
Definition: basictypes.h:28
Uml::DiagramType::Enum
Enum
Definition: basictypes.h:63
object_factory.h
Uml::ID::toString
QString toString(const ID::Type &id)
Definition: basictypes.cpp:1300
UMLFolder::load1
bool load1(QDomElement &element)
Definition: folder.cpp:466
UMLObject::setName
virtual void setName(const QString &strName)
Definition: umlobject.cpp:187
UMLObject::umlPackage
UMLPackage * umlPackage() const
Definition: umlobject.cpp:649
UMLFolder::loadDiagramsFromXMI1
bool loadDiagramsFromXMI1(QDomNode &node)
Definition: folder.cpp:373
UMLFolder::appendViews
void appendViews(UMLViewList &viewList, bool includeNested=true)
Definition: folder.cpp:103
UMLFolder::~UMLFolder
virtual ~UMLFolder()
Definition: folder.cpp:45
UMLFolder::addView
void addView(UMLView *view)
Definition: folder.cpp:84
UMLFolder::showPropertiesDialog
bool showPropertiesDialog(QWidget *parent)
Definition: folder.cpp:582
Model_Utils::getXmiId
QString getXmiId(QDomElement element)
Definition: model_utils.cpp:743
Uml::ID::Type
std::string Type
Definition: basictypes.h:371
Settings::OptionState::generalState
GeneralState generalState
Definition: optionstate.h:322
model_utils.h
UMLScene::saveToXMI1
virtual void saveToXMI1(QXmlStreamWriter &writer)
Definition: umlscene.cpp:3763
UMLObject
The base class for UML objects.
Definition: umlobject.h:69
UMLObject::baseType
ObjectType baseType() const
Definition: umlobject.cpp:392
UMLObject::asUMLDatatype
UMLDatatype * asUMLDatatype()
Definition: umlobject.cpp:1392
optionstate.h
UMLFolder::clone
virtual UMLObject * clone() const
Definition: folder.cpp:54
Settings::optionState
OptionState & optionState()
Definition: optionstate.cpp:357
UMLObject::asUMLFolder
UMLFolder * asUMLFolder()
Definition: umlobject.cpp:1398
UMLObject::m_BaseType
ObjectType m_BaseType
objects type
Definition: umlobject.h:276
UMLObject::setStereotypeCmd
void setStereotypeCmd(const QString &_name)
Definition: umlobject.cpp:530
Uml::ID::fromString
ID::Type fromString(const QString &id)
Definition: basictypes.cpp:1305
UMLFolder::findView
UMLView * findView(Uml::ID::Type id)
Definition: folder.cpp:151
Model_Utils::treeViewAddViews
void treeViewAddViews(const UMLViewList &viewList)
Definition: model_utils.cpp:399
operator<<
QDebug operator<<(QDebug out, const UMLFolder &item)
Definition: folder.cpp:596
UMLView
Definition: umlview.h:29
UMLDoc::rootFolder
UMLFolder * rootFolder(Uml::ModelType::Enum mt) const
Definition: umldoc.cpp:3176
UMLDoc::findObjectById
UMLObject * findObjectById(Uml::ID::Type id)
Definition: umldoc.cpp:1039
umlviewlist.h
number
it is up to the author donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License If the distribution and or use of the Library is restricted in certain countries either by patents or by copyrighted the original copyright holder who places the Library under this License may add an geographical distribution limitation excluding those so that distribution is permitted only in or among countries not thus excluded In such this License incorporates the limitation as if written in the body of this License The Free Software Foundation may publish revised and or new versions of the Library General Public License from time to time Such new versions will be similar in spirit to the present but may differ in detail to address new problems or concerns Each version is given a distinguishing version number If the Library specifies a version number of this License which applies to it and any later you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation If the Library does not specify a license version number
Definition: LGPL-2.0-only.txt:368
UMLFolder::setLocalName
void setLocalName(const QString &localName)
Definition: folder.cpp:67
uWarning
#define uWarning()
Definition: debug_utils.h:110
UMLObject::fullyQualifiedName
virtual QString fullyQualifiedName(const QString &separator=QString(), bool includeRoot=false) const
Definition: umlobject.cpp:222
UMLObject::copyInto
virtual void copyInto(UMLObject *lhs) const
Definition: umlobject.cpp:309
folder.h
i18n
#define i18n
Definition: main.cpp:34
UMLPackage::removeObject
void removeObject(UMLObject *pObject)
Definition: package.cpp:205
Model_Utils::isCommonXMI1Attribute
bool isCommonXMI1Attribute(const QString &tag)
Definition: model_utils.cpp:757
UMLFolder::localName
QString localName() const
Definition: folder.cpp:76
UMLObject::packages
UMLPackageList packages(bool includeRoot=false) const
Definition: umlobject.cpp:601
uDebug
#define uDebug()
Definition: debug_utils.h:108
v
std::vector< std::string > v
Definition: cxx11-initializer-lists.h:19
UMLPackage::m_objects
UMLObjectList m_objects
Definition: package.h:78
UMLObject::doc
QString doc() const
Definition: umlobject.cpp:430
UMLApp::app
static UMLApp * app()
Definition: uml.cpp:275
UMLDoc
Definition: umldoc.h:69
UMLCanvasObject::subordinates
UMLObjectList & subordinates() const
Definition: umlcanvasobject.h:77
UMLFolder
Non-graphical management of objects and diagrams of a Folder.
Definition: folder.h:29
UMLFolder::UMLFolder
UMLFolder(const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
Definition: folder.cpp:35
UMLPackageList
QList< UMLPackage * > UMLPackageList
Definition: umlpackagelist.h:11
UMLDoc::tagEq
static bool tagEq(const QString &tag, const QString &pattern)
Definition: umldoc.cpp:3562
UMLDoc::addView
void addView(UMLView *view)
Definition: umldoc.cpp:221
UMLFolder::activateViews
void activateViews()
Definition: folder.cpp:124
Uml::ModelType::N_MODELTYPES
@ N_MODELTYPES
Definition: basictypes.h:33
UMLFolder::removeView
void removeView(UMLView *view)
Definition: folder.cpp:92
Settings::OptionState
Definition: optionstate.h:310
UMLFolder::operator<<
friend QDebug operator<<(QDebug out, const UMLFolder &item)
Definition: folder.cpp:596
uError
#define uError()
Definition: debug_utils.h:109
UMLPackage::appendPackages
void appendPackages(UMLPackageList &packages, bool includeNested=true) const
Definition: package.cpp:322
UMLObject::loadFromXMI1
virtual bool loadFromXMI1(QDomElement &element)
Definition: umlobject.cpp:993
umlscene.h
uml.h
UMLObject::setUMLPackage
bool setUMLPackage(UMLPackage *pPkg)
Definition: umlobject.cpp:619
Object_Factory::makeObjectFromXMI
UMLObject * makeObjectFromXMI(const QString &xmiTag, const QString &stereoID)
Definition: object_factory.cpp:376
debug_utils.h
UMLDoc::addDiagramToLoad
void addDiagramToLoad(UMLFolder *folder, QDomNode node)
Definition: umldoc.cpp:2552
UMLDoc::rootFolderType
Uml::ModelType::Enum rootFolderType(UMLObject *obj) const
Definition: umldoc.cpp:3191
UMLView::umlScene
UMLScene * umlScene() const
Definition: umlview.cpp:51
UMLFolder::removeAllViews
void removeAllViews()
Definition: folder.cpp:221
UMLObject::saveToXMI1
virtual void saveToXMI1(QXmlStreamWriter &writer)
Definition: umlobject.cpp:837
uIgnoreZeroPointer
#define uIgnoreZeroPointer(a)
Definition: debug_utils.h:120
UMLScene::setOptionState
void setOptionState(const Settings::OptionState &options)
Definition: umlscene.cpp:575
dialog_utils.h
package.h
UMLDoc::removeView
void removeView(UMLView *view, bool enforceOneView=true)
Definition: umldoc.cpp:260
UMLScene::loadFromXMI1
virtual bool loadFromXMI1(QDomElement &qElement)
Definition: umlscene.cpp:3838
UMLDoc::setResolution
void setResolution(qreal resolution)
Definition: umldoc.cpp:2016
UMLObject::ot_Folder
@ ot_Folder
Definition: umlobject.h:99
UMLViewList
QList< QPointer< UMLView > > UMLViewList
Definition: umlviewlist.h:14
UMLFolder::m_diagrams
UMLViewList m_diagrams
Definition: folder.h:86
Dialog_Utils::askRenameName
bool askRenameName(WidgetBase::WidgetType type, QString &name)
Definition: dialog_utils.cpp:257
UMLFolder::setFolderFile
void setFolderFile(const QString &fileName)
Definition: folder.cpp:248
UMLFolder::loadFolderFile
bool loadFolderFile(const QString &path)
Definition: folder.cpp:425
UMLApp::document
UMLDoc * document() const
Definition: uml.cpp:1063
UMLFolder::save1
void save1(QXmlStreamWriter &writer)
Definition: folder.cpp:302
umldoc.h
UMLPackage
Non-graphical information for a Package.
Definition: package.h:27
UMLFolder::m_folderFile
QString m_folderFile
Definition: folder.h:85