src/ModuleBase/ModuleBase_Dialog.h

   1 // Copyright (C) 2014-2023  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 ModuleBase_Dialog_H
  21 #define ModuleBase_Dialog_H
  22
  23 #include "ModuleBase.h"
  24 #include <ModelAPI_Feature.h>
  25
  26 #include <QDialog>
  27 #include <string>
  28
  29
  30 class ModuleBase_IWorkshop;
  31 class ModuleBase_ModelWidget;
  32 class QDialogButtonBox;
  33
  34
  35 /**
  36  * \ingroup GUI
  37  * A dialog box which is used for modal dialog box feature interface
  38  */
  39 class ModuleBase_Dialog : public QDialog
  40 {
  41   Q_OBJECT
  42 public:
  43   /// Constructor
  44   /// \param theParent a workshop object instance
  45   /// \param theId an Id of a feature
  46   /// \param theDescription an XML description of the feature
  47   ModuleBase_Dialog(ModuleBase_IWorkshop* theParent, const std::string& theDescription);
  48
  49   /// Redefinition of virtual method
  50   virtual void accept();
  51
  52 protected:
  53   /// Redefinition of virtual method
  54   virtual void showEvent(QShowEvent* theEvent);
  55
  56 private slots:
  57   void onHelpRequest();
  58
  59 private:
  60   /// Initialising of the widget
  61   void initializeWidget(ModuleBase_ModelWidget* theWidget);
  62
  63   /// Id of the feature
  64   std::string myId;
  65
  66   /// XML description of the feature
  67   std::string myDescription;
  68
  69   /// An instance of workshop object
  70   ModuleBase_IWorkshop* myWorkshop;
  71
  72   /// The feature instance
  73   FeaturePtr myFeature;
  74
  75   /// List of created widgets
  76   QList<ModuleBase_ModelWidget*> myWidgets;
  77
  78   /// Pointer on active widget
  79   ModuleBase_ModelWidget* myActiveWidget;
  80
  81   /// Buttons of the dialog
  82   QDialogButtonBox* myButtonsBox;
  83
  84   std::string myHelpPage;
  85 };
  86
  87 #endif