uiElement.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2007 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: uiElement.h,v $ $Revision: 1.17 $ $State: Exp $
*********************************************************************/


#ifndef DTUIELEMENT_H_
#define DTUIELEMENT_H_

#include "vrfutil/rdrWritr.h"
#include "vrfutil/readerWriterFactory.h"
#include "vrfutil/rwString.h"
#include "entityEditorImpl/rwEquality.h"
#include "vrfutil/rwBoolean.h"
#include "vrfutil/rwInt.h"
#include "drawerNative/conversions.h"
#include "vrfutil/callbackList.h"
#include "entityEditorImpl/entityEditorImplDefines.h"

#include <QtCore/QObject>
#include <QtCore/QVariant>

class QWidget;
class DtUiForParameter;
class DtVrfObjectParameters;
class DtReaderWriterRegistryData;
class DtSystemParameterData;
class DtModelSetEntry;
class DtUiElement;
class QWidget;

typedef DtCallbackList<DtUiElement*>::DtCallbackFunctionType DtElementChangedCallbackFcn;


class DT_DLL_entityeditorimpl DtUiElementEvent
{
public:
   enum DtUiElementEventTypes
   {
      DtUiElementTypeUnknown = 0,
      DtUiElementItemExpand   = 1,
      DtUiElementItemCollapse = 2,
      DtUiElementHierarchySelectionChanged = 3,
      DtUiElementSaveStateChanged = 4,
      DtUiElementAddedToHierarchy = 5,
      DtUiElementRemovedFromHierarchy = 6,
      DtUiElementMovedInHierarchy = 7,
      DtUiElementReplacedInHierarchy = 8,
      DtUiElementForceChanged = 9,
      DtUiElementConfigureDiGuyOn = 10,
      DtUiElementConfigureDiGuyOff = 11,
      DtUiElementPositionModified = 12,
      DtUiElementPositionDestroyed = 13,
      DtUiBoundingVolumeModified = 14,
      DtUiCanvasInitialized = 15,
      DtUiDiGuyDataChanged = 16,
      DtUiRequestDiGuyData = 17,
      DtUiDiGuyDataResponse = 18,
      DtUiCreateController = 19,
      DtUiCleanup = 20,
      DtUiElementHierarchyChanged = 21
   };

public:
   DtUiElementEvent(DtUiElement* owner= 0, DtUiElementEventTypes type = DtUiElementTypeUnknown) : myOwner(owner), myType(type) {};
   DtUiElementEvent(const DtUiElementEvent& orig) : myOwner(orig.myOwner), myType(orig.myType), myValue(orig.myValue) {};

   DtUiElementEvent& operator=(const DtUiElementEvent& rhs) { myOwner = rhs.myOwner; myValue = rhs.myValue; myType = rhs.myType; return *this; };

   DtUiElement* owner() const { return myOwner; };
   DtUiElementEventTypes type() const { return myType; };
   void setType(DtUiElementEventTypes t) { myType = t; };
   void setValue(const QVariant& val) { myValue = val; };
   const QVariant& value() const { return myValue; };

protected:
   DtUiElement*            myOwner;
   QVariant                myValue;
   DtUiElementEventTypes   myType;
};

class DT_DLL_entityeditorimpl DtUiElementSignalHandler : public QObject
{
   Q_OBJECT
      
public:
   DtUiElementSignalHandler() : myParent(NULL) {};

   void setUiElement(DtUiElement* parent) { myParent = parent; };

public slots:
   virtual void elementChanged();

   virtual void sendEvent(const DtUiElementEvent&);

signals:
   void uiEvent(const DtUiElementEvent&);

protected:
   DtUiElement* myParent;
};

class DT_DLL_entityeditorimpl DtUiElement : public DtReaderWriter
{
public:

   DtUiElement
   (
      const DtString& name,
      DtReaderWriterRegistry* const parentRegistry = NULL
   );

   virtual ~DtUiElement();

   DtUiElement(const DtUiElement& orig);

   DtUiElement& operator=(const DtUiElement& orig);

   virtual const DtString& objectName() const;

   virtual void setTitle(const DtString& s);
   virtual void setObjectName(const DtString& s);

   virtual void mergeInto(DtUiForParameter*);
   virtual DtUiElement* elementNamed(const DtString&);

   virtual bool mergeInto(const DtString& readerWriterName, bool after, DtUiElement* element);

