umlpackage.h

Go to the documentation of this file.

/*
    SPDX-License-Identifier: GPL-2.0-or-later
    SPDX-FileCopyrightText: 2003-2021 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
*/

#ifndef PACKAGE_H
#define PACKAGE_H

#include "umlcanvasobject.h"
#include "umlclassifierlist.h"
#include "umlentitylist.h"

// forward declarations
class UMLAssociation;

class UMLPackage : public UMLCanvasObject
{
    Q_OBJECT
public:
    explicit UMLPackage(const QString & name = QString(), Uml::ID::Type id = Uml::ID::None);
    virtual ~UMLPackage();

    virtual void copyInto(UMLObject *lhs) const;

    virtual UMLObject* clone() const;

    bool addObject(UMLObject *pObject, bool interactOnConflict = true);
    virtual void removeObject(UMLObject *pObject);

    virtual void removeAllObjects();

    UMLObjectList containedObjects(bool includeInactive = false) const;

    void addAssocToConcepts(UMLAssociation* assoc);
    void removeAssocFromConcepts(UMLAssociation *assoc);

    UMLObject * findObject(const QString &name) const;
    UMLObject * findObjectById(Uml::ID::Type id) const;

    void appendPackages(UMLPackageList& packages, bool includeNested = true) const;
    void appendClassifiers(UMLClassifierList& classifiers,
                            bool includeNested = true) const;
    void appendClassesAndInterfaces(UMLClassifierList& classifiers,
                                    bool includeNested = true) const;
    void appendEntities(UMLEntityList& entities,
                        bool includeNested = true) const;

    virtual bool resolveRef();

    virtual void saveToXMI(QXmlStreamWriter& writer);

protected:
    virtual bool load1(QDomElement& element);

    UMLObjectList m_objects;

};

#endif