umlfolder.h

Go to the documentation of this file.

/*
    SPDX-License-Identifier: GPL-2.0-or-later
    SPDX-FileCopyrightText: 2006-2021 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
*/
 
#ifndef UMLFOLDER_H
#define UMLFOLDER_H
 
#include "umlpackage.h"
#include "umlviewlist.h"
#include "optionstate.h"

class UMLFolder : public UMLPackage
{
    Q_OBJECT
public:
    explicit UMLFolder(const QString & name = QString(), Uml::ID::Type id = Uml::ID::None);
    virtual ~UMLFolder();
 
    virtual UMLObject* clone() const;
 
    void setLocalName(const QString& localName);
    QString localName() const;
 
    void addView(UMLView *view);
 
    void removeView(UMLView *view);
 
    void appendViews(UMLViewList& viewList, bool includeNested = true);
 
    void activateViews();
 
    UMLView* findView(Uml::ID::Type id);
    UMLView* findView(Uml::DiagramType::Enum type, const QString &name, bool searchAllScopes = true);
 
    void setViewOptions(const Settings::OptionState& optionState);
 
    void removeAllViews();
 
    void setFolderFile(const QString& fileName);
    QString folderFile() const;
 
    bool showPropertiesDialog(QWidget *parent);
 
    void saveToXMI(QXmlStreamWriter& writer);
 
    friend QDebug operator<<(QDebug out, const UMLFolder& item);
 
protected:
    void saveContents(QXmlStreamWriter& writer);
 
    void save1(QXmlStreamWriter& writer);
 
    bool loadDiagramsFromXMI1(QDomNode& node);
 
    bool loadFolderFile(const QString& path);
 
    bool load1(QDomElement & element);
 
private:
    QString m_localName;  
    QString m_folderFile;
    UMLViewList m_diagrams;
 
    friend class UMLDoc;
};
 
#endif