cppu/inc/uno/Enterable.h

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Enterable.h,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_uno_Enterable_h
  32 #define INCLUDED_uno_Enterable_h
  33
  34 #include "uno/environment.h"
  35
  36
  37 #ifdef __cplusplus
  38 extern "C"
  39 {
  40 #endif
  41
  42
  43 /** Generic function type declaration for entering an Environment.
  44     (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Environment_Stack)
  45
  46     @param context
  47     @since UDK 3.2.7
  48 */
  49 typedef void uno_Enterable_enter     (void * context);
  50
  51
  52 /** Generic function type declaration for levaing an Environment.
  53     (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Environment_Stack)
  54
  55     @param context
  56     @since UDK 3.2.7
  57 */
  58 typedef void uno_Enterable_leave     (void * context);
  59
  60
  61 /** Generic function type declaration for calling into an Environment.
  62     (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Environment_Stack)
  63
  64     @param context
  65     @param pCallee  the function to be called
  66     @param pParam   the parameter pointer to be passed to the function
  67     @since UDK 3.2.7
  68 */
  69 typedef void uno_Enterable_callInto_v(void * context, uno_EnvCallee * pCallee, va_list * pParam);
  70
  71
  72 /** Generic function type declaration for calling out of an Environment.
  73     (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Environment_Stack)
  74
  75     @param context
  76     @param pCallee  the function to be called
  77     @param pParam   the parameter pointer to be passed to the function
  78     @since UDK 3.2.7
  79 */
  80 typedef void uno_Enterable_callOut_v (void * context, uno_EnvCallee * pCallee, va_list * pParam);
  81
  82
  83 /** Generic function type declaration for checking if calling on managed object is
  84     valid.
  85     (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Environment_Stack)
  86
  87     @param  context
  88     @param  ppReason  the reason, in case calling is not valid
  89     @return           0 == calling is not valid, 1 == calling is valid
  90     @since UDK 3.2.7
  91 */
  92 typedef int  uno_Enterable_isValid_v (void * context, rtl_uString ** ppReason);
  93
  94
  95 /** A struct pReserved needs to point to, if implementing a purpose environment.
  96     (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Environment_Stack)
  97
  98     @since UDK 3.2.7
  99 */
 100 typedef struct
 101 {
 102     uno_Enterable_enter      * m_enter;
 103     uno_Enterable_leave      * m_leave;
 104     uno_Enterable_callInto_v * m_callInto_v;
 105     uno_Enterable_callOut_v  * m_callOut_v;
 106     uno_Enterable_isValid_v  * m_isValid;
 107 }
 108 uno_Enterable;
 109
 110
 111 #ifdef __cplusplus
 112 }
 113 #endif
 114
 115 #endif