LibreOffice LibreOffice 6.1 SDK C/C++ API Reference

Enterable.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20 #ifndef INCLUDED_UNO_ENTERABLE_H
21 #define INCLUDED_UNO_ENTERABLE_H
22
23 #include "uno/environment.h"
24
25
26 #ifdef __cplusplus
27 extern "C"
28 {
29 #endif
30
31
38 typedef void uno_Enterable_enter (void * context);
39
40
47 typedef void uno_Enterable_leave (void * context);
48
49
58 typedef void uno_Enterable_callInto_v(void * context, uno_EnvCallee * pCallee, va_list * pParam);
59
60
69 typedef void uno_Enterable_callOut_v (void * context, uno_EnvCallee * pCallee, va_list * pParam);
70
71
81 typedef int uno_Enterable_isValid_v (void * context, rtl_uString ** ppReason);
82
83
89 typedef struct
90 {
91 uno_Enterable_enter * m_enter;
92 uno_Enterable_leave * m_leave;
93 uno_Enterable_callInto_v * m_callInto_v;
94 uno_Enterable_callOut_v * m_callOut_v;
95 uno_Enterable_isValid_v * m_isValid;
96 }
97 uno_Enterable;
98
99
100 #ifdef __cplusplus
101 }
102 #endif
103
104 #endif
105
106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
uno_Enterable_callOut_v
void uno_Enterable_callOut_v(void *context, uno_EnvCallee *pCallee, va_list *pParam)
Generic function type declaration for calling out of an Environment.
Definition: Enterable.h:69
uno_Enterable
A struct pReserved needs to point to, if implementing a purpose environment.
Definition: Enterable.h:89
uno_Enterable::m_enter
uno_Enterable_enter * m_enter
Definition: Enterable.h:91
uno_Enterable::m_callOut_v
uno_Enterable_callOut_v * m_callOut_v
Definition: Enterable.h:94
uno_Enterable_enter
void uno_Enterable_enter(void *context)
Generic function type declaration for entering an Environment.
Definition: Enterable.h:38
environment.h
uno_Enterable::m_callInto_v
uno_Enterable_callInto_v * m_callInto_v
Definition: Enterable.h:93
uno_Enterable_callInto_v
void uno_Enterable_callInto_v(void *context, uno_EnvCallee *pCallee, va_list *pParam)
Generic function type declaration for calling into an Environment.
Definition: Enterable.h:58
uno_Enterable_isValid_v
int uno_Enterable_isValid_v(void *context, rtl_uString **ppReason)
Generic function type declaration for checking if calling on managed object is valid.
Definition: Enterable.h:81
uno_Enterable::m_leave
uno_Enterable_leave * m_leave
Definition: Enterable.h:92
uno_Enterable::m_isValid
uno_Enterable_isValid_v * m_isValid
Definition: Enterable.h:95
uno_Enterable_leave
void uno_Enterable_leave(void *context)
Generic function type declaration for leaving an Environment.
Definition: Enterable.h:47
uno_EnvCallee
void uno_EnvCallee(va_list *pParam)
Typedef for variable argument function.
Definition: environment.h:338