Repository URL to install this package:
|
Version:
6.3.5.2-2 ▾
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>LibreOffice: uno/Enterable.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">LibreOffice
</div>
<div id="projectbrief">LibreOffice 6.3 SDK C/C++ API Reference</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_faf84ad86f93adaf6613aa4211155a5e.html">uno</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Enterable.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00431.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * This file is part of the LibreOffice project.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This Source Code Form is subject to the terms of the Mozilla Public</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * License, v. 2.0. If a copy of the MPL was not distributed with this</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * file, You can obtain one at http://mozilla.org/MPL/2.0/.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * This file incorporates work covered by the following license notice:</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * with this work for additional information regarding copyright</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * ownership. The ASF licenses this file to you under the Apache</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * License, Version 2.0 (the "License"); you may not use this file</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * except in compliance with the License. You may obtain a copy of</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * the License at http://www.apache.org/licenses/LICENSE-2.0 .</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef INCLUDED_UNO_ENTERABLE_H</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_UNO_ENTERABLE_H</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="a00433.html">uno/environment.h</a>"</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="a00431.html#a8a24a898cb8e9b36fc9e450a85bef380"> 38</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="a00431.html#a8a24a898cb8e9b36fc9e450a85bef380">uno_Enterable_enter</a> (<span class="keywordtype">void</span> * context);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="a00431.html#a43424074f509960815ee7e5034b3a959"> 47</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="a00431.html#a43424074f509960815ee7e5034b3a959">uno_Enterable_leave</a> (<span class="keywordtype">void</span> * context);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="a00431.html#aa72e3a710031e48716221b05637da2d4"> 58</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="a00431.html#aa72e3a710031e48716221b05637da2d4">uno_Enterable_callInto_v</a>(<span class="keywordtype">void</span> * context, <a class="code" href="a00433.html#ab9b865bd93a54c6b944a0c2a7e56563b">uno_EnvCallee</a> * pCallee, va_list * pParam);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="a00431.html#a6dc8ae3dfbc0cf9fae077b386d3741c6"> 69</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="a00431.html#a6dc8ae3dfbc0cf9fae077b386d3741c6">uno_Enterable_callOut_v</a> (<span class="keywordtype">void</span> * context, <a class="code" href="a00433.html#ab9b865bd93a54c6b944a0c2a7e56563b">uno_EnvCallee</a> * pCallee, va_list * pParam);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="a00431.html#ab0a2639a88519e99402b5e98bb5dbf3b"> 81</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="a00431.html#ab0a2639a88519e99402b5e98bb5dbf3b">uno_Enterable_isValid_v</a> (<span class="keywordtype">void</span> * context, rtl_uString ** ppReason);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="a00202.html"> 89</a></span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> {</div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="a00202.html#a20fda2f16175d9fca02dcbc763eb3b0f"> 91</a></span>  <a class="code" href="a00431.html#a8a24a898cb8e9b36fc9e450a85bef380">uno_Enterable_enter</a> * <a class="code" href="a00202.html#a20fda2f16175d9fca02dcbc763eb3b0f">m_enter</a>;</div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="a00202.html#ae39c0d0e8e179f7df50eb6198f7c6c04"> 92</a></span>  <a class="code" href="a00431.html#a43424074f509960815ee7e5034b3a959">uno_Enterable_leave</a> * <a class="code" href="a00202.html#ae39c0d0e8e179f7df50eb6198f7c6c04">m_leave</a>;</div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="a00202.html#ae156f9cf97ccc9a1bc359f5d22308530"> 93</a></span>  <a class="code" href="a00431.html#aa72e3a710031e48716221b05637da2d4">uno_Enterable_callInto_v</a> * <a class="code" href="a00202.html#ae156f9cf97ccc9a1bc359f5d22308530">m_callInto_v</a>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="a00202.html#a8165a9ab39a8439a5404986272caa5bb"> 94</a></span>  <a class="code" href="a00431.html#a6dc8ae3dfbc0cf9fae077b386d3741c6">uno_Enterable_callOut_v</a> * <a class="code" href="a00202.html#a8165a9ab39a8439a5404986272caa5bb">m_callOut_v</a>;</div>
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="a00202.html#a70c2ac3c7a8f357a1665ebd23c47e9b9"> 95</a></span>  <a class="code" href="a00431.html#ab0a2639a88519e99402b5e98bb5dbf3b">uno_Enterable_isValid_v</a> * <a class="code" href="a00202.html#a70c2ac3c7a8f357a1665ebd23c47e9b9">m_isValid</a>;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> }</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <a class="code" href="a00202.html">uno_Enterable</a>;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">/* vim:set shiftwidth=4 softtabstop=4 expandtab: */</span></div>
<div class="ttc" id="a00431_html_a43424074f509960815ee7e5034b3a959"><div class="ttname"><a href="a00431.html#a43424074f509960815ee7e5034b3a959">uno_Enterable_leave</a></div><div class="ttdeci">void uno_Enterable_leave(void *context)</div><div class="ttdoc">Generic function type declaration for leaving an Environment. </div><div class="ttdef"><b>Definition:</b> Enterable.h:47</div></div>
<div class="ttc" id="a00431_html_a6dc8ae3dfbc0cf9fae077b386d3741c6"><div class="ttname"><a href="a00431.html#a6dc8ae3dfbc0cf9fae077b386d3741c6">uno_Enterable_callOut_v</a></div><div class="ttdeci">void uno_Enterable_callOut_v(void *context, uno_EnvCallee *pCallee, va_list *pParam)</div><div class="ttdoc">Generic function type declaration for calling out of an Environment. </div><div class="ttdef"><b>Definition:</b> Enterable.h:69</div></div>
<div class="ttc" id="a00431_html_a8a24a898cb8e9b36fc9e450a85bef380"><div class="ttname"><a href="a00431.html#a8a24a898cb8e9b36fc9e450a85bef380">uno_Enterable_enter</a></div><div class="ttdeci">void uno_Enterable_enter(void *context)</div><div class="ttdoc">Generic function type declaration for entering an Environment. </div><div class="ttdef"><b>Definition:</b> Enterable.h:38</div></div>
<div class="ttc" id="a00433_html_ab9b865bd93a54c6b944a0c2a7e56563b"><div class="ttname"><a href="a00433.html#ab9b865bd93a54c6b944a0c2a7e56563b">uno_EnvCallee</a></div><div class="ttdeci">void uno_EnvCallee(va_list *pParam)</div><div class="ttdoc">Typedef for variable argument function. </div><div class="ttdef"><b>Definition:</b> environment.h:338</div></div>
<div class="ttc" id="a00202_html_ae156f9cf97ccc9a1bc359f5d22308530"><div class="ttname"><a href="a00202.html#ae156f9cf97ccc9a1bc359f5d22308530">uno_Enterable::m_callInto_v</a></div><div class="ttdeci">uno_Enterable_callInto_v * m_callInto_v</div><div class="ttdef"><b>Definition:</b> Enterable.h:93</div></div>
<div class="ttc" id="a00202_html_a70c2ac3c7a8f357a1665ebd23c47e9b9"><div class="ttname"><a href="a00202.html#a70c2ac3c7a8f357a1665ebd23c47e9b9">uno_Enterable::m_isValid</a></div><div class="ttdeci">uno_Enterable_isValid_v * m_isValid</div><div class="ttdef"><b>Definition:</b> Enterable.h:95</div></div>
<div class="ttc" id="a00431_html_ab0a2639a88519e99402b5e98bb5dbf3b"><div class="ttname"><a href="a00431.html#ab0a2639a88519e99402b5e98bb5dbf3b">uno_Enterable_isValid_v</a></div><div class="ttdeci">int uno_Enterable_isValid_v(void *context, rtl_uString **ppReason)</div><div class="ttdoc">Generic function type declaration for checking if calling on managed object is valid. </div><div class="ttdef"><b>Definition:</b> Enterable.h:81</div></div>
<div class="ttc" id="a00202_html_a20fda2f16175d9fca02dcbc763eb3b0f"><div class="ttname"><a href="a00202.html#a20fda2f16175d9fca02dcbc763eb3b0f">uno_Enterable::m_enter</a></div><div class="ttdeci">uno_Enterable_enter * m_enter</div><div class="ttdef"><b>Definition:</b> Enterable.h:91</div></div>
<div class="ttc" id="a00431_html_aa72e3a710031e48716221b05637da2d4"><div class="ttname"><a href="a00431.html#aa72e3a710031e48716221b05637da2d4">uno_Enterable_callInto_v</a></div><div class="ttdeci">void uno_Enterable_callInto_v(void *context, uno_EnvCallee *pCallee, va_list *pParam)</div><div class="ttdoc">Generic function type declaration for calling into an Environment. </div><div class="ttdef"><b>Definition:</b> Enterable.h:58</div></div>
<div class="ttc" id="a00433_html"><div class="ttname"><a href="a00433.html">environment.h</a></div></div>
<div class="ttc" id="a00202_html_ae39c0d0e8e179f7df50eb6198f7c6c04"><div class="ttname"><a href="a00202.html#ae39c0d0e8e179f7df50eb6198f7c6c04">uno_Enterable::m_leave</a></div><div class="ttdeci">uno_Enterable_leave * m_leave</div><div class="ttdef"><b>Definition:</b> Enterable.h:92</div></div>
<div class="ttc" id="a00202_html_a8165a9ab39a8439a5404986272caa5bb"><div class="ttname"><a href="a00202.html#a8165a9ab39a8439a5404986272caa5bb">uno_Enterable::m_callOut_v</a></div><div class="ttdeci">uno_Enterable_callOut_v * m_callOut_v</div><div class="ttdef"><b>Definition:</b> Enterable.h:94</div></div>
<div class="ttc" id="a00202_html"><div class="ttname"><a href="a00202.html">uno_Enterable</a></div><div class="ttdoc">A struct pReserved needs to point to, if implementing a purpose environment. </div><div class="ttdef"><b>Definition:</b> Enterable.h:89</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>