copasi/UI/copasiui3window.h

Go to the documentation of this file.

// Begin CVS Header
//   $Source: /fs/turing/cvs/copasi_dev/copasi/UI/copasiui3window.h,v $
//   $Revision: 1.95.2.1 $
//   $Name: Build-33 $
//   $Author: aekamal $
//   $Date: 2010/09/27 13:44:55 $
// End CVS Header

// Copyright (C) 2010 by Pedro Mendes, Virginia Tech Intellectual
// Properties, Inc., University of Heidelberg, and The University
// of Manchester.
// All rights reserved.

// Copyright (C) 2008 by Pedro Mendes, Virginia Tech Intellectual
// Properties, Inc., EML Research, gGmbH, University of Heidelberg,
// and The University of Manchester.
// All rights reserved.

// Copyright (C) 2001 - 2007 by Pedro Mendes, Virginia Tech Intellectual
// Properties, Inc. and EML Research, gGmbH.
// All rights reserved.

#include <string>

#include <QMainWindow>
#include <QModelIndex>
#include <QMap>

#ifdef COPASI_SBW_INTEGRATION
#include <QApplication>
#include <QEvent>

#define WIN32_LEAN_AND_MEAN
#include <SBW/SBW.h>
#undef DELETE
#undef ERROR
#undef TRUE
#undef FALSE
using namespace SystemsBiologyWorkbench;
#else
class SBWListener;
#endif  // COPASI_SBW_INTEGRATION

#include "../MIRIAM/CMIRIAMResource.h"

//class QToolButton;
class Q3ListViewItem;
class ListViews;
class DataModelGUI;
class SliderDialog;
class QAction;
class ObjectBrowserDialog;
class QComboBox;
class CMIRIAMResources;
class CMIRIAMResourceObject;
class QEvent;
class QActionGroup;
class QThread;

class CopasiUI3Window : public QMainWindow
#ifdef COPASI_SBW_INTEGRATION
    // A SBW listener can catch messages from SBW ... used here to allow COPASI to be shut down
    , public SBWListener
#endif // COPASI_SBW_INTEGRATION

