GraphicItemBase.h

////////////////////////////////////////////////////////////////////////
// Copyright 2009-2018 NTESS. Under the terms
// of Contract DE-NA0003525 with NTESS, the U.S.
// Government retains certain rights in this software.
//
// Copyright (c) 2009-2018, NTESS
// All rights reserved.
//
// Portions are copyright of other developers:
// See the file CONTRIBUTORS.TXT in the top level directory
// the distribution for more information.
//
// This file is part of the SST software package. For license
// information, see the LICENSE file in the top level directory of the
// distribution.
////////////////////////////////////////////////////////////////////////

#ifndef GRAPHICITEMBASE_H
#define GRAPHICITEMBASE_H

#include "GlobalIncludes.h"

// Forward declarations to allow compile
class ItemProperties;

////////////////////////////////////////////////////////////

class GraphicItemBase
{
public:
    // Enumeration for Identifying the item type (NOTE: ITEMTYPE_END MUST ALWAYS BE LAST)
    enum ItemType { ITEMTYPE_UNDEFINED, ITEMTYPE_COMPONENT, ITEMTYPE_PORT, ITEMTYPE_TEXT, ITEMTYPE_WIRE, ITEMTYPE_WIREHANDLE, ITEMTYPE_WIRELINESEGMENT, ITEMTYPE_END };

    // Constructor / Destructor
    GraphicItemBase(const ItemType itemType);
    virtual ~GraphicItemBase();

    // Return the Item Type
    ItemType GetItemType() const {return m_ItemType;}

    // Return the Item Properties
    ItemProperties* GetItemProperties() {return m_Properties;}

    // Properties Callback: Derived class should implement this function
    // if it wants to receive notification of changes to a property
    virtual void PropertyChanged(QString& PropName, QString& NewPropValue);

    // Properties Callback: Derived class should implement this function
    // if it wants to be notified that dynamic properties have changed and should
    // be refreshed
    virtual void DynamicPropertiesChanged(ItemProperties* ptrExistingProperties);

    // Required Virtual Function to save Item Data
    virtual void SaveData(QDataStream& DataStreamOut) = 0;

protected:
    // Override this items properties with properties from somewhere else
    void SetExistingPropertiesStructure(ItemProperties* ptrExistingProperties);

private:
    // Functions to handle creation/ deletions of Properties structure
    void CreatePropertiesStructure();
    void DeletePropertiesStructure();

private:
    ItemType         m_ItemType;
    ItemProperties*  m_Properties;
};

#endif // GRAPHICITEMBASE_H