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