commandPanel.h

Go to the documentation of this file.

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



#pragma once

#if !defined(Q_MOC_RUN)
#include <vrfGuiObjectInformationQt/vrfGuiObjectInformationQt.h>
#include <vrfGuiCommonQt/treeWidget.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvCore/DtUserInterfaceAssembler.h>
#include <vrvCore/DtSelectionManager.h>
#include <vrvCore/DtStateView.h>
#include <vrvCore/DtEntityState.h>
#include <vrvCoreQt/DtPage.h>
#include <QtGui/QPixmap>
#include <QtGui/QIcon>
#include <QtWidgets/QTreeWidget>
#endif

#include <boost/signals2.hpp>

#include <QtWidgets/QWidget>

namespace makVrv
{
   class DtDe;
   class DtQtPagePanel;
}

class QButtonGroup;
class QScrollArea;
class QVBoxLayout;
class QToolButton;
class QMenu;
class QSpacerItem;
class QLineEdit;
class QPushButton;
class QLabel;
class QHBoxLayout;
class QSlider;

namespace makVrf
{
   class DtVrfTaskSetAction;
   class DtVrfTaskSetManager;
   class DtVrfTaskSetMenu;
   class DtTaskSetDialogInterface;
   class DtVrfTaskSetMenu;
   class DtBasePlanWidget;
   class DtCommandAssignmentWidgetInterface;
   class DtCommandAssignmentWidget;
   class DtVrfTaskSetAction;
   class DtConditionalDialogInterface;
   class DtConditionalExpressionInterface;
   class DtToolButtonWrapperWidget;
   class DtTreeWidget;
   class DtTaskMenu;
   class DtSetMenu;

   namespace makVrfGuiObjectInformationQt
   {
      class DtCommandPanelTreeWidget;
      class DtCommandPanelItem;
      class DtSelectedObjectInformationWidget;

      class DT_DLL_VRFGUIOBJECTINFORMATIONQT DtCommandPanel : public makVrv::DtPage
      {
         Q_OBJECT
      public:
      
         struct Section
         {
            Section() : expandCollapse(nullptr), canvas(nullptr), items(nullptr), layout(nullptr), isPartOfSort(true), buttons(nullptr) {};
            QToolButton* expandCollapse;
            QString title;
            QWidget* canvas;
            DtCommandPanelTreeWidget* items;
            QVBoxLayout* layout;
            DtToolButtonWrapperWidget* buttons;
            bool isPartOfSort;
            std::map<DtString, DtCommandPanelItem*> treeWidgetItems;
         };

      public:
         DtCommandPanel( makVrv::DtDe& de, QWidget* parent = 0, Qt::WindowFlags flags = 0);

         virtual ~DtCommandPanel();

         virtual QIcon icon();

         virtual makVrv::DtQIconConfigurations qIconConfigurations() const;

         virtual QString title();

         virtual const std::string& pageClassName() const;

         static const std::string& thePageClassName();

         virtual void activate();
         virtual void deactivate();

         virtual void setShowIcons(bool b);
         bool showIcons() const
         {
            return myShowIcons;
         }

      protected:
         virtual makVrv::DtQtPagePanel* qtPagePanelParent() const;
         virtual void menuCleared();
         virtual void setupUi();
         virtual void setupItems();
         virtual void clear();
         virtual void hideAllSections(bool resetCounts = true);

         enum Mode
         {
            IsTask = 0,
            IsSet = 2,
            Flat = 3
         };

         DtVrfTaskSetManager& vrfTaskSetManager();
         virtual int addSection(QMenu*, Mode, bool isPartOfSort = true);
         virtual int addActions(QMenu*, Section&, Mode mode);
         virtual void setupItems(DtVrfTaskSetMenu*, Mode mode);

         virtual void enableSection(Section& section, QMenu*, Mode mode);
         virtual void enableItem(Section& section, QAction*, Mode mode);
         virtual void enableItems(DtVrfTaskSetMenu*, Mode mode);
         virtual void enableItems();

         virtual void validate();
         virtual void triggerVrfAction(DtVrfTaskSetAction* act, QTreeWidgetItem* item);
         virtual void triggerNormalAction(QAction* act, QTreeWidgetItem* item);
         virtual Section& getOrCreateSection(QMenu*);
         virtual void sortSections();
         virtual void clearInterfaces();

