planTreeWidget.h

Go to the documentation of this file.

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


#pragma once

#include <vrvUtil/signalslib.h>
#include <vrfGuiCoreQt/vrfGuiCoreQt.h>
#include <vrfGuiCoreQt/treeWidget.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrfutil/rwUUID.h>

#include <QtWidgets/QTreeWidget>
#include <QtWidgets/QHeaderView>


class QMenu;
class QAction;
class QTreeWidget;
class DtPlan;
class DtStmtIndex;
class DtSimBlock;
class DtSimStatement;
class DtRwTriggersList;

namespace makVrv
{
   class DtDe;
}

#define planPasteType "text/x-myPlanText@Type"
#define planTopLevelPasteType "text/x-myPlanText@TopType"

namespace makVrf
{
   class DtPlanListBoxItem;

   class DT_DLL_VRFGUICOREQT DtPlanTreeWidget : public DtTreeWidget
   {
      Q_OBJECT

   public:

      DtPlanTreeWidget(makVrv::DtDe&, QWidget* parent = NULL);

      virtual ~DtPlanTreeWidget();

      virtual DtPlanListBoxItem* currentItem() const;

      virtual bool hasItem(const DtPlanListBoxItem*);

      virtual void print();

      virtual void setName(const DtUUID&);
      const DtUUID& name() const;

      virtual void displayPlan(bool andSelectStatement = true);

      virtual void setIsGlobalPlan(bool);

      virtual void clearAllStatements();

      virtual void copySelectedPlanStatementToClipboard();

      virtual void copyPlanToClipboard();

      virtual void addStatementsToPlan(const std::vector<DtSimStatement*>&, bool append, bool redisplay = true);

      virtual void addStatementAfter(DtSimStatement* stmt,
         const DtPlanListBoxItem* listItem = 0, bool redisplay = true);

      virtual void replaceStatement(DtSimStatement* stmt, DtPlanListBoxItem* item);

      virtual bool deleteStatement(const DtPlanListBoxItem*);

      virtual bool isBeingDragged(QTreeWidgetItem*) const;

      virtual void setPlan(DtPlan*);
      virtual DtPlan* plan() { return getOrCreatePlan(); };
      virtual const DtPlan* plan() const { return myPlan; };

      virtual DtPlan* getOrCreatePlan();

      virtual void setCanDropOn(int, bool);
      virtual bool canDropOn(int) const;
      virtual bool canDropOn(QTreeWidgetItem*) const;
      virtual bool canDropOnCurrentItem() const;

      bool clearing() const { return myClearing; };

      virtual DtSimStatement* selectStatement(int, bool andMakeCurrent = false);

      virtual DtPlanListBoxItem* findItemByIndex(int statementIndex, int subBlock = 0);

      virtual void setIsComplete(bool);

      virtual void addPlanMimeDataAfter(const QMimeData*, DtPlanListBoxItem*, bool redisplay = true);

      virtual DtPlanListBoxItem* findLastItemByIndex(int statementIndex, int subBlock = 0);

      virtual void setPlanTitle(const QString&);
      virtual const QString& planTitle() const;

      virtual bool planIsModified() const;
      virtual void clearPlanIsModified();
      virtual void markPlanIsModified();

      boost::signal<void (bool)> signal_planIsModified;
      boost::signal<void ()> signal_addedTriggers;

      virtual DtSimStatement* selectedBlockStatement() const;

      virtual DtSimStatement* selectedStatement() const;
      
      virtual DtSimStatement* displayBlockStatement() const;

      virtual void setShowRightClickMenu(bool);
      bool showRightClickMenu() const { return myShowRightClickMenu; };

      virtual QString planDescriptiveName() const;

      virtual void removeTrigger(const DtUUID&);

      virtual void renameTrigger(const DtUUID& uuid, const DtString& newName);

