SUIT_Study.h

Go to the documentation of this file.

// Copyright (C) 2007-2026  CEA, EDF, OPEN CASCADE
//
// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef SUIT_STUDY_H
#define SUIT_STUDY_H
 
#include "SUIT.h"
 
#include <QList>
#include <QObject>
#include <QListIterator>
 
class SUIT_DataObject;
class SUIT_Application;
class SUIT_Operation;
 
#ifdef WIN32
#pragma warning( disable:4251 )
#endif
 
class SUIT_EXPORT SUIT_Study : public QObject
{
  Q_OBJECT
  
public:
  SUIT_Study( SUIT_Application* );
  virtual ~SUIT_Study();
 
  virtual int       id() const;
 
  SUIT_DataObject*  root() const;
  virtual QString   studyName() const;
  SUIT_Application* application() const;
 
  virtual bool      isSaved()  const;
  virtual bool      isModified() const;
  virtual void      Modified();
 
  virtual void      closeDocument( bool = true );
  virtual bool      openDocument( const QString& );
  virtual bool      createDocument( const QString& );
 
  bool              saveDocument();
  virtual bool      saveDocumentAs( const QString& );
 
  virtual void      update();
 
  virtual void      sendChangesNotification();
 
  // Autosave management
  void              setIsAutoSaving(const bool on = true);
  bool              isAutoSaving() const;
 
  // Operation management
  SUIT_Operation*   activeOperation() const;
  virtual void      abortAllOperations();
  const QList<SUIT_Operation*>& operations() const;
  
  virtual SUIT_Operation* blockingOperation( SUIT_Operation* ) const;
 
  bool              start( SUIT_Operation*, const bool check = true );
  bool              abort( SUIT_Operation* );
  bool              commit( SUIT_Operation* );
  bool              suspend( SUIT_Operation* );
  bool              resume( SUIT_Operation* );
 
  virtual void      restoreState(int savePoint);
 
signals:
  void              studyModified( SUIT_Study* );
 
protected:
  virtual void      setIsSaved( const bool );
  virtual void      setIsModified( const bool );
  virtual void      setRoot( SUIT_DataObject* );
  virtual void      setStudyName( const QString& );
 
  virtual void      operationStarted( SUIT_Operation* );
  virtual void      operationAborted( SUIT_Operation* );
  virtual void      operationStopped( SUIT_Operation* );
  virtual void      operationCommited( SUIT_Operation* );
 
  virtual bool      openTransaction();
  virtual bool      abortTransaction();
  virtual bool      hasTransaction() const;
  virtual bool      commitTransaction( const QString& = QString() );
 
private:
  typedef QList<SUIT_Operation*> Operations;
  void              stop( SUIT_Operation* );
 
private:
  int               myId;
  SUIT_Application* myApp;
  SUIT_DataObject*  myRoot;
  QString           myName;
  bool              myIsSaved;
  bool              myIsModified;
  Operations        myOperations;
  bool              myBlockChangeState;
  bool              myIsAutoSaving;   // whether the current study is being saved automatically
 
  friend class SUIT_Operation;
};
 
//******************************************************
 
#ifdef WIN32
#pragma warning( default:4251 )
#endif
 
#endif