umbrello  2.34.3
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-2021 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 saveToXMI(QXmlStreamWriter& writer);
62 
63  friend QDebug operator<<(QDebug out, const UMLFolder& item);
64 
65 protected:
66  void saveContents(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
UMLScene::saveToXMI
virtual void saveToXMI(QXmlStreamWriter &writer)
Definition: umlscene.cpp:3790
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
DEBUG_REGISTER
#define DEBUG_REGISTER(src)
Definition: debug_utils.h:129
UMLDoc::url
const KUrl & url() const
Definition: umldoc.cpp:327
UMLObject::asUMLFolder
UMLFolder * asUMLFolder()
Definition: umlobject.cpp:1429
logDebug1
#define logDebug1(s, a)
Definition: uml.h:539
UMLDoc::datatypeFolder
UMLFolder * datatypeFolder() const
Definition: umldoc.cpp:2974
Settings::GeneralState::tabdiagrams
bool tabdiagrams
Definition: optionstate.h:53
UMLObject::name
QString name() const
Definition: umlobject.cpp:207
umlview.h
UMLDatatype::setActive
void setActive(bool active=true)
Definition: datatype.cpp:68
UMLFolder::folderFile
QString folderFile() const
Definition: folder.cpp:260
UMLDatatype
Non-graphical information for a Datatype.
Definition: datatype.h:20
UMLFolder::setViewOptions
void setViewOptions(const Settings::OptionState &optionState)
Definition: folder.cpp:214
Uml::ID::None
const Type None
special value for uninitialized ID
Definition: basictypes.h:373
Uml::ModelType::Logical
@ Logical
Definition: basictypes.h:28
logError0
#define logError0(s)
Definition: uml.h:537
UMLObject::saveToXMI
virtual void saveToXMI(QXmlStreamWriter &writer)
Definition: umlobject.cpp:840
Uml::DiagramType::Enum
Enum
Definition: basictypes.h:63
object_factory.h
Uml::ID::toString
QString toString(const ID::Type &id)
Definition: basictypes.cpp:1306
logError1
#define logError1(s, a)
Definition: uml.h:543
UMLFolder::saveContents
void saveContents(QXmlStreamWriter &writer)
Definition: folder.cpp:270
UMLFolder::load1
bool load1(QDomElement &element)
Definition: folder.cpp:493
UMLObject::setName
virtual void setName(const QString &strName)
Definition: umlobject.cpp:188
UMLObject::umlPackage
UMLPackage * umlPackage() const
Definition: umlobject.cpp:651
UMLFolder::loadDiagramsFromXMI1
bool loadDiagramsFromXMI1(QDomNode &node)
Definition: folder.cpp:399
UMLFolder::appendViews
void appendViews(UMLViewList &viewList, bool includeNested=true)
Definition: folder.cpp:105
UMLFolder::~UMLFolder
virtual ~UMLFolder()
Definition: folder.cpp:47
UMLFolder::addView
void addView(UMLView *view)
Definition: folder.cpp:86
UMLFolder::showPropertiesDialog
bool showPropertiesDialog(QWidget *parent)
Definition: folder.cpp:599
Model_Utils::getXmiId
QString getXmiId(QDomElement element)
Definition: model_utils.cpp:772
Uml::ID::Type
std::string Type
Definition: basictypes.h:371
Settings::OptionState::generalState
GeneralState generalState
Definition: optionstate.h:322
UMLScene::loadFromXMI
virtual bool loadFromXMI(QDomElement &qElement)
Definition: umlscene.cpp:3864
model_utils.h
UMLObject
The base class for UML objects.
Definition: umlobject.h:69
UMLObject::baseType
ObjectType baseType() const
Definition: umlobject.cpp:393
optionstate.h
UMLFolder::clone
virtual UMLObject * clone() const
Definition: folder.cpp:56
Settings::optionState
OptionState & optionState()
Definition: optionstate.cpp:357
UMLObject::asUMLDatatype
UMLDatatype * asUMLDatatype()
Definition: umlobject.cpp:1423
UMLObject::setStereotypeCmd
void setStereotypeCmd(const QString &_name)
Definition: umlobject.cpp:531
Uml::ID::fromString
ID::Type fromString(const QString &id)
Definition: basictypes.cpp:1311
UMLFolder::findView
UMLView * findView(Uml::ID::Type id)
Definition: folder.cpp:155
Model_Utils::treeViewAddViews
void treeViewAddViews(const UMLViewList &viewList)
Definition: model_utils.cpp:425
operator<<
QDebug operator<<(QDebug out, const UMLFolder &item)
Definition: folder.cpp:613
UMLView
Definition: umlview.h:29
UMLDoc::rootFolder
UMLFolder * rootFolder(Uml::ModelType::Enum mt) const
Definition: umldoc.cpp:3216
UMLDoc::findObjectById
UMLObject * findObjectById(Uml::ID::Type id)
Definition: umldoc.cpp:1051
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:69
UMLObject::fullyQualifiedName
virtual QString fullyQualifiedName(const QString &separator=QString(), bool includeRoot=false) const
Definition: umlobject.cpp:223
logDebug2
#define logDebug2(s, a, b)
Definition: uml.h:545
UMLObject::copyInto
virtual void copyInto(UMLObject *lhs) const
Definition: umlobject.cpp:310
folder.h
i18n
#define i18n
Definition: main.cpp:35
UMLPackage::removeObject
void removeObject(UMLObject *pObject)
Definition: package.cpp:209
Model_Utils::isCommonXMI1Attribute
bool isCommonXMI1Attribute(const QString &tag)
Definition: model_utils.cpp:786
UMLFolder::localName
QString localName() const
Definition: folder.cpp:78
UMLObject::packages
UMLPackageList packages(bool includeRoot=false) const
Definition: umlobject.cpp:602
uDebug
#define uDebug()
Definition: debug_utils.h:117
v
std::vector< std::string > v
Definition: cxx11-initializer-lists.h:19
UMLPackage::m_objects
UMLObjectList m_objects
Definition: package.h:78
logWarn1
#define logWarn1(s, a)
Definition: uml.h:542
UMLObject::doc
QString doc() const
Definition: umlobject.cpp:431
UMLFolder::saveToXMI
void saveToXMI(QXmlStreamWriter &writer)
Definition: folder.cpp:341
UMLApp::app
static UMLApp * app()
Definition: uml.cpp:276
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:37
Uml
Definition: basictypes.cpp:22
UMLPackageList
QList< UMLPackage * > UMLPackageList
Definition: umlpackagelist.h:11
UMLDoc::tagEq
static bool tagEq(const QString &tag, const QString &pattern)
Definition: umldoc.cpp:3603
UMLDoc::addView
void addView(UMLView *view)
Definition: umldoc.cpp:221
UMLFolder::activateViews
void activateViews()
Definition: folder.cpp:126
Uml::ModelType::N_MODELTYPES
@ N_MODELTYPES
Definition: basictypes.h:33
UMLFolder::removeView
void removeView(UMLView *view)
Definition: folder.cpp:94
Settings::OptionState
Definition: optionstate.h:310
UMLFolder::operator<<
friend QDebug operator<<(QDebug out, const UMLFolder &item)
Definition: folder.cpp:613
UMLObject::loadFromXMI
virtual bool loadFromXMI(QDomElement &element)
Definition: umlobject.cpp:1027
UMLPackage::appendPackages
void appendPackages(UMLPackageList &packages, bool includeNested=true) const
Definition: package.cpp:326
umlscene.h
uml.h
UMLObject::setUMLPackage
bool setUMLPackage(UMLPackage *pPkg)
Definition: umlobject.cpp:620
Object_Factory::makeObjectFromXMI
UMLObject * makeObjectFromXMI(const QString &xmiTag, const QString &stereoID)
Definition: object_factory.cpp:380
debug_utils.h
UMLScene::name
QString name() const
Definition: umlscene.cpp:416
UMLDoc::addDiagramToLoad
void addDiagramToLoad(UMLFolder *folder, QDomNode node)
Definition: umldoc.cpp:2555
UMLScene
Definition: umlscene.h:64
UMLDoc::rootFolderType
Uml::ModelType::Enum rootFolderType(UMLObject *obj) const
Definition: umldoc.cpp:3231
UMLView::umlScene
UMLScene * umlScene() const
Definition: umlview.cpp:51
UMLFolder::removeAllViews
void removeAllViews()
Definition: folder.cpp:225
uIgnoreZeroPointer
#define uIgnoreZeroPointer(a)
Definition: debug_utils.h:142
UMLScene::setOptionState
void setOptionState(const Settings::OptionState &options)
Definition: umlscene.cpp:585
dialog_utils.h
package.h
UMLDoc::removeView
void removeView(UMLView *view, bool enforceOneView=true)
Definition: umldoc.cpp:260
UMLDoc::setResolution
void setResolution(qreal resolution)
Definition: umldoc.cpp:2030
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:259
UMLFolder::setFolderFile
void setFolderFile(const QString &fileName)
Definition: folder.cpp:252
UMLFolder::loadFolderFile
bool loadFolderFile(const QString &path)
Definition: folder.cpp:451
UMLApp::document
UMLDoc * document() const
Definition: uml.cpp:1063
UMLFolder::save1
void save1(QXmlStreamWriter &writer)
Definition: folder.cpp:318
UMLScene::activateAfterLoad
void activateAfterLoad(bool bUseLog=false)
Definition: umlscene.cpp:2220
umldoc.h
UMLObject::save1
void save1(QXmlStreamWriter &writer, const QString &type, const QString &tag=QString())
Definition: umlobject.cpp:861
logError2
#define logError2(s, a, b)
Definition: uml.h:549
UMLPackage
Non-graphical information for a Package.
Definition: package.h:27
UMLFolder::m_folderFile
QString m_folderFile
Definition: folder.h:85