      virtual void unusedTriggers(DtRwTriggersList&) const;
      virtual DtPlanListBoxItem* createPlanListBoxItem(DtSimBlock*, const QString& name, int step = -1);
      virtual DtPlanListBoxItem* createPlanListBoxItem(DtSimBlock*, const DtPlanListBoxItem* parentItem,
         const DtStmtIndex&, const QString& indent, int step = -1);

      bool dragDraw() const { return myDragDraw; };

      virtual void selectLastStatement();

      virtual int currentCursor();

      int currentStatementIndex() const { return myCurrentStatementIndex; };

      virtual void selectCursor(int);

   protected:

      virtual void initializeRightClickMenu();

      virtual void resizeEvent(QResizeEvent*);

      virtual DtPlanListBoxItem* displayStatement(DtSimBlock* block, const DtStmtIndex& stmt, const DtPlanListBoxItem* parentItem, int& step);
      virtual void displayBlock(DtSimBlock* block, const DtPlanListBoxItem* parentItem, int& step);
      virtual QMimeData* mimeData(const QList<QTreeWidgetItem*> list) const;
      virtual void dragEnterEvent(QDragEnterEvent* event);
      virtual void dragMoveEvent(QDragMoveEvent* event);
      virtual bool dropMimeData(QTreeWidgetItem* parent, int index, const QMimeData* mimeData, Qt::DropAction action);
      virtual void dropEvent(QDropEvent *event);
      virtual void dragLeaveEvent(QDragLeaveEvent*);

      virtual void reissueStatementIds(DtSimStatement* stmt);

      virtual void removeLastDraggedItems();

      virtual void startDrag(Qt::DropActions supportedActions);
      virtual bool eventFilter(QObject* o, QEvent*);

      virtual void setPlanIsModified(bool);

      virtual void itemRightClickedOn(QTreeWidgetItem*, QMouseEvent*, int col);

      virtual void addTriggersFromBlock(DtSimBlock*, DtRwTriggersList&, std::set<DtUUID>& visited) const;
      virtual void addTriggersFromStatement(DtSimStatement*, DtRwTriggersList&, std::set<DtUUID>& visited) const;
      virtual void unusedTriggers(DtSimBlock*, DtRwTriggersList&, std::set<DtUUID>& visited) const;

   signals:
      void editCurrentlySelectedPlanStatement();
      void deleteCurrentlySelectedPlanStatement();
      void copyCurrentlySelectedPlanStatement();
      void pastePlanStatement();
      void planRightClickMenuCreated(QMenu*);
      void rightClickToBeShown();
      void editCurrentlySelectedTrigger();

   public:
      QMenu* myRightClickMenu;
      QAction* myEditAction;
      QAction* myEditTriggerAction;
      QAction* myDeleteAction;
      QAction* myCopyAction;
      QAction* myPasteAction;

   protected:
      bool myIsGlobalPlan;
      DtUUID myName;
      DtPlan* myPlan;
      int myCurrentStatementIndex;
      QList<QTreeWidgetItem*> myLastDraggedItems;
      DtPlanListBoxItem* myDraggingOver;
      bool myPlanIsModified;
      bool myShowRightClickMenu;

      bool myFirstShow;
      QString myPlanTitle;
      
      bool myDragDraw;
      bool myClearing;
      int myProposedAction;

   private:
      DtPlanTreeWidget(const DtPlanTreeWidget& orig);

      DtPlanTreeWidget& operator=(const DtPlanTreeWidget& rhs);
   };

   class DT_DLL_VRFGUICOREQT DtPlanTreeWidgetCreator : public makVrv::DtVirtualBaseClass
   {
   public:
      DtPlanTreeWidgetCreator(makVrv::DtDe&);

      virtual ~DtPlanTreeWidgetCreator();

      static DtPlanTreeWidgetCreator& instance(makVrv::DtDe&);

      static void registerInstance(makVrv::DtDe&, DtPlanTreeWidgetCreator*);

      virtual DtPlanTreeWidget* create( QWidget* parent);

   protected:
      makVrv::DtDe& myDe;
   };
}