treeWidget.h

Go to the documentation of this file.

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


#pragma once


#include <vrfGuiCommonQt/vrfGuiCommonQt.h>
#include <vrvUtil/DtVirtualBaseClass.h>

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

#include <vlutil/vlPerformanceStats.h>

class QMimeData;

namespace makVrv
{
   class DtDe;
}

namespace makVrf
{
   static const int DtUserRoleForDoubleClickEdit = Qt::UserRole + 100;

   class DT_DLL_VRFGUICOMMONQT DtTreeWidget : public QTreeWidget
   {
      Q_OBJECT

   public:
      DtTreeWidget(makVrv::DtDe& de, QWidget* parent);

      virtual ~DtTreeWidget();

      virtual QTreeWidgetItem* lastItem() const;

      QTreeWidgetItem* itemFromIndex(const QModelIndex& idx) { return QTreeWidget::itemFromIndex(idx); };

      QModelIndex indexFromItem(QTreeWidgetItem *item, int column = 0) const
      {
         return QTreeWidget::indexFromItem(item, column);
      }

      virtual void setMinimumSizeHint(const QSize&);
      virtual QSize minimumSizeHint() const;

      virtual void setSizeHint(const QSize& s) { mySizeHint = s; };

      virtual int indexOfChild(QTreeWidgetItem*) const;

      unsigned int depth(QTreeWidgetItem*) const;

      QTreeWidgetItem* nextSibling(QTreeWidgetItem*) const;

      void setAllowEmptySelection(bool);

      bool allowEmptySelection() const;

      virtual bool edit(const QModelIndex &index, EditTrigger trigger, QEvent *event);
      virtual void closeEditor(QWidget *editor, QAbstractItemDelegate::EndEditHint hint);

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

      virtual void mousePressEvent(QMouseEvent *event);

      virtual void mouseDoubleClickEvent(QMouseEvent *event);

      virtual void mouseReleaseEvent(QMouseEvent *event);

      virtual void itemLeftClickedOn(QTreeWidgetItem*, QMouseEvent*, int);

      virtual  bool editingCanceled() const { return myEditingCanceled; };

      virtual void setAllowWindowsStyleNameEdit(bool);
      bool allowWindowsStyleNameEdit() const
      {
         return myAllowWindowsStyleNameEdit;
      }

      virtual void setDisableNameEditIfNotWindowsStyleEdit(bool);
      bool disableNameEditIfNotWindowsStyleEnabled() const
      {
         return myDisableNameEditIfNotWindowsStyleEnabled;
      }

      virtual void setEditPressTime(double);
      double editPressTime() const
      {
         return  myEditPressTime;
      }

      QItemSelectionModel::SelectionFlags lastSelectionCommand() const
      {
         return myLastSelectionCommand;
      }

      bool lastSelectHadControlKeyDown() const
      {
         return myLastSelectHadControlKeyDown;
      }

   signals:

      void mouseLeftPressed(QTreeWidgetItem*, QMouseEvent*, int col);

      void rightClickOnItem(QTreeWidgetItem*, QMouseEvent*, int col);

      void contentsMoving(int, int);

   protected slots:
      virtual void checkForEdit();

   protected:

      virtual void scrollContentsBy(int, int);

      virtual QSize sizeHint() const;

      virtual QItemSelectionModel::SelectionFlags selectionCommand(const QModelIndex &index,
                                                                    const QEvent *event = 0) const;

      virtual QItemSelectionModel::SelectionFlags selectionBehaviorFlags() const;

   protected:

      bool myMouseRightClick;
      bool myAllowEmptySelection;
      bool myAllowWindowsStyleNameEdit;
      double myEditPressTime;
      makVrv::DtDe& myDe;
      bool myEditingCanceled;
      QSize myMinimumSizeHint;
      QSize mySizeHint;
      bool myNextReleaseMightBeEdit;
      QTreeWidgetItem* myCheckForEditAfterTimer;
      bool myLastEditEventWasDoubleClick;
      bool myDisableNameEditIfNotWindowsStyleEnabled;
      mutable QItemSelectionModel::SelectionFlags myLastSelectionCommand;
      mutable bool myLastSelectHadControlKeyDown;
   };

   inline void DtTreeWidget::setAllowEmptySelection(bool b)
   {
      myAllowEmptySelection = b;
   }

   inline bool DtTreeWidget::allowEmptySelection() const
   {
      return myAllowEmptySelection;
   }

   class DT_DLL_VRFGUICOMMONQT DtThemedTreeWidgetItem : public QTreeWidgetItem
   {
   public:
      DtThemedTreeWidgetItem(makVrv::DtDe& de, QTreeWidget* t = nullptr);
      DtThemedTreeWidgetItem(makVrv::DtDe& de, QTreeWidgetItem* t);

      virtual void manageIcon(int column, const std::string&, const QSize& size = QSize());
      virtual void unmanageIcon(int column);
      virtual void unmanageAllIcons();

      virtual QVariant data(int col, int role) const override;

   protected:
      std::map<int, std::pair<std::string, QSize> > myManagedIcons;
      makVrv::DtDe& myDe;
   };

   class DT_DLL_VRFGUICOMMONQT DtThemedTreeWidgetItemCreator : public makVrv::DtVirtualBaseClass
   {
   public:
      DtThemedTreeWidgetItemCreator(makVrv::DtDe&);

      virtual DtThemedTreeWidgetItem* create(QTreeWidget* parent = nullptr);
      virtual DtThemedTreeWidgetItem* create(QTreeWidgetItem* parent);

      static DtThemedTreeWidgetItemCreator& instance(makVrv::DtDe& de);
      static void registerInstance(makVrv::DtDe& de, DtThemedTreeWidgetItemCreator*);

   protected:
      makVrv::DtDe& myDe;
   };

   class DT_DLL_VRFGUICOMMONQT DtThemedListWidgetItem : public QListWidgetItem
   {
   public:
      DtThemedListWidgetItem(makVrv::DtDe& de, QListWidget* t = nullptr);

      virtual void manageIcon(const std::string&);
      virtual void unmanageIcon();

      virtual QVariant data(int role) const override;

   protected:
      std::string myManagedIcon;
      makVrv::DtDe& myDe;
   };

   class DT_DLL_VRFGUICOMMONQT DtThemedListWidgetItemCreator : public makVrv::DtVirtualBaseClass
   {
   public:
      DtThemedListWidgetItemCreator(makVrv::DtDe&);

      virtual DtThemedListWidgetItem* create(QListWidget* parent = nullptr);

      static DtThemedListWidgetItemCreator& instance(makVrv::DtDe& de);
      static void registerInstance(makVrv::DtDe& de, DtThemedListWidgetItemCreator*);

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