Salome HOME
DCQ : Merge with Ecole_Ete_a6.
[modules/kernel.git] / idl / SALOME_Session.idl
index 81c95996c466b0b324340b982ef34a9824e9da87..f42ccde7ef4b37f1abcaab1db364ca19127109c2 100644 (file)
@@ -1,19 +1,31 @@
-//=============================================================================
-// File      : SALOME_Session.idl
-// Created   : mar jun 19 09:15:07 CEST 2001
-// Author    : Paul RASCLE, EDF
-// Project   : SALOME
-// Copyright : EDF 2001
-// $Header$
-//=============================================================================
+//  Copyright (C) 2003  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. 
+// 
+//  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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
+//
+//
+//
+//  File   : SALOME_Session.idl
+//  Author : Paul RASCLE, EDF
+//  $Header$
 
+#include "SALOME_Component.idl"
 
-//***//#include "VISU_Gen.idl"
-/*! \defgroup Kernel SALOME KERNEL module
-*/
-
-/*!  \ingroup Kernel 
-   
+/*!   
   This package contains interfaces used for management of the session in %SALOME application.
 */
 module SALOME
@@ -23,7 +35,9 @@ module SALOME
    This enumeration contains values defining the state of the session
   
 */ 
-  enum SessionState {asleep, running} ;
+  enum SessionState {asleep, /*! Session is inactive */
+                    running /*! Session is running */
+  } ;
 
 /*! \brief %Session State and Statistics
 
@@ -68,7 +82,11 @@ module SALOME
    Launches GUI in the session
 */
     void GetInterface(); 
-    //***//    VISU::VISU_Gen GetVisuGen();
+
+/*! 
+   Returns the Visu component
+*/
+    Engines::Component GetVisuComponent();
 
 /*! 
   Stops the %Session (It must be idle)