idl/HELLO_Gen.idl

   1 // Copyright (C) 2007-2016  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, or (at your option) any later version.
  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
  23 #ifndef __HELLO_GEN__
  24 #define __HELLO_GEN__
  25
  26 /*!
  27   \defgroup EXAMPLES SALOME EXAMPLES components
  28 */
  29
  30 #include "SALOME_Component.idl"
  31 #include "SALOME_Exception.idl"
  32
  33 /*!
  34   \ingroup EXAMPLES
  35   This package contains the interface HELLO_ORB used
  36   for %HELLO component as an example in %SALOME application.
  37 */
  38 module HELLO_ORB
  39 {
  40   typedef sequence<SALOMEDS::SObject> object_list;
  41
  42   /*!
  43     \brief Operation result codes
  44   */
  45   enum status {
  46     OP_OK,                         //!< OK result
  47     OP_ERR_ALREADY_MET,            //!< ERROR: already met
  48     OP_ERR_DID_NOT_MEET,           //!< ERROR: did not meet yet
  49     OP_ERR_UNKNOWN                 //!< ERROR: other problems
  50   };
  51
  52   /*!
  53     \brief Interface of the %HELLO component
  54    */
  55   interface HELLO_Gen : Engines::EngineComponent
  56   {
  57     /*!
  58       \brief Say hello to \a name
  59       \param study SALOME study
  60       \param name person's name
  61       \return operation status
  62      */
  63     status hello( in SALOMEDS::Study study, in string name )
  64       raises (SALOME::SALOME_Exception);
  65
  66     /*!
  67       \brief Say goodbye to \a name
  68       \param study SALOME study
  69       \param name person's name
  70       \return operation status
  71      */
  72     status goodbye( in SALOMEDS::Study study, in string name )
  73       raises (SALOME::SALOME_Exception);
  74
  75     /*!
  76       \brief Copy or move objects to the specified position
  77
  78       This function is used in the drag-n-drop functionality.
  79
  80       \param what objects being copied/moved
  81       \param where parent object where objects are copied/moved to
  82       \param row position in the parent object's children list at which objects are copied/moved
  83       \param isCopy \c true if object are copied or \c false otherwise
  84     */
  85     void copyOrMove( in object_list what, in SALOMEDS::SObject where, in long row, in boolean isCopy );
  86   };
  87 };
  88
  89 #endif