umbrello: umbrello/umlmodel/folder.h Source File

umbrello 25.08.0 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
32public:
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
49 UMLView* findView(Uml::ID::Type id);
50 UMLView* findView(Uml::DiagramType::Enum type, const QString &name, bool searchAllScopes = true);
51
52 void setViewOptions(const Settings::OptionState& optionState);
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
65protected:
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
76private:
77 QString m_localName;
85 QString m_folderFile;
86 UMLViewList m_diagrams;
87
88 friend class UMLDoc;
89};
90
91#endif
Settings::OptionState
Definition optionstate.h:309
UMLFolder::setLocalName
void setLocalName(const QString &localName)
Definition folder.cpp:69
UMLFolder::operator<<
friend QDebug operator<<(QDebug out, const UMLFolder &item)
Definition folder.cpp:605
UMLFolder::setFolderFile
void setFolderFile(const QString &fileName)
Definition folder.cpp:252
UMLFolder::appendViews
void appendViews(UMLViewList &viewList, bool includeNested=true)
Definition folder.cpp:105
UMLFolder::m_diagrams
UMLViewList m_diagrams
Definition folder.h:86
UMLFolder::addView
void addView(UMLView *view)
Definition folder.cpp:86
UMLFolder::loadDiagramsFromXMI1
bool loadDiagramsFromXMI1(QDomNode &node)
Definition folder.cpp:395
UMLFolder::load1
bool load1(QDomElement &element)
Definition folder.cpp:489
UMLFolder::folderFile
QString folderFile() const
Definition folder.cpp:260
UMLFolder::activateViews
void activateViews()
Definition folder.cpp:126
UMLFolder::findView
UMLView * findView(Uml::ID::Type id)
Definition folder.cpp:155
UMLFolder::removeAllViews
void removeAllViews()
Definition folder.cpp:225
UMLFolder::loadFolderFile
bool loadFolderFile(const QString &path)
Definition folder.cpp:447
UMLFolder::m_folderFile
QString m_folderFile
Definition folder.h:85
UMLFolder::UMLDoc
friend class UMLDoc
Definition folder.h:88
UMLFolder::clone
virtual UMLObject * clone() const
Definition folder.cpp:56
UMLFolder::UMLFolder
UMLFolder(const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
Definition folder.cpp:37
UMLFolder::saveToXMI
void saveToXMI(QXmlStreamWriter &writer)
Definition folder.cpp:341
UMLFolder::showPropertiesDialog
bool showPropertiesDialog(QWidget *parent)
Definition folder.cpp:591
UMLFolder::setViewOptions
void setViewOptions(const Settings::OptionState &optionState)
Definition folder.cpp:214
UMLFolder::removeView
void removeView(UMLView *view)
Definition folder.cpp:94
UMLFolder::~UMLFolder
virtual ~UMLFolder()
Definition folder.cpp:47
UMLFolder::m_localName
QString m_localName
i18n name, only used for predefined root folders
Definition folder.h:77
UMLFolder::saveContents
void saveContents(QXmlStreamWriter &writer)
Definition folder.cpp:270
UMLFolder::save1
void save1(QXmlStreamWriter &writer)
Definition folder.cpp:318
UMLFolder::localName
QString localName() const
Definition folder.cpp:78
UMLObject::UMLObject
UMLObject(const UMLObject &other)
Definition umlobject.cpp:44
UMLObject::name
QString name() const
Definition umlobject.cpp:207
UMLPackage::UMLPackage
UMLPackage(const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
Definition package.cpp:38
UMLView
Definition umlview.h:30
Uml::DiagramType::Enum
Enum
Definition basictypes.h:63
Uml::ID::None
const Type None
special value for uninitialized ID
Definition basictypes.h:373
Uml::ID::Type
std::string Type
Definition basictypes.h:371
optionstate.h
package.h
umlviewlist.h
UMLViewList
QList< QPointer< UMLView > > UMLViewList
Definition umlviewlist.h:16