src/ParametersPlugin/ParametersPlugin_WidgetParamsMgr.h

   1 // Copyright (C) 2014-2024  CEA, EDF
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef ParametersPlugin_WidgetParamsMgr_H_
  21 #define ParametersPlugin_WidgetParamsMgr_H_
  22
  23 #include <ModuleBase_ModelDialogWidget.h>
  24 #include <QModelIndex>
  25 #include <QAbstractItemDelegate>
  26 #include <QTreeWidget>
  27
  28 class QTreeWidgetItem;
  29 class ParametersPlugin_ItemDelegate;
  30 class QPushButton;
  31 class QToolButton;
  32 class ModuleBase_IWorkshop;
  33
  34 /*!
  35  * \ingroup GUI
  36  * Redefinition of QTreeWidget for processing of closeEditor event
  37  */
  38 class ParametersPlugin_TreeWidget: public QTreeWidget
  39 {
  40  Q_OBJECT
  41 public:
  42   /// Constructor
  43   /// \param theParent a parent widget
  44   ParametersPlugin_TreeWidget(QWidget* theParent = 0) : QTreeWidget(theParent) {}
  45
  46 protected slots:
  47   /// Redefinition of virtual method
  48   /// \param theEditor a editor widget
  49   /// \param theHint end of editing hint
  50   virtual void closeEditor(QWidget* theEditor, QAbstractItemDelegate::EndEditHint theHint);
  51 };
  52
  53
  54
  55 /*!
  56  * \ingroup GUI
  57  * Represent a content of the property panel to show/modify parameters of some feature.
  58  */
  59 class ParametersPlugin_WidgetParamsMgr : public ModuleBase_ModelDialogWidget
  60 {
  61  Q_OBJECT
  62 public:
  63   /// Constructs a model widget
  64   ParametersPlugin_WidgetParamsMgr(QWidget* theParent, const Config_WidgetAPI* theData,
  65     ModuleBase_IWorkshop* theWorkshop);
  66
  67   /// Destructs the model widget
  68   virtual ~ParametersPlugin_WidgetParamsMgr() {}
  69
  70   /// Returns list of widget controls
  71   /// \return a control list
  72   virtual QList<QWidget*> getControls() const;
  73
  74   /// Set general buttons from dialog
  75   /// \param theButtons the dialog buttons
  76   virtual void setDialogButtons(QDialogButtonBox* theButtons);
  77
  78 protected:
  79   /// Saves the internal parameters to the given feature
  80   /// \return True in success
  81   virtual bool storeValueCustom();
  82
  83   /// Restore value from attribute data to the widget's control
  84   virtual bool restoreValueCustom();
  85
  86   /// The method called when widget is activated
  87   virtual void activateCustom();
  88
  89   virtual void showEvent(QShowEvent* theEvent);
  90
  91   virtual void hideEvent(QHideEvent* theEvent);
  92
  93 private slots:
  94   /// Slot for reaction on double click in the table (start editing)
  95   /// \param theIndex the clicked index
  96   void onDoubleClick(const QModelIndex& theIndex);
  97
  98   /// Slot for reaction on end of cell editing
  99   /// \param theEditor the editor widget
 100   /// \param theHint end of edit type
 101   void onCloseEditor(QWidget* theEditor, QAbstractItemDelegate::EndEditHint theHint);
 102
 103   /// Slot for reaction on add parameter
 104   void onAdd();
 105
 106   /// Slot for reaction on insert parameter
 107   void onInsert();
 108
 109   /// Slot for reaction on remove parameter
 110   void onRemove();
 111
 112   /// Slot for reaction on import parameter
 113   void onImport();
 114
 115   /// Slot for reaction on shift up
 116   void onUp();
 117
 118   /// Slot for reaction on shift down
 119   void onDown();
 120
 121   /// Slot to show message on closing of editor
 122   void sendWarning();
 123
 124   /// Slot for reaction on selection in the table
 125   void onSelectionChanged();
 126
 127   // A slot for show preview button
 128   void onShowPreview();
 129
 130 private:
 131   /// Creates a new parameter feature
 132   FeaturePtr createParameter() const;
 133
 134   /// Creates a new item
 135   QTreeWidgetItem* createNewItem(QTreeWidgetItem* theParent) const;
 136
 137   /// Returns currently selected item
 138   QTreeWidgetItem* selectedItem() const;
 139
 140   /// Select the given Item and scroll the table to make it visible
 141   void selectItemScroll(QTreeWidgetItem* theItem);
 142
 143   /// Update values in features part
 144   void updateItem(QTreeWidgetItem* theItem, const QList<QStringList>& theFeaturesList);
 145
 146   void updateFeaturesPart();
 147
 148   void updateParametersPart();
 149
 150   /// Returns true if values in the widget are valid
 151   bool isValid();
 152
 153   /// Returns true if parameter with the given name already exists
 154   bool hasName(const QString& theName, int theIndex) const;
 155
 156   /// Enable or disable buttons for parameters managemnt
 157   void enableButtons(bool theEnable);
 158
 159   QList<QStringList> featuresItems(const QList<FeaturePtr>& theFeatures,
 160                                    QList<FeaturePtr>& theFeatureList) const;
 161   QList<QStringList> parametersItems(const QList<FeaturePtr>& theFeatures) const;
 162
 163   void updateParametersFeatures();
 164
 165   ModuleBase_IWorkshop* myWorkshop;
 166
 167   ParametersPlugin_TreeWidget* myTable;
 168   QTreeWidgetItem* myFeatures;
 169   QTreeWidgetItem* myParameters;
 170   ParametersPlugin_ItemDelegate* myDelegate;
 171
 172   QList<FeaturePtr> myParametersList;
 173
 174   QString myMessage;
 175
 176   QPushButton* myAddBtn;
 177   QPushButton* myInsertBtn;
 178   QPushButton* myRemoveBtn;
 179   QPushButton* myImportBtn;
 180   QToolButton* myUpBtn;
 181   QToolButton* myDownBtn;
 182
 183   bool isUpplyBlocked;
 184 };
 185
 186
 187 #endif