{
  Q_OBJECT

public:
  static CopasiUI3Window * create();
  ~CopasiUI3Window();

  DataModelGUI* getDataModel();

  ListViews* getMainWidget();

  void checkPendingMessages();
  void suspendAutoSave(const bool & suspend);

  void importSBMLFromString(const std::string & sbmlDocumentText);

  std::string exportSBMLToString();

  QThread * getMainThread() const;

protected:
  virtual void closeEvent(QCloseEvent* e);

  /*
   * This is used for doing drag-and-drop action (16.04.10)
   */
  void dragEnterEvent(QDragEnterEvent *event);
  void dropEvent(QDropEvent *event);

public slots:
  void slotShowSliders(bool flag);

  void slotObjectBrowserDialogWasClosed();

  void autoSave();

protected slots:
  void slotFileOpen(QString file = QString::null);
  void slotFileExamplesCopasiFiles(QString file = QString::null);
  void slotFileExamplesSBMLFiles(QString file = QString::null);
  bool slotFileSave();
  bool slotFileSaveAs(QString str = QString::null);
  void newDoc();
  void slotFilePrint();
  void slotImportSBML(QString file = QString::null);
  void slotExportSBML();
  void slotExportMathModel();
  void slotTutorialWizard();
  void about();
  void license();
  void aboutQt();
  void slotQuit();
  void slotPreferences();
  void slotConvertToIrreversible();
  void listViewsFolderChanged(const QModelIndex & index);
  void slotOpenRecentFile(QAction * pAction);
  void slotOpenRecentSBMLFile(QAction * pAction);
  bool slotRegistration();
  void slotCheckModel();
  void slotApplyInitialState();
  void slotUpdateInitialState();
  void slotFrameworkChanged(int index);
  void slotCapture();
  void slotUpdateMIRIAM();
  void slotExpandModel();
  void slotFontSelection();

#ifdef WITH_MERGEMODEL
  void slotAddFileOpen(QString file = QString::null);
  void slotAddModel();
  void slotMergeModels();
#endif

  // SBW: handle the custom events
  void customEvent(QEvent *);

  void slotShowObjectBrowserDialog(bool flag);

private:
  CopasiUI3Window();

  void createActions();
  void createToolBar();
  void createMenuBar();

  void CleanUp();

  void updateTitle();

  void setApplicationFont();

  DataModelGUI* mpDataModelGUI; // to keep track of the data model..
  ListViews *mpListView;
  QComboBox * mpBoxSelectFramework;

  int newFlag;
  QString FixedTitle;

  QAction* mpaNew;
  QAction* mpaOpen;
  QAction* mpaOpenCopasiFiles;
  QAction* mpaOpenSBMLFiles;
  QAction* mpaSave;
  QAction* mpaSaveAs;
  QAction* mpaImportSBML;
  QAction* mpaExportSBML;
  QAction* mpaExportODE;
  QAction* mpaQuit;
  QAction* mpaObjectBrowser;
  QAction* mpaSliders;
  QAction* mpaCheckModel;
  QAction* mpaApplyInitialState;
  QAction* mpaUpdateInitialState;
  QAction* mpaCapture;
  QAction* mpaUpdateMIRIAM;
  QAction* mpaExpandModel;
  QAction* mpaFontSelectionDialog;

#ifdef WITH_MERGEMODEL
  QAction* mpaAddModel;
  QAction* mpaMergeModels;
#endif
  SliderDialog* mpSliders;
  ObjectBrowserDialog * mpObjectBrowser;

  bool mSaveAsRequired;
  QTimer *mpAutoSaveTimer;
  bool mSuspendAutoSave;

  //menus
  QMenu * mpMenuExamples;
  QMenu * mpMenuRecentFiles;
  QMap< QAction *, int > mRecentFilesActionMap;
  QActionGroup * mpRecentFilesActionGroup;
  void refreshRecentFileMenu();

  QMenu * mpMenuRecentSBMLFiles;
  QMap< QAction *, int > mRecentSBMLFilesActionMap;
  QActionGroup * mpRecentSBMLFilesActionGroup;
  void refreshRecentSBMLFileMenu();

  QMenu * mpTools;

  CMIRIAMResources * mpMIRIAMResources;

  QThread * mpMainThread;

#ifdef COPASI_SBW_INTEGRATION
public:
  class QSBWSBMLEvent : public QEvent
  {
  public:
    QSBWSBMLEvent(const std::string & SBMLModel);

    const std::string & getSBMLModel() const;

  private:
    std::string mSBML;
  };

  class QSBWShutdownEvent: public QEvent
  {
  public:
    QSBWShutdownEvent();

  };

  // We expose 2 methods to SBW, one to load an SBML file
  SystemsBiologyWorkbench::DataBlockWriter sbwAnalysis(SystemsBiologyWorkbench::Module from,
      SystemsBiologyWorkbench::DataBlockReader reader);

  // and another to return the SBML file COAPSI is currently working with
  SystemsBiologyWorkbench::DataBlockWriter sbwGetSBML(SystemsBiologyWorkbench::Module from,
      SystemsBiologyWorkbench::DataBlockReader reader);

  // This method must not be renamed as SBW calls it by name
  void registerMethods(SystemsBiologyWorkbench::MethodTable<CopasiUI3Window> & table);

  // as part of the SBWListener we tell SBW here, that we want to react on the shutdown event
  virtual void onShutdown();

private:
  void sbwConnect();

  void sbwDisconnect();

  void sbwRegister();

  void sbwUnregister(const std::string & moduleName) const;

  void sbwRefreshMenu();

  std::vector< SystemsBiologyWorkbench::DataBlockReader > sbwFindServices(const std::string & category,
      const bool & recursive);

protected slots:
  void sbwSlotMenuTriggered(QAction * pAction);

private:
  SystemsBiologyWorkbench::ModuleImpl * mpSBWModule;

  QStringList mSBWAnalyzerModules;

  QStringList mSBWAnalyzerServices;

  QMap< QAction *, int > mSBWActionMap;

  QActionGroup * mpSBWActionGroup;

  QMenu * mpSBWMenu;

  QAction * mpSBWAction;

  bool mSBWIgnoreShutdownEvent;

#endif // COPASI_SBW_INTEGRATION

};