opdParameterPropertySheet.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2013 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include <vrvUtil/signalslib.h>

#include "propertySheet.h"
#include <vlutil/vlString.h>
#include <vlpi/entityType.h>
#include <map>

class DtReaderWriter;
class DtVrfObjectParameters;
class DtReaderWriterClassMemberDataRecord;

class DtOpdParameterPropertySheet : public DtPropertySheet
{
   Q_OBJECT

public:
   DtOpdParameterPropertySheet(makVrv::DtDe&, QWidget* parent = NULL);
   virtual ~DtOpdParameterPropertySheet();

   void setObjectParameters(DtVrfObjectParameters*);
   DtVrfObjectParameters* objectParameters();

   // Looks up the closest parameter documentation for the given item.  Assumes
   // that item has a DtReaderWriter object associated with it.  If it cannot
   // find an entry for the given item, it recursively looks up the tree for
   // the closest DtReaderWriter parent object that has documentation.
   virtual bool lookupParameterDocumentation(DtPropertyItem* item,
      DtReaderWriterClassMemberDataRecord& rwClassMemberDataRec) const;

   // Update parameter reference display widget with documentation associated
   // with selected item.
   virtual void updateParameterReferenceDisplay(DtPropertyItem* item);

   void setReadOnly(bool b) { myReadOnly = b; };

   // So there may be instances where you need to inspect the entity type for a platform file but that's no
   // longer stored here, it's in the .entity file. So here's a generic mapping for parameter types
   // to the most basic entity type that describe the type. For example, ground params will map to 1:1:-1:-1:-1:-1:-1
   virtual const DtEntityType& getEntityTypeFromParamType(const DtString& paramType);
   virtual void addEntityTypeParamMapping(const DtString& paramType, const DtEntityType& type);

protected:
   virtual void valueUpdated(DtPropertyItem*);
   virtual void valueRestored(DtPropertyItem*);
   virtual void valueAdded(DtPropertyItem* newItem, DtPropertyItem* parent, DtPropertyCreationDialog*, bool isNew = false);
   virtual void addListVariable(DtReaderWriter* p, const char* var);
   virtual void addBooleanVariable(DtReaderWriter* p, const char* var);

   // Returns the class type of the DtReaderWriter that contains the given
   // item.  Assumes that item has a DtReaderWriter object associated with it.
   // Returns empty string if parent cannot be found.
   virtual DtString lookupParentRwType(DtPropertyItem* item) const;

public slots:

   // Override to handle context-senstive help
   virtual void selectionChanged(const QItemSelection&, const QItemSelection&);

signals:
   void opdParameterModified(DtVrfObjectParameters*);

protected:
   DtVrfObjectParameters* myObjectParameters;
   bool myReadOnly;
   std::map<DtString,DtEntityType> myParamToEntityTypeMap;
};

inline DtVrfObjectParameters* DtOpdParameterPropertySheet::objectParameters()
{
   return myObjectParameters;
}