Salome HOME
Update from BR_V5_DEV 13Feb2009
[modules/gui.git] / src / SALOME_SWIG / SALOMEGUI_Swig.i
1 //  Copyright (C) 2007-2008  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 //  SALOME SALOMEGUI : implementation of desktop and GUI kernel
23 //  File   : SALOMEGUI_Swig.i
24 //  Author : Paul RASCLE, EDF
25 //
26 %{
27 #include "SALOMEGUI_Swig.hxx"
28 %}
29
30 %include "cpointer.i"
31
32 /* Exception handler for all functions */
33 %exception {
34   class PyAllowThreadsGuard {
35    public:
36     // Py_BEGIN_ALLOW_THREADS
37     PyAllowThreadsGuard() { _save = PyEval_SaveThread(); }
38     // Py_END_ALLOW_THREADS
39     ~PyAllowThreadsGuard() { PyEval_RestoreThread( _save ); }
40    private:
41     PyThreadState* _save;
42   };
43
44   PyAllowThreadsGuard guard;
45
46   $action
47 }
48
49 class SALOMEGUI_Swig
50 {
51 public:
52   SALOMEGUI_Swig();
53   virtual ~SALOMEGUI_Swig();
54
55   /* check GUI */
56   bool hasDesktop();
57
58   /* update object browser*/
59   void updateObjBrowser(bool);
60
61   /* get active study */
62   int getActiveStudyId();
63   const char *getActiveStudyName();
64
65   /* get component name/username */
66   const char* getComponentName( const char* ComponentUserName );
67   const char* getComponentUserName( const char* ComponentName );
68
69   /* selection processing */
70   int SelectedCount();
71   const char *getSelected(int i);
72   void AddIObject(const char *Entry);
73   void RemoveIObject(const char *Entry);
74   void ClearIObjects();
75
76   /* display/erase */
77   void Display(const char *Entry);
78   void DisplayOnly(const char *Entry);
79   void Erase(const char *Entry);
80   void DisplayAll();
81   void EraseAll();
82   bool IsInCurrentView(const char *Entry);
83   void UpdateView();
84
85   /* view operations */
86   void FitAll();
87   void ResetView();
88   void ViewTop();
89   void ViewBottom();
90   void ViewLeft();
91   void ViewRight();
92   void ViewFront();
93   void ViewBack();
94 };