   virtual void init();

   virtual DtString sourceReaderWriterName() const;
   virtual void setSourceReaderWriterName(const DtString& name);

   virtual DtString displayUnits() const;
   virtual void setDisplayUnits(const DtString& units);

   virtual DtString sourceUnits() const;
   virtual void setSourceUnits(const DtString& units);

   virtual DtString tooltip() const;
   virtual void setTooltip(const DtString& text);

   virtual void setFromSystemParameterData(const DtSystemParameterData* data);

   virtual void objectParametersModified() {};

   virtual void processUiEvent(const DtUiElementEvent&) {};

   DtReaderWriterRegistryData* value() const;
   DtReaderWriterRegistryData* backupValue() const;

   virtual void initForControls();

   virtual void setModelModified(DtModelSetEntry*);

   DtUiElementSignalHandler* signalHandler() { return &mySignalHandler; };

   virtual void uiState(QMap<QString, QVariant>& state) const;
   virtual void setUiState(const QMap<QString, QVariant>&);

   virtual void sendUpdatedUiState();

public:
   static void registerUiTypes();
   static DtUiElement* createUiElement(const DtString& type, const DtString& name,
      DtReaderWriterRegistry* parentRegistry = NULL);

public:
   virtual DtUiElement* clone() = 0;
   virtual bool isModified() const;

   virtual void decorateElement();

   virtual QWidget* createLabelWidget(QWidget* parent);
   virtual QWidget* createControls(QWidget* parent);
   virtual void setFromParameters(DtReaderWriter* parentRw);
   virtual void elementChanged();

   virtual void addElementChangedCallback(DtElementChangedCallbackFcn f, void* usr);
   virtual void removeElementChangedCallback(DtElementChangedCallbackFcn f, void* usr);
   virtual void removeAllCallbacks();

   virtual DtReaderWriterRegistryData* createBackup(const DtString& backupName);
   virtual bool restoreFromBackup(const DtString& backupName, bool deleteBackup = false);
   virtual void deleteBackup(const DtString& backupName);

   const DtCallbackList<DtUiElement*>& elementChangedCallbackList() const;
   void setElementChangedCallbackList(const DtCallbackList<DtUiElement*>&);

   virtual DtReaderWriterRegistryData* value(DtReaderWriter* parentRw);
   virtual DtReaderWriterRegistryData* value(DtReaderWriter* parentRw, const DtString& rw,
      DtReaderWriterRegistryData** backupValue) const;

   static DtReaderWriterFactory* elementFactory();

   virtual bool centerElement() const;

   virtual void finalizeSize(QWidget*);

protected:
   static DtReaderWriterFactory theFactory;
   virtual QWidget* createDataEntryElement(QWidget*);

   virtual double sourceToDestination(double) const;
   virtual double destinationToSource(double) const;

   virtual QString units() const;

protected:
   DtRwString  myReaderWriterName;
   DtRwString  myTitle;
   DtRwString  myDisplayUnits;
   DtRwString  mySourceUnits;
   DtRwString  myObjectName;
   DtRwString  myTooltip;
   DtRwBoolean myCenterElement;
   DtRwInt myMaximumWidth;
   DtRwInt myMaximumHeight;
   DtRwInt myMinimumWidth;
   DtRwInt myMinimumHeight;
   DtReaderWriterRegistryData*   myValue;
   DtReaderWriterRegistryData*   myBackupValue;
   DtUiElementSignalHandler   mySignalHandler;
   DtRwBoolean mySetVisible;
   bool myIsNew;
   QWidget*     myLabel;
   //DtElementChangedCallbackFcn myElementChangedCallback;
   DtCallbackList<DtUiElement*> myElementChangedCallbackList;
   //void* myUserVariable;
   DtUnit mySource;
   DtUnit myDestination;

   static DtUnitConverterFactory theConversionFactory;
};

inline const DtCallbackList<DtUiElement*>& DtUiElement::elementChangedCallbackList() const
{
   return myElementChangedCallbackList;
}

inline void DtUiElement::setElementChangedCallbackList(const DtCallbackList<DtUiElement*>& lst)
{
   myElementChangedCallbackList = lst;
}

inline DtReaderWriterRegistryData* DtUiElement::value() const
{
   return myValue;
}

inline DtReaderWriterRegistryData* DtUiElement::backupValue() const
{
   return myBackupValue;
}

#endif