         virtual void slot_commandLevelChanged(const DtString&, int level, bool);
         virtual void slot_dialogCreated(DtTaskSetDialogInterface*, DtVrfTaskSetAction*, bool& reject);
         virtual void slot_dialogShown(DtTaskSetDialogInterface*);
         virtual void slot_dialogDestroyed(DtTaskSetDialogInterface*);
         virtual void slot_dialogRun(DtTaskSetDialogInterface*);
         virtual void slot_commandDialogCreated(DtCommandAssignmentWidgetInterface*, QAction*, bool& reject);
         virtual void slot_commandDialogShown(DtCommandAssignmentWidgetInterface*);
         virtual void slot_commandDialogRun(DtCommandAssignmentWidgetInterface*);
         virtual void slot_commandDialogDestroyed(DtCommandAssignmentWidgetInterface*);
         virtual void slot_conditionDialogShown(DtConditionalDialogInterface*, QAction*);
         virtual void slot_conditionDialogDestroyed(DtConditionalDialogInterface*);
         virtual void slot_conditionDialogRun(DtConditionalDialogInterface*);
         virtual void slot_expressionRun(DtConditionalExpressionInterface*);
         virtual void slot_expressionDestroyed(DtConditionalExpressionInterface*);
         virtual void slot_alwaysPopOutChanged(bool b);
         virtual void initialize();
         virtual void resizeCommandLevelIconsIfNeeded();
         virtual void planWidgetChangedFocus(DtBasePlanWidget*, bool focusIn, bool force = false);
         virtual bool eventFilter(QObject*, QEvent*);
         virtual void filterItem(QTreeWidgetItem*);
         virtual bool sizeSection(Section&);
         virtual void addInterface(QWidget*, QAction*);
         virtual void interfaceShown(QWidget*);
         virtual void removeInterface(QWidget*);
         virtual QMenu* createRightClickMenu(QTreeWidgetItem*);
         virtual void commandButtonSelected(int);
         virtual Section* sectionFor(QTreeWidget*);
         virtual void setShowFavoritesForSection(Section& section, bool b);
         virtual void slot_guiOptionsChanged();
         virtual void updateBasedOnShowType();
         virtual void slot_onCurrentSelectionChanged(const makVrv::DtSelectionManager::IdSet&);
         virtual void createSimObjectTaskMenu();
         virtual void createSimObjectSetMenu();
         virtual bool canSelectTaskSet() const;
         virtual void dialogRun(QWidget* d);
         virtual void slot_selectionPopped();
         virtual void deferredSetupItems();

         virtual void updateTitleColor();
         virtual void setupCustomTitleBarIfDocked();
         virtual void menuRecreated();

         virtual void expandOrCollapseSection(QToolButton* b, bool setInSettings = true);

         virtual void slot_expandCollapsedStateChanged(const DtString&, bool);
         virtual void slot_objectRemoved(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* state);

         virtual bool isPoppedOut(QWidget*) const;
         virtual bool activePlanWidgetIsIssueCommandWidget() const;
         virtual void setButtonAction(QToolButton*, QAction*);

         virtual void completeSelection(makVrv::DtSelectionManager::IdSet);

         virtual QSize sizeHint() const override;
         virtual QSize minimumSizeHint() const override;

      protected slots:
         virtual void resizeToMinimumHeight();
         virtual void itemButtonClicked();
         virtual void onAlwaysPopOutChanged();
         virtual void sliderChanged();
         virtual void slot_onItemRightClickedOn(QTreeWidgetItem* i, QMouseEvent* e, int col);
         virtual void expandCollapseSection();
         virtual void itemSelectionChanged(QTreeWidgetItem*);
         virtual void expandAll();
         virtual void collapseAll();
         virtual void filterItems();
         virtual void clearFilter();
         virtual void removeFromFavoritesRightClick();
         virtual void addToFavoritesRightClick();
         virtual void menuDestroyed();
         virtual void commandButtonSelected();
         virtual void activePlanWidgetDestroyed();
         virtual void widgetDestroyed();
         virtual void onToolButtonRightClicked(QToolButton*);
         virtual void checkDeactivate();

      protected:
         boost::signals2::scoped_connection myTriggerConnection;
         makVrv::DtSignalConnectionManager myTaskMenuConnections;
         makVrv::DtSignalConnectionManager mySetMenuConnections;
         boost::signals2::scoped_connection myInitializeConnection;
         boost::signals2::scoped_connection myActivePlanWidgetDestroyedConnection;
         boost::signals2::scoped_connection mySetupItemsConnection;
         boost::signals2::scoped_connection myCompleteSelectionConnection;

         makVrv::DtSignalConnectionManager myConnectionManager;
         std::map<QString, QWidget*> mySortedSections;
         struct Interface
         {
            Interface() : label(nullptr), widget(nullptr), alwaysPopOut(true) {};

            QLabel* label;
            QWidget* widget;
            bool alwaysPopOut;
         };

         typedef std::vector<Interface> Interfaces;
         Interfaces myInterfaces;

         DtVrfTaskSetMenu* myTaskMenu;
         DtVrfTaskSetMenu* mySetMenu;

         DtVrfTaskSetMenu* mySimObjectTaskMenu;
         DtVrfTaskSetMenu* mySimObjectSetMenu;

         DtBasePlanWidget* myActivePlanWidget;
         makVrv::DtSelectionManager::IdSet myEntitySet;
         bool myShowingFavoritesOnly;
         bool myShowIcons;
         bool myShowLargeIcons;
         bool myActive;
         bool myIgnoreNextSelection;
         bool myFirstInitialize;
         bool myRestoreOnNextShowItem;
         bool myMenuRecreated;
         typedef std::vector<Section> Sections;
         Sections mySections;
         QPixmap myEmptyIcon;
         DtVrfTaskSetManager* myVrfTaskSetManager;
         int myButtonSize;
         int myLastMinimumWidth;
         bool myLaunchedFromCommandPanel;
         bool mySettingUpPlanWidget = false;
         bool myIsFloating = false;
         bool myFloatingStatusChanged = false;

