src/SMESHGUI/SMESHGUI_Operation.cxx

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22 //  File   : SMESHGUI_Operation.cxx
  23 //  Author : Sergey LITONIN, Open CASCADE S.A.S.
  24
  25 #include "SMESHGUI_Operation.h"
  26
  27 #include "SMESHGUI.h"
  28 #include "SMESHGUI_Dialog.h"
  29
  30 // SALOME GUI includes
  31 #include <SalomeApp_Study.h>
  32 #include <LightApp_Application.h>
  33
  34 #include <SUIT_Session.h>
  35 #include <SUIT_MessageBox.h>
  36 #include <SUIT_Desktop.h>
  37 #include <SUIT_ResourceMgr.h>
  38
  39 // Qt includes
  40 #include <QStringList>
  41
  42 /*
  43   Class       : SMESHGUI_Operation
  44   Description : Base class for all SMESH operations
  45 */
  46
  47 //=======================================================================
  48 // name    : SMESHGUI_Operation
  49 // Purpose : Constructor
  50 //=======================================================================
  51 SMESHGUI_Operation::SMESHGUI_Operation()
  52 : LightApp_Operation(),
  53   myIsApplyAndClose( false )
  54 {
  55   myHelpFileName = "";
  56 }
  57
  58 //=======================================================================
  59 // name    : ~SMESHGUI_Operation
  60 // Purpose : Destructor
  61 //=======================================================================
  62 SMESHGUI_Operation::~SMESHGUI_Operation()
  63 {
  64 }
  65
  66 //=======================================================================
  67 // name    : getSMESHGUI
  68 // Purpose : Get SMESH module
  69 //=======================================================================
  70 SMESHGUI* SMESHGUI_Operation::getSMESHGUI() const
  71 {
  72   return dynamic_cast<SMESHGUI*>( module() );
  73 }
  74
  75 //=======================================================================
  76 // name    : startOperation
  77 // Purpose : Start opeartion
  78 //=======================================================================
  79 void SMESHGUI_Operation::startOperation()
  80 {
  81   if( dlg() )
  82   {
  83     disconnect( dlg(), SIGNAL( dlgOk() ), this, SLOT( onOk() ) );
  84     disconnect( dlg(), SIGNAL( dlgApply() ), this, SLOT( onApply() ) );
  85     disconnect( dlg(), SIGNAL( dlgCancel() ), this, SLOT( onCancel() ) );
  86     disconnect( dlg(), SIGNAL( dlgClose() ), this, SLOT( onCancel() ) );
  87     disconnect( dlg(), SIGNAL( dlgHelp() ), this, SLOT( onHelp() ) );
  88
  89     if( dlg()->testButtonFlags( QtxDialog::OK ) )
  90       connect( dlg(), SIGNAL( dlgOk() ), this, SLOT( onOk() ) );
  91
  92     if( dlg()->testButtonFlags( QtxDialog::Apply ) )
  93       connect( dlg(), SIGNAL( dlgApply() ), this, SLOT( onApply() ) );
  94
  95     if( dlg()->testButtonFlags( QtxDialog::Cancel ) )
  96       connect( dlg(), SIGNAL( dlgCancel() ), this, SLOT( onCancel() ) );
  97
  98     if( dlg()->testButtonFlags( QtxDialog::Help ) )
  99       connect( dlg(), SIGNAL( dlgHelp() ), this, SLOT( onHelp() ) );
 100
 101     //if( dlg()->testButtonFlags( QtxDialog::Close ) )
 102     //if dialog hasn't close, cancel, no and etc buttons, dlgClose will be emitted when dialog is closed not by OK
 103     connect( dlg(), SIGNAL( dlgClose() ), this, SLOT( onCancel() ) );
 104
 105     initDialog();
 106   }
 107
 108   LightApp_Operation::startOperation();
 109 }
 110
 111 //=======================================================================
 112 // name    : isReadyToStart
 113 // Purpose : Verify whether operation is ready to start
 114 //=======================================================================
 115 bool SMESHGUI_Operation::isReadyToStart() const
 116 {
 117   if ( !LightApp_Operation::isReadyToStart() )
 118     return false;
 119   else if ( getSMESHGUI() == 0 )
 120   {
 121     SUIT_MessageBox::warning( desktop(), tr( "SMESH_WRN_WARNING" ),
 122                               tr( "NO_MODULE" ) );
 123     return false;
 124   }
 125   else if ( isStudyLocked() )
 126     return false;
 127
 128   return true;
 129 }
 130
 131 //=======================================================================
 132 // name    : setDialogActive
 133 // Purpose :
 134 //=======================================================================
 135 void SMESHGUI_Operation::setDialogActive( const bool active )
 136 {
 137   LightApp_Operation::setDialogActive( active );
 138
 139   SMESHGUI_Dialog* d = dynamic_cast<SMESHGUI_Dialog*>( dlg() );
 140   if( d )
 141     d->setContentActive( active );
 142
 143 }
 144
 145 //=======================================================================
 146 // name    : studyDS
 147 // Purpose :
 148 //=======================================================================
 149 _PTR(Study) SMESHGUI_Operation::studyDS() const
 150 {
 151   SalomeApp_Study* s = dynamic_cast<SalomeApp_Study*>( study() );
 152   return s->studyDS();
 153 }
 154
 155 //=======================================================================
 156 // name    : onOk
 157 // Purpose :
 158 //=======================================================================
 159 void SMESHGUI_Operation::onOk()
 160 {
 161   setIsApplyAndClose( true );
 162   if( onApply() )
 163     commit();
 164   setIsApplyAndClose( false );
 165   //else
 166   //  abort();
 167 }
 168
 169 //=======================================================================
 170 // name    : onApply
 171 // Purpose :
 172 //=======================================================================
 173 bool SMESHGUI_Operation::onApply()
 174 {
 175   return false;
 176 }
 177
 178 //=======================================================================
 179 // name    : onClose
 180 // Purpose :
 181 //=======================================================================
 182 void SMESHGUI_Operation::onCancel()
 183 {
 184   abort();
 185 }
 186
 187 //=======================================================================
 188 // name    : onHelp
 189 // Purpose :
 190 //=======================================================================
 191 void SMESHGUI_Operation::onHelp()
 192 {
 193   LightApp_Application* app = (LightApp_Application*)(SUIT_Session::session()->activeApplication());
 194   if (app)
 195     app->onHelpContextModule(getSMESHGUI() ? app->moduleName(getSMESHGUI()->moduleName()) : QString(""), myHelpFileName);
 196   else {
 197     QString platform;
 198 #ifdef WIN32
 199     platform = "winapplication";
 200 #else
 201     platform = "application";
 202 #endif
 203     SUIT_MessageBox::warning( desktop(), tr("WRN_WARNING"),
 204                               tr("EXTERNAL_BROWSER_CANNOT_SHOW_PAGE").
 205                               arg(app->resourceMgr()->stringValue("ExternalBrowser",
 206                                                                   platform)).
 207                               arg(myHelpFileName) );
 208   }
 209 }
 210
 211 //=======================================================================
 212 // name    : initDialog
 213 // Purpose :
 214 //=======================================================================
 215 void SMESHGUI_Operation::initDialog()
 216 {
 217 }
 218
 219 //================================================================
 220 // name    : setIsApplyAndClose
 221 // Purpose : Set value of the flag indicating that the dialog is
 222 //           accepted by Apply & Close button
 223 //================================================================
 224 void SMESHGUI_Operation::setIsApplyAndClose( const bool theFlag )
 225 {
 226   myIsApplyAndClose = theFlag;
 227 }
 228
 229 //================================================================
 230 // name    : isApplyAndClose
 231 // Purpose : Get value of the flag indicating that the dialog is
 232 //           accepted by Apply & Close button
 233 //================================================================
 234 bool SMESHGUI_Operation::isApplyAndClose() const
 235 {
 236   return myIsApplyAndClose;
 237 }
 238
 239 /*!
 240  * \brief Verifies whether study of operation is locked
 241   * \param theMess - specifies whether message box must be shown if study is locked
 242   * \return State of study.
 243 *
 244 * Verifies whether study of operation is locked. If second parameter is TRUE and study
 245 * is locked when corresponding message box appears
 246 */
 247 bool SMESHGUI_Operation::isStudyLocked( const bool theMess ) const
 248 {
 249   if ( studyDS() )
 250   {
 251     if ( studyDS()->GetProperties()->IsLocked() )
 252     {
 253       if ( theMess )
 254         SUIT_MessageBox::warning( SMESHGUI::desktop(), tr( "WRN_WARNING" ),
 255                                   tr( "WRN_STUDY_LOCKED" ) );
 256       return true;
 257     }
 258   }
 259
 260   return false;
 261 }
 262
 263 /*!
 264  * \brief Verifies whether given operator is valid for this one
 265   * \param theOtherOp - other operation
 266   * \return Returns TRUE if the given operator is valid for this one, FALSE otherwise
 267 *
 268 * Virtual method redefined from base class verifies whether given operator is valid for
 269 * this one (i.e. can be started "above" this operator). In current implementation method
 270 * retuns false if theOtherOp operation is not intended for deleting objects or mesh
 271 * elements.
 272 */
 273 bool SMESHGUI_Operation::isValid( SUIT_Operation* theOtherOp ) const
 274 {
 275   static QStringList anOps;
 276   if ( anOps.count() == 0 )
 277   {
 278     anOps.append( "SMESHGUI_DeleteOp" );
 279     // to do add other operations here
 280   }
 281
 282   return ( theOtherOp &&
 283          ( ( theOtherOp->inherits("SMESHGUI_Operation") && ( !anOps.contains(theOtherOp->metaObject()->className() ) || anOps.contains(metaObject()->className()) ) ) ||
 284            ( theOtherOp->inherits("LightApp_ShowHideOp") ) ) );
 285
 286   return true;
 287 }