cppu/inc/uno/Enterable.h

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