propertyItem.h

Go to the documentation of this file.

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

#pragma once

#include <vrvUtil/signalslib.h>

#include <QtWidgets/QTreeWidget>
#include <QtWidgets/QLineEdit>
#include <QtGui/QKeyEvent>

class DtReaderWriter;
class DtPropertySheet;
class QPushButton;
class DtPropertyItem;
class QHBoxLayout;
class DtPropertyCreationFactory;
class DtPropertyCreationDialog;

namespace makVrv
{
   class DtDe;
}

class DtPropertyInternalLineEdit : public QLineEdit
{
public:
   DtPropertyInternalLineEdit(QWidget* parent) : QLineEdit(parent) {};
   virtual void keyPressEvent(QKeyEvent* e)
   {
      QLineEdit::keyPressEvent(e);
      
      if ((e->key() == Qt::Key_Enter) || (e->key() == Qt::Key_Return))
      {
         e->accept();
         clearFocus();
      }
   };
};

class DtPropertyItem : public QObject, public QTreeWidgetItem
{
   Q_OBJECT

public:
   DtPropertyItem(makVrv::DtDe&, DtPropertySheet*, const QString& title, DtReaderWriter* var,
      DtReaderWriter* backup);
   DtPropertyItem(makVrv::DtDe&, DtPropertyItem*, DtPropertySheet*, const QString& title,
      DtReaderWriter* var = NULL, DtReaderWriter* backup = NULL);

   virtual ~DtPropertyItem();

   virtual void showEditor();
   virtual void hideEditor();
   virtual bool hasSubItems() const;

   virtual int numParents() const;

   virtual void init();

   DtPropertySheet*  propertySheet();

   void setReaderWriterVariable(DtReaderWriter*);
   DtReaderWriter* readerWriterVariable();

   void setReaderWriterBackup(DtReaderWriter*);
   DtReaderWriter* readerWriterBackup();

   virtual void setUserData(void*);
   void* userData() const;

   void setKeyword(const QString&);
   const QString& keyword() const;

   virtual void savedOpdFile();
   virtual bool isChanged() const;
   virtual bool isNew() const { return myIsNew; };
   virtual void setNew(bool b) { myIsNew = b; };
   virtual bool isDeleted() const;
   virtual bool canRestore() const;

   virtual void setReadOnly(bool);

   // Sets this item and all children read only
   virtual void setRecursiveReadOnly(bool);
   virtual bool readOnly() const;

   // By default, false
   virtual bool canCreateItem() const;
   virtual bool canDeleteItem() const;
   virtual bool canMakeVariable() const;
   virtual bool handlesDelete() const;

   // Must set in order to add items
   static void setPropertyCreationFactory(DtPropertyCreationFactory*);
   static DtPropertyCreationFactory* propertyCreationFactory();

   virtual QVariant data(int column, int role) const;
   virtual QVariant data() const;

   virtual QString dialogType() const;

   virtual void deleteItem(DtPropertyItem*);

   void setCanDeleteItem(bool b) { myCanDeleteItem = b; };

   // Base class simply calls restore
   virtual void internalRestore();
   virtual DtPropertyItem* itemWithReaderWriterVariable(DtReaderWriter*);
   virtual DtPropertyItem* itemWithName(const QString& name);

   void repaint() { setData(0, 1000, "repaint"); };

   virtual void setAttachedTo(DtReaderWriter*);
   DtReaderWriter* attachedTo();

public slots:
   virtual void restore();
   virtual void updateValue();
   virtual void addItem(bool createPropertyEntry = true);

   // Emits removeItem signal
   virtual void deleteItem();

   // Called when a dialog signals that a new item is to be created
   virtual void addNewPropertyItem(DtPropertyCreationDialog*);

   // Repaints immediate children of this item
   virtual void repaintChildren();

   virtual bool isVariable() const;

protected slots:
   virtual void changeVariableStatus();
   virtual void updateVariable();

protected:
   virtual void placeEditor(QWidget *w);
   virtual void updateResetButtonState();
   virtual void setFocus(QWidget *w);

   // Calls createResetButton(), createAddButton(), createDeleteButton()
   virtual void createButtons();

   virtual void createVariableButton();
   virtual void createResetButton();
   virtual void createAddButton();
   virtual void createDeleteButton();
   virtual bool hasDeletedItems() const;
   virtual bool hasNewItems() const;

   virtual void setupValue();
   virtual void setupLayout();
   virtual int buttonWidths() const;
   virtual void setupVariable();

   // Walk the parent tree to tell parents child has been notified
   virtual void notifyValueUpdated(DtPropertyItem* itemUpdated);

   virtual QString addToolTip() const;

   virtual void deleteChildItem(DtPropertyItem*);
   virtual void addChildItem(DtPropertyItem*);

protected:
   makVrv::DtDe& myDe;
   DtReaderWriter* myReaderWriterVariable;
   DtReaderWriter* myReaderWriterBackup;
   DtReaderWriter* myAttachedTo;

   DtPropertySheet*  myPropertySheet;
   QPushButton* myResetButton;
   QPushButton* myAddButton;
   QPushButton* myDeleteButton;
   QPushButton* myVariableButton;
   bool  myDeleteRwValue;
   bool myIsNew;

   QFrame*        myButtonBox;
   void*          myUserData;
   QString        myKeyword;
   QLineEdit*     myVariableEdit;

   bool  myReadOnly;
   bool  myCanDeleteItem;

   static DtPropertyCreationFactory*   thePropertyCreationFactory;
};

typedef DtPropertyItem* (*DtPICreator)(makVrv::DtDe&, DtPropertySheet*, DtPropertyItem*, const QString&,
   DtReaderWriter* p, DtReaderWriter* b);

inline DtPropertySheet* DtPropertyItem::propertySheet()
{
   return myPropertySheet;
}

inline DtReaderWriter* DtPropertyItem::readerWriterVariable()
{
   return myReaderWriterVariable;
}

inline void DtPropertyItem::setReaderWriterVariable(DtReaderWriter* p)
{
   myReaderWriterVariable = p;
}

inline DtReaderWriter* DtPropertyItem::readerWriterBackup()
{
   return myReaderWriterBackup;
}

inline void DtPropertyItem::setReaderWriterBackup(DtReaderWriter* p)
{
   myReaderWriterBackup = p;
}

inline void* DtPropertyItem::userData() const
{
   return myUserData;
}

inline void DtPropertyItem::setKeyword(const QString& k)
{
   myKeyword = k;
}

inline const QString& DtPropertyItem::keyword() const
{
   return myKeyword;
}

inline DtReaderWriter* DtPropertyItem::attachedTo()
{
   return myAttachedTo;
}