src/SUIT/SUIT_Application.h

   1 #ifndef SUIT_APPLICATION_H
   2 #define SUIT_APPLICATION_H
   3
   4 #include "SUIT.h"
   5 #include "SUIT_Study.h"
   6
   7 #include <qobject.h>
   8 #include <qwidget.h>
   9
  10 class QAction;
  11 class SUIT_Desktop;
  12 class SUIT_Convertor;
  13 class SUIT_ViewModel;
  14 class SUIT_ResourceMgr;
  15
  16 /*!
  17   An <b>Application</b> is a class which defines application configuration and behaviour.
  18   For example Application object defines what Viewers are used in this application, what auxilliary windows
  19   are present, how user can dial with them. Also Application object defines an sertain type of data structure by
  20   holding of pointer on an instance of SUIT_Study class (which represents Document data structure). In other words
  21   Application defines type of sata structure, type of used Viewers, type of main GUI widget (Desktop),
  22   and other auxilliary tools.
  23 */
  24
  25 class SUIT_EXPORT SUIT_Application : public QObject
  26 {
  27   Q_OBJECT
  28
  29 public:
  30   SUIT_Application();
  31   virtual ~SUIT_Application();
  32
  33   //! Returns main widget (Desktop) of the application (if it exists)
  34   virtual SUIT_Desktop* desktop();
  35
  36   /*! Returns FALSE if applic ation can not be closed (because of non saved data for example).
  37       This method called by SUIT_Session whin closing of application was requested. */
  38   virtual bool          isPossibleToClose();
  39
  40   virtual void          closeApplication();
  41
  42   //! Returns active Study. If Application supports wirking with several studies this method should be redefined
  43   virtual SUIT_Study*   activeStudy() const;
  44
  45   //! Returns Name of application. Using is not defined.
  46   virtual QString       applicationName() const = 0;
  47
  48   virtual QString       applicationVersion() const;
  49
  50   //! Shows the application's main widget. For non GUI application must be redefined.
  51   virtual void          start();
  52
  53   //! Loads document <theFileName> into active Study. If Study is empty - creates it.
  54   virtual bool          useFile( const QString& );
  55
  56   //! Creates new empty Study if active Study = 0
  57   virtual void          createEmptyStudy();
  58
  59   /*! Returns number of Studies.
  60    *  Must be redefined in Applications which support several studies for one Application instance. */
  61   virtual int           getNbStudies() const;
  62
  63   SUIT_ResourceMgr*     resourceMgr() const;
  64
  65   /*! Returns instance of data object Convertor class according to given Viewer.
  66       If convertation is not supported returns 0. */
  67   virtual SUIT_Convertor* getConvertor(const SUIT_ViewModel* theViewer) { return 0; }
  68
  69   //! Puts the message to the status bar
  70   void putInfo ( const QString&, const int = 0 );
  71
  72   //! Invokes application-specific "Open/Save" file dialog and returns the selected file name.
  73   virtual QString getFileName( bool open, const QString& initial, const QString& filters,
  74                                const QString& caption, QWidget* parent ) = 0;
  75
  76 signals:
  77   void                  applicationClosed( SUIT_Application* );
  78   void                  activated( SUIT_Application* );
  79
  80 protected:
  81   SUIT_Application*     startApplication( int, char** ) const;
  82   SUIT_Application*     startApplication( const QString&, int, char** ) const;
  83
  84   void                  setDesktop( SUIT_Desktop* );
  85
  86   //! Creates a new Study instance. Must be redefined in new application according to its Study type.
  87   virtual SUIT_Study*   createNewStudy();
  88   virtual void          setActiveStudy( SUIT_Study* );
  89
  90   int                   createTool( const QString& );
  91   int                   createTool( const int, const int, const int = -1 );
  92   int                   createTool( const int, const QString&, const int = -1 );
  93   int                   createTool( QAction*, const int, const int = -1, const int = -1 );
  94   int                   createTool( QAction*, const QString&, const int = -1, const int = -1 );
  95
  96   int                   createMenu( const QString&, const int, const int = -1, const int = -1, const int = -1 );
  97   int                   createMenu( const QString&, const QString&, const int = -1, const int = -1, const int = -1 );
  98   int                   createMenu( const int, const int, const int = -1, const int = -1 );
  99   int                   createMenu( const int, const QString&, const int = -1, const int = -1 );
 100   int                   createMenu( QAction*, const int, const int = -1, const int = -1, const int = -1 );
 101   int                   createMenu( QAction*, const QString&, const int = -1, const int = -1, const int = -1 );
 102
 103   void                  setMenuShown( QAction*, const bool );
 104   void                  setMenuShown( const int, const bool );
 105   void                  setToolShown( QAction*, const bool );
 106   void                  setToolShown( const int, const bool );
 107
 108   static QAction*       separator();
 109   QAction*              action( const int ) const;
 110   int                   actionId( const QAction* ) const;
 111   void                  registerAction( const int, QAction* );
 112   QAction*              createAction( const int, const QString&, const QIconSet&, const QString&,
 113                                       const QString&, const int, QObject* = 0,
 114                                       const bool = false, QObject* = 0, const char* = 0 );
 115
 116 private slots:
 117   void                  onDesktopActivated();
 118
 119 private:
 120   SUIT_Study*           myStudy;
 121   SUIT_Desktop*         myDesktop;
 122 };
 123
 124 //! This function must return a new application instance.
 125 extern "C"
 126 {
 127   typedef SUIT_Application* (*APP_CREATE_FUNC)( int, char** );
 128 }
 129
 130 #define APP_CREATE_NAME "createApplication"
 131
 132 #endif