]> SALOME platform Git repositories - modules/gui.git/blob - src/GuiHelpers/StandardApp_Module.hxx
Salome HOME
Documentation is optional
[modules/gui.git] / src / GuiHelpers / StandardApp_Module.hxx
1 // Copyright (C) 2011-2013  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19 // Author : Guillaume Boulant (EDF) 
20
21 #ifndef _STANDARDAPP_MODULE_HXX_
22 #define _STANDARDAPP_MODULE_HXX_
23
24 #include <SUIT_ResourceMgr.h>
25 #include <SalomeApp_Module.h>
26
27 #include <SALOMEconfig.h>
28 #include CORBA_SERVER_HEADER(SALOME_Component)
29
30 #include <QString>
31
32 #include "SalomeGuiHelpers.hxx"
33
34 #define UNSPECIFIED_INT -1
35
36 /*!
37  * This class is provided as the base class for the standard gui part
38  * of a SALOME module. To define a gui part, you just have to
39  * implement the virtual functions:
40  * - getEngine() to specify the engine component associated to this module
41  * - createModuleActions(...) to specify the action functions
42  * - createModuleWidgets(...) to specify special additionnal widgets
43  *
44  * The gui part of a SALOME module is an extension of the SALOME
45  * client Application for this module. Technically speaking, it
46  * consists in a plugin that provides a derived class of CAM_Module
47  * (provided by the GUI module).
48  *
49  * A standard gui is the standard design for most of SALOME module
50  * (object browser on the left, viewer on the rigth, python console on
51  * the bottom, and toolbox in the toolbar with standard definition of
52  * the tool function). This standard design suggests also to specify
53  * the engine associated to the module by implementing the virtual
54  * pure function getEngine(). The engine of a module is the SALOME
55  * component that is associated to the study component for this
56  * module, and generally which is responsible for the persistency
57  * functions or data management for the module.
58  *
59  * See a use case example in the test module Xsalome provided by the
60  * test package (tst/module/gui/Xsalome.hxx and
61  * tst/module/gui/factory.cxx in the XSALOME library).
62  */
63 class SALOMEGUIHELPERS_EXPORT StandardApp_Module: public SalomeApp_Module
64 {
65   Q_OBJECT
66
67 public:
68
69   // ================================================================
70   // This part defines the standard interface of the SalomeApp_Module
71   // ================================================================
72
73   StandardApp_Module();
74   void    initialize( CAM_Application* );
75   QString engineIOR() const;
76   virtual void  windows( QMap<int, int>& theMap ) const;
77
78 public slots:
79   bool    deactivateModule( SUIT_Study* );
80   bool    activateModule( SUIT_Study* );
81
82   // ================================================================
83   // This part defines the specific interface of this class
84   // ================================================================
85
86 public:
87   /* Creates an action with standard default values */
88   int createStandardAction(const QString& label,
89                            QObject * slotobject,
90                            const char* slotmember,
91                            const QString& iconName=QString(),
92                            const QString& tooltip=QString(),
93                            const int identifier=ACTIONID_UNDEFINED);
94
95   void addActionInToolbar(int actionId);
96   void addActionInMenubar(int actionId, int menuId=UNSPECIFIED_INT);
97   void addActionInPopupMenu(int actionId,const QString& rule="client='ObjectBrowser'");
98
99 protected:
100   /* Implement this to create additionnal widget (e.g. docked widget) */
101   virtual void createModuleWidgets();
102   /* Implement this to define the actions for this gui */
103   virtual void createModuleActions();
104
105   /* Use this to create a root entry in the study for this module */
106   void createStudyComponent(SUIT_Study*);
107   /* Implement this to say if study component entry should be created
108      at activation step */
109   virtual bool createStudyComponentAtActivation();
110
111   /* The engine is the SALOME component associated to the study */
112   virtual Engines::EngineComponent_ptr getEngine() const = 0;
113   // Note that the function getEngine() is virtual pure and must be
114   // implemented in the specific inherited classes. Note also that the
115   // const flag is required because getEngine is used by functions
116   // with const flags (see for ex: engineIOR()).
117   virtual QString studyIconName();
118
119   QIcon createIcon(const QString& iconName);
120   int newActionId();
121
122   enum DockLayoutType {
123     DOCKLAYOUT_BOTTOM_HLARGE, // Bottom is Horizontal Large
124     DOCKLAYOUT_LEFT_VLARGE,   // Left is Vertical Large
125   };
126   virtual void setDockLayout(DockLayoutType layoutType);
127   virtual void unsetDockLayout();
128   
129   SUIT_ResourceMgr* _resourceMgr;
130   int _defaultMenuId;
131   int _defaultToolbarId;
132
133   static int ACTIONID_DEFAULT_INIT_VALUE;
134   static int ACTIONID_UNDEFINED;
135
136 private:
137   int _actionId_internalCount;
138   Qt::DockWidgetArea _areaAtBottomLeftCorner;
139   Qt::DockWidgetArea _areaAtBottomRightCorner;
140
141   // =========================================================
142   // This part defines slots for test purposes
143   // =========================================================
144
145 protected slots:
146   void OnTest();
147 };
148
149 #endif