src/SMESHGUI/SMESHGUI_Hypotheses.h

   1 //  SMESH SMESHGUI : GUI for SMESH component
   2 //
   3 //  Copyright (C) 2003  CEA
   4 //
   5 //  This library is free software; you can redistribute it and/or
   6 //  modify it under the terms of the GNU Lesser General Public
   7 //  License as published by the Free Software Foundation; either
   8 //  version 2.1 of the License.
   9 //
  10 //  This library is distributed in the hope that it will be useful,
  11 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 //  Lesser General Public License for more details.
  14 //
  15 //  You should have received a copy of the GNU Lesser General Public
  16 //  License along with this library; if not, write to the Free Software
  17 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18 //
  19 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  20 //
  21 //
  22 //
  23 //  File   : SMESHGUI_Hypotheses.h
  24 //  Author : Julia DOROVSKIKH
  25 //  Module : SMESH
  26 //  $Header$
  27
  28 #ifndef SMESHGUI_Hypotheses_HeaderFile
  29 #define SMESHGUI_Hypotheses_HeaderFile
  30
  31 #include "SMESH_SMESHGUI.hxx"
  32
  33 #include <SALOMEconfig.h>
  34 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
  35
  36 #include <QtxDialog.h>
  37 #include <qvariant.h>
  38
  39 class QVBoxLayout;
  40 class QPixmap;
  41
  42 /*!
  43  * \brief Auxiliary class for creation of hypotheses
  44 */
  45 class SMESHGUI_EXPORT SMESHGUI_GenericHypothesisCreator : public QObject
  46 {
  47   Q_OBJECT
  48
  49 public:
  50   SMESHGUI_GenericHypothesisCreator( const QString& theHypType );
  51   virtual ~SMESHGUI_GenericHypothesisCreator();
  52
  53   void create( SMESH::SMESH_Hypothesis_ptr, const QString&, QWidget*);
  54   void create( bool isAlgo, const QString&, QWidget*);
  55   void edit( SMESH::SMESH_Hypothesis_ptr, const QString&, QWidget*);
  56
  57   virtual bool checkParams() const = 0;
  58   virtual void onReject();
  59   virtual QString helpPage() const;
  60
  61   QString hypType() const;
  62   QString hypName() const;
  63   bool    isCreation() const;
  64
  65 protected:
  66   typedef struct
  67   {
  68     QString   myName;
  69     QVariant  myValue;
  70
  71   } StdParam;
  72
  73   typedef QValueList<StdParam>   ListOfStdParams;
  74   typedef QPtrList<QWidget>      ListOfWidgets;
  75
  76   SMESH::SMESH_Hypothesis_var hypothesis() const;
  77   SMESH::SMESH_Hypothesis_var initParamsHypothesis() const;
  78   const ListOfWidgets&        widgets() const;
  79   ListOfWidgets&              changeWidgets();
  80   QtxDialog*                  dlg() const { return myDlg; }
  81
  82   virtual QFrame*  buildFrame    () = 0;
  83           QFrame*  buildStdFrame ();
  84   virtual void     retrieveParams() const = 0;
  85   virtual QString  storeParams   () const = 0;
  86   virtual bool     stdParams     ( ListOfStdParams& ) const;
  87           bool     getStdParamFromDlg( ListOfStdParams& ) const;
  88   static  QString  stdParamValues( const ListOfStdParams& );
  89   virtual void     attuneStdWidget( QWidget*, const int ) const;
  90   virtual QWidget* getCustomWidget( const StdParam &, QWidget*, const int ) const;
  91   virtual bool     getParamFromCustomWidget( StdParam& , QWidget* ) const;
  92   virtual QString  caption() const;
  93   virtual QPixmap  icon() const;
  94   virtual QString  type() const;
  95
  96 protected slots:
  97   virtual void onValueChanged();
  98
  99 private:
 100   bool editHypothesis( SMESH::SMESH_Hypothesis_ptr, const QString&, QWidget* );
 101
 102 private:
 103   SMESH::SMESH_Hypothesis_var  myHypo, myInitParamsHypo;
 104   QString                      myHypName;
 105   QString                      myHypType;
 106   ListOfWidgets                myParamWidgets;
 107   bool                         myIsCreate;
 108   QtxDialog*                   myDlg;
 109 };
 110
 111 class SMESHGUI_HypothesisDlg : public QtxDialog
 112 {
 113   Q_OBJECT
 114
 115 public:
 116   SMESHGUI_HypothesisDlg( SMESHGUI_GenericHypothesisCreator*, QWidget* );
 117   virtual ~SMESHGUI_HypothesisDlg();
 118
 119   void setHIcon( const QPixmap& );
 120   void setCustomFrame( QFrame* );
 121   void setType( const QString& );
 122
 123 protected slots:
 124   virtual void accept();
 125   virtual void reject();
 126   void onHelp();
 127
 128 private:
 129   SMESHGUI_GenericHypothesisCreator*   myCreator;
 130   QVBoxLayout*                         myLayout;
 131   QLabel*                              myIconLabel;
 132   QLabel*                              myTypeLabel;
 133   QString                              myHelpFileName;
 134 };
 135
 136 /*!
 137  * \brief Class containing information about hypothesis
 138 */
 139 class HypothesisData
 140 {
 141  public:
 142   HypothesisData( const QString& theTypeName,
 143                   const QString& thePluginName,
 144                   const QString& theServerLibName,
 145                   const QString& theClientLibName,
 146                   const QString& theLabel,
 147                   const QString& theIconId,
 148                   const QValueList<int>& theDim,
 149                   const bool theIsAux,
 150                   const QStringList& theNeededHypos,
 151                   const QStringList& theOptionalHypos,
 152                   const QStringList& theInputTypes,
 153                   const QStringList& theOutputTypes,
 154                   const bool theIsNeedGeometry = true)
 155     : TypeName( theTypeName ),
 156     PluginName( thePluginName ),
 157     ServerLibName( theServerLibName ),
 158     ClientLibName( theClientLibName ),
 159     Label( theLabel ),
 160     IconId( theIconId ),
 161     Dim( theDim ),
 162     IsAux( theIsAux ),
 163     NeededHypos( theNeededHypos ), OptionalHypos( theOptionalHypos ),
 164     InputTypes( theInputTypes ), OutputTypes( theOutputTypes ),
 165     IsNeedGeometry( theIsNeedGeometry )
 166     {};
 167
 168  QString TypeName;        //!< hypothesis type name
 169  QString PluginName;      //!< plugin name
 170  QString ServerLibName;   //!< server library name
 171  QString ClientLibName;   //!< client library name
 172  QString Label;           //!< label
 173  QString IconId;          //!< icon identifier
 174  QValueList<int> Dim;     //!< list of supported dimensions (see SMESH::Dimension enumeration)
 175  bool IsAux;              //!< TRUE if given hypothesis is auxiliary one, FALSE otherwise
 176  bool IsNeedGeometry;     //!< TRUE if for given hypothesis need shape, FALSE otherwise
 177
 178  // for algorithm only: dependencies algo <-> algo and algo -> hypos
 179  QStringList NeededHypos;  //!< list of obligatory hypotheses
 180  QStringList OptionalHypos;//!< list of optional hypotheses
 181  QStringList InputTypes;   //!< list of element types required as a prerequisite
 182  QStringList OutputTypes;  //!< list of types of generated elements
 183 };
 184
 185 /*!
 186  * \brief Class containing set of hypotheses
 187  *
 188  * Actually it contains list of hypo types
 189  */
 190 class HypothesesSet
 191 {
 192  public:
 193   HypothesesSet( const QString& theSetName )
 194     : HypoSetName( theSetName ) {};
 195   HypothesesSet( const QString&     theSetName,
 196                  const QStringList& theHypoList,
 197                  const QStringList& theAlgoList )
 198     : HypoSetName( theSetName ), HypoList(theHypoList), AlgoList(theAlgoList) {};
 199   QString     HypoSetName;
 200   QStringList HypoList, AlgoList;
 201 };
 202 #endif