      public:
         QVBoxLayout* myMainLayout;
         QScrollArea* myTaskSetScrollArea;

         QFrame* mySeparator;
         QWidget* myDescriptionCanvas;
         QHBoxLayout* myDescriptionLayout;
         QLabel* myDescription;

         QWidget* myCommandWidgetCanvas;
         QVBoxLayout* myCommandWidgetCanvasLayout;
         QScrollArea* myCommandWidgetScrollArea;

         QWidget* myFilterCanvas;
         QVBoxLayout* myFilterCanvasLayout;
         QVBoxLayout* myFilterAndSliderLayout;
         QHBoxLayout* myFilterButtonLayout;
         QToolButton* myShowMagicCommands;
         QToolButton* myAlwaysPopOut;
         QHBoxLayout* myAdditionFilterButtonsLayout;

         QWidget* myCommandLevelsCanvas;
         QHBoxLayout* myCommandLevelsCanvasLayout;
         std::vector<QToolButton*> myCommandLevels;

         QToolButton* myExpandAll;
         QToolButton* myCollapseAll;

         QWidget* mySearchCanvas;
         QHBoxLayout* mySearchLayout;
         QLabel* myFilterLabel;
         QLineEdit* myFilter;
         QToolButton* myClearFilter;

         QWidget* myTaskSetWidget;
         QVBoxLayout* myTaskSetWidgetLayout;
         QSpacerItem* myTaskSetScrollAreaItem;

         QWidget* myCommandWidget;
         QVBoxLayout* myCommandWidgetLayout;
         QSpacerItem* myCommandWidgetLayoutSpacerItem;

         QMenu* myRightClickMenu;
         QSlider* myCommandLevelSlider;

         DtSelectedObjectInformationWidget* mySelectedObjectInformationWidget;
      };


      class DT_DLL_VRFGUIOBJECTINFORMATIONQT DtCommandPanelCreator : public makVrv::DtPageCreator
      {
      public:

         DtCommandPanelCreator(makVrv::DtDe& de);

         virtual ~DtCommandPanelCreator();

         virtual std::string pageClassName() const;

         virtual makVrv::DtPage* create(QWidget* parent = 0, Qt::WindowFlags f = 0);
      };

      class DT_DLL_VRFGUIOBJECTINFORMATIONQT DtCommandPanelItem : public QTreeWidgetItem
      {
      public:
         DtCommandPanelItem(makVrv::DtDe& de, QTreeWidget* parent, const std::string& on, const std::string& off);

         virtual ~DtCommandPanelItem();

         virtual void setFavoritesSupported(bool b);

         virtual void setFavorite(bool b);
         bool favorite() const
         {
            return myFavorite;
         }

         virtual void setIcon(const QIcon& k);

         const QIcon& icon() const
         {
            return myIcon;
         }

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

         virtual void setIsMagicCommand(bool);
         bool isMagicCommand() const
         {
            return myIsMagicCommand;
         }

      protected:
         QIcon myIcon;
         makVrv::DtDe& myDe;
         bool myFavorite;
         std::string myFavoriteOn;
         std::string myFavoriteOff;
         bool myFavoritesSupported;
         DtTaskMenu* mySimObjectTaskMenu;
         DtSetMenu* mySimObjectSetMenu;
         bool myIsMagicCommand;
      };

      class DT_DLL_VRFGUIOBJECTINFORMATIONQT DtCommandPanelItemCreator : public makVrv::DtVirtualBaseClass
      {
      public:
         DtCommandPanelItemCreator(makVrv::DtDe&);

         virtual ~DtCommandPanelItemCreator();

         virtual DtCommandPanelItem* create(QTreeWidget* parent, const std::string& on, const std::string& off);

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

      protected:
         makVrv::DtDe& myDe;
      };

      class DT_DLL_VRFGUIOBJECTINFORMATIONQT DtCommandPanelTreeWidget : public DtTreeWidget
      {
      public:
         DtCommandPanelTreeWidget(makVrv::DtDe& de, QWidget* p);
         virtual ~DtCommandPanelTreeWidget();

         bool favoritesSupported() const
         {
            return myFavoritesSupported;
         }

         virtual void setFavoritesSupported(bool b);

         virtual void mousePressEvent(QMouseEvent *event);

      protected:
         bool myFavoritesSupported;
      };

      class DT_DLL_VRFGUIOBJECTINFORMATIONQT DtCommandPanelTreeWidgetCreator : public makVrv::DtVirtualBaseClass
      {
      public:
         DtCommandPanelTreeWidgetCreator(makVrv::DtDe&);
         virtual ~DtCommandPanelTreeWidgetCreator();

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

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

         virtual DtCommandPanelTreeWidget* create(QWidget* parent);

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