DtElementDefinitionEditorInterface.h

Go to the documentation of this file.

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


#pragma once
#include <vrvCoreQt/vrvCoreQt.h>

class QTreeWidgetItem;
class QWidget;
class QString;

namespace makVrv
{
   class DtVisualDefinitionItemCreator;
   class DtVisualDefinition;
   class DtVisualAttributeInterface;
   enum class DtModelSetId;

   class DT_DLL_VRVCOREQT DtElementDefinitionEditorInterface
   {
   public:
      enum ButtonFlags
      {
         ElementDefinitionAdd        = 0x00000001,
         ElementDefinitionRemove     = 0x00000002,
         ElementDefinitionMoveUp     = 0x00000004,
         ElementDefinitionMoveDown   = 0x00000008,
         ElementDefinitionMoveLeft   = 0x00000010,
         ElementDefinitionMoveRight  = 0x00000020,
         ElementDefinitionCopy       = 0x00000040,
         ElementDefinitionPaste      = 0x00000080,
         ElementDefinitionRename     = 0x00000100,
         AllElementDefinitionButtons =
            ElementDefinitionAdd | ElementDefinitionRemove |
            ElementDefinitionMoveUp | ElementDefinitionMoveDown |
            ElementDefinitionMoveLeft | ElementDefinitionMoveRight |
            ElementDefinitionPaste | ElementDefinitionCopy | ElementDefinitionRename,

         VisualDefinitionAdd            = 0x00000100,
         VisualDefinitionRemove         = 0x00000200,
         VisualDefinitionAddAttribute   = 0x00000400,
         VisualDefinitionRemoveAttribute= 0x00000800,
         VisualDefinitionRevert         = 0x00001000,
         AllVisualDefinitionButtons     =
            VisualDefinitionAdd | VisualDefinitionRemove | VisualDefinitionRevert |
            VisualDefinitionAddAttribute | VisualDefinitionRemoveAttribute
      };

   public:
      virtual ~DtElementDefinitionEditorInterface();

      virtual void clearModelSets() = 0;

      virtual void addModelSet(const std::string&, int id) = 0;

      virtual DtModelSetId modelSet() const = 0;

      virtual void clearElementDefinitions() = 0;

      virtual void addPath(const std::string& path) = 0;

      virtual void selectPath(const std::string& path) = 0;

      virtual std::string selectedPath() const = 0;

      virtual void setEnabled(ButtonFlags, bool) = 0;

      virtual QTreeWidgetItem* selectedElementDefinitionTreeWidgetItem() const = 0;

      virtual QTreeWidgetItem* selectedVisualDefinitionTreeWidgetItem() const = 0;

      virtual QTreeWidgetItem* elementDefinitionTreeWidgetRootItem() const = 0;

      virtual void removePath(const std::string& path) = 0;

      virtual void clearElementDefinitionSelection() = 0;

      virtual void movePathTo(const std::string& oldPath, const std::string& newPath) = 0;

      virtual void reposition(const std::string& from, const std::string& after) = 0;

      virtual std::string title() const = 0;

      virtual void clearVisualDefinitions() = 0;

      virtual void addVisualDefinition(const std::string& vis, const DtVisualDefinition&,
         const std::string& screenName, bool isInherited) = 0;

      virtual void addVisualAttribute(const std::string& visualDefinition, const std::string& attribute,
         const DtVisualAttributeInterface* attr, bool isInherited) = 0;

      virtual void removeVisualDefinition(const std::string& path, const std::string& vis) = 0;

      virtual void removeVisualAttribute(const std::string& path, const std::string& vis, const std::string& attr) = 0;

      virtual QWidget* widget() = 0;

      virtual void selectVisualDefinition(const std::string& vis) = 0;

      virtual void selectVisualAttribute(const std::string& vis, const std::string& attr) = 0;

      virtual void registerItemCreator(int createByType, const std::string& type, DtVisualDefinitionItemCreator*) = 0;

      virtual int buttonFlags() const = 0;

      virtual void editSelectedItem(int col = 0) = 0;

      virtual void setPathModified(const std::string& path, bool modified) = 0;

      virtual void pathsCleaned() = 0;

      virtual void setModifiedPaths(const std::map<std::string, bool>&) = 0;

      virtual void setHelpText(const std::string&) = 0;

      virtual void setElementDefinitionEditorLabel(const QString& t) = 0;

      virtual void setDeleteButtonToolTip(const QString& s) = 0;

      virtual void sort() = 0;

      virtual void setPathValid(const std::string& path, bool) = 0;

      virtual void setVisualDefinitionValid(const std::string& visDef, bool) = 0;

      virtual void setVisualDefinitionErrors(const std::string&) = 0;

      virtual void appendVisualDefinitionError(const std::string& visDef, const std::string&, bool reset = false) = 0;

      virtual void clearVisualDefinitionErrorsFor(const std::string& visDef) = 0;

      virtual void setupVisualDefinitionErrors() = 0;

      virtual void setElementDefinitionErrors(const std::string&) = 0;

      virtual void appendElementDefinitionError(const std::string& visDef, const std::string&, bool reset = false) = 0;

      virtual void clearElementDefinitionErrorsFor(const std::string& visDef) = 0;

      virtual void setupElementDefinitionErrors() = 0;

      virtual void setCanRemove(bool) = 0;

   public:
      boost::signalslib::signal<void ()> signal_elementDefinitionSelectionChanged;
      boost::signalslib::signal<void ()> signal_visualDefinitionSelectionChanged;
      boost::signalslib::signal<void ()> signal_addElementDefinition;
      boost::signalslib::signal<void (const std::string& path)> signal_removeElementDefinition;
      boost::signalslib::signal<void (const std::string& path)> signal_addVisualDefinition;
      boost::signalslib::signal<void (const std::string& path, const std::string& def)> signal_removeVisualDefinition;
      boost::signalslib::signal<void (const std::string& path, const std::string& def, const std::string& attr)> signal_removeVisualAttribute;
      boost::signalslib::signal<void (const std::string& path, const std::string& def)> signal_addVisualAttribute;
      boost::signalslib::signal<void ()> signal_moveUp;
      boost::signalslib::signal<void (QTreeWidgetItem*, int)> signal_visualAttributeSelected;
      boost::signalslib::signal<void ()> signal_moveDown;
      boost::signalslib::signal<void ()> signal_moveLeft;
      boost::signalslib::signal<void ()> signal_moveRight;
      boost::signalslib::signal<void ()> signal_copyElement;
      boost::signalslib::signal<void ()> signal_pasteElement;
      boost::signalslib::signal<void ()> signal_backupClipboard;
      boost::signalslib::signal<void ()> signal_restoreClipboard;
      boost::signalslib::signal<void (const std::string& path)> signal_copyElementDefinition;
      boost::signalslib::signal<void (const std::string& from, const std::string& to)> signal_copyElementDefinitionPath;
      boost::signalslib::signal<void (const std::string& path)> signal_pasteElementDefinition;
      boost::signalslib::signal<void (const std::string& oldPath, const std::string& newPath)> signal_elementDefinitionNameChanged;
      boost::signalslib::signal<void (const std::string& oldPath, const std::string& newPath)> signal_movePathTo;
      boost::signalslib::signal<void (const std::string& from, const std::string& top)> signal_reparent;
      boost::signalslib::signal<void (int)> signal_displayModelSet;
      boost::signalslib::signal<void (const std::string& attribute)> signal_createNew;
   };
}