aObject.h

Go to the documentation of this file.

/*
 *  File:       aObject.h
 *  Package:    akCore
 *
 *  Created on: July 26, 2020
 *  Author: Alexander Kuester
 *  Copyright (c) 2022 Alexander Kuester
 *  This file is part of the uiCore component.
 *  This file is subject to the terms and conditions defined in
 *  file 'LICENSE', which is part of this source code package.
 */
 
#pragma once
 
// AK header
#include <akCore/globalDataTypes.h>
#include <akCore/akCore.h>
 
// Qt header
#include <qstring.h>                // QString
 
// C++ header
#include <map>
 
#define A_OBJECT_DESTROYING_WITHOWNER if (m_owner != nullptr) { ak::aObject * obj = m_owner->parentObject(); if (obj != nullptr) { obj->removeChildObject(m_owner); } }
#define A_OBJECT_DESTROYING_WITHPARENT if (m_parentObject != nullptr) { m_parentObject->removeChildObject(this); m_parentObject = nullptr; }
#define A_OBJECT_DESTROYING A_OBJECT_DESTROYING_WITHOWNER else A_OBJECT_DESTROYING_WITHPARENT
 
namespace ak {
 
    class UICORE_API_EXPORT aObject {
    public:
 
        aObject(
            objectType              _type = otNone,
            UID                     _UID = ak::invalidUID
            //int                                       _references = 1
        );
 
        aObject(
            const aObject &         _other
        );
 
        aObject & operator = (
            const aObject &                 _other
            );
 
        virtual ~aObject();
 
        // ################################################################################
 
        virtual void removeChildObject(
            aObject *                               _child
        );
 
        virtual void addChildObject(
            aObject *                               _child
        );
 
        void setUniqueName(
            const QString &                         _name
        ) { m_uniqueName = _name; }
 
        virtual void setParentObject(
            aObject *                               _parentObject
        );
 
        // ################################################################################
 
        QString uniqueName(void) const { return m_uniqueName; }
 
        aObject * parentObject(void) const;
 
        int childObjectCount(void) const;
 
        aObject * childObject(
            UID                                 _childUID
        );
 
        void setOwner(
            aObject *                               _object
        );
 
        aObject * owner(void) const;
 
        // ################################################################################
 
        void setUid(
            UID                                 _UID
        );
 
        UID uid(void) const;
 
        objectType type(void) const;
 
        virtual bool isWidgetType(void) const;
 
    protected:
        UID                         m_uid;              
        int                         m_references;       
        objectType                  m_objectType;       
        QString                     m_uniqueName;
        aObject *                   m_parentObject;
        aObject *                   m_owner;
        std::map<UID, aObject *>    m_childObjects;
    };
}