property.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2015 VT MAK
 * All rights reserved.
 ****************************************************************************/

// \file property.h
// \brief Contains the DtProperty class declaration.

#pragma once

#include <widgets/dllExport.h>
#include <widgets/propertyType.h>
#include <widgets/property.h>

#include <QtCore/QVariant>
#include <QtCore/QString>

#include <memory>
#include <list>

namespace MAKVrExchange
{

   class DtProperty;
   class DtPropertyType;
   typedef std::auto_ptr<DtPropertyType> DtPropertyTypeAP;
   typedef std::list<DtProperty> DtPropertyList;

   class DT_DLL_WIDGETS DtProperty
   {
   public:

      // Default constructor Construct a property of a  name and type.
      DtProperty( QString name, DtPropertyTypeAP type, QVariant value );

      DtProperty( const DtProperty& );

      // Default constructor, used by list, do NOT USE. Internal values are
      // invalid.
      DtProperty();

      // DTOR
      ~DtProperty();

      // bool operator== (const DtProperty&);
      DtProperty& operator = ( const DtProperty& );
      virtual bool operator < ( const DtProperty& ) const;

      DtProperty& appendChild( const DtProperty& child );
      void removeChild( QString name );

      DtProperty* findChild( QString name );
      const DtProperty* findChild( QString name ) const;

      // Accessors
      const DtPropertyType* type() const;
      QString name() const;
      QVariant value() const;

      // This provides a simple means of identifying a property and provides a hook
      // to associate this property with some other object. Helps alleviate problems
      // of objects with duplicate names. Id of -1 is defualt--ie it's unassigned.
      int id() const;

      // Is read only if myReadOnly is true OR parent is readOnly.
      // If no parent then use only myReadOnly.
      bool readOnly() const;

      DtPropertyList* children();
      const DtPropertyList* children() const;

      // Mutators
      void setId( int id );
      void setValue( QVariant value );
      void setReadOnly( bool readOnly );

   protected:

      QString          myName;
      QVariant         myValue;
      DtPropertyTypeAP myType;
      int              myId;
      DtPropertyList*  myChildren;
      DtProperty*      myParent;
      bool             myReadOnly;

   };

}