Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 9366

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Global Functions in Namespace cppu in Sourcefile extract.hxx</title>
<link rel="stylesheet" type="text/css" href="../../cpp.css">
</head>
<body>
<div id="adc-cppref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="1" cellspacing="0">
<tr align="center" valign="top">
<td class="navimain">&nbsp;<a href="../../index.html">Overview</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="index.html">Namespace</a>&nbsp;</td>
<td class="navimainnone">&nbsp;Class&nbsp;</td>
<td class="navimain">&nbsp;<a href="../../index-files/index-1.html">Index</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../../help.html">Help</a>&nbsp;</td>
</tr>
</table>
<table class="navisub" cellpadding="0" cellspacing="3"></table>
<hr>
<div class="title"><h2>Global Functions in Namespace cppu<br>
in Sourcefile extract.hxx</h2>
</div><hr>
<dl class="member">
<dt class="member"><a name="any2bool-3228"> </a>any2bool</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../t-sal_Bool.html">sal_Bool</a> <strong>any2bool</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const ::com::sun::star::uno::<a href="../com/sun/star/uno/c-Any.html">Any</a> &amp; </td>
<td> rAny )</td>
</tr>
<tr>
<td/><td> throw( ::com::sun::star::lang::<a href="../../../../common/ref/com/sun/star/lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Description</dt>
<dd><pre>* extracts a boolean either as a sal_Bool or an integer from
* an any. If there is no sal_Bool or integer inside the any
* a ::com::sun::star::lang::IllegalArgumentException is thrown
*
</pre></dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="any2enum-3225"> </a>any2enum</dt>
<dd class="member"><dl>
<dt class="simple"><br>
<p><strong>template&lt; typename E &gt;</strong></p>
<br>
void <strong>any2enum</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>E &amp; </td>
<td> eRet,</td>
</tr>
<tr>
<td>const ::com::sun::star::uno::<a href="../com/sun/star/uno/c-Any.html">Any</a> &amp;</td>
<td>rAny )</td>
</tr>
<tr>
<td/><td> throw( ::com::sun::star::lang::<a href="../../../../common/ref/com/sun/star/lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd><pre>* Sets int32 from enum or int in any with additional typecheck
* &lt;BR&gt;
* </pre></dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rAny</td>
<td><pre><pre>enum or int
* </pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">eRet</td>
<td><pre><pre>the enum value as int. If there is not enum of the given type or
*                        a ::com::sun::star::lang::IllegalArgumentException is thrown
</pre></pre></td>
</tr>
</table>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="bool2any-3229"> </a>bool2any</dt>
<dd class="member"><dl>
<dt class="simple">::com::sun::star::uno::<a href="../com/sun/star/uno/c-Any.html">Any</a> <strong>bool2any</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../t-sal_Bool.html">sal_Bool</a> </td>
<td> bBool );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Description</dt>
<dd><pre>* Puts a boolean in an any.
*
* @DEPRECATED : use makeAny&lt; sal_Bool &gt;()
*
</pre></dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="enum2any-3226"> </a>enum2any</dt>
<dd class="member"><dl>
<dt class="simple"><br>
<p><strong>template&lt; typename E &gt;</strong></p>
<br>
::com::sun::star::uno::<a href="../com/sun/star/uno/c-Any.html">Any</a> <strong>enum2any</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>E </td>
<td> eEnum );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Description</dt>
<dd><pre>* Template function to create an uno::Any from an enum
*
* @DEPRECATED : use makeAny&lt; E &gt;()
*
</pre></dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="enum2int-3224"> </a>enum2int</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../t-sal_Bool.html">sal_Bool</a> <strong>enum2int</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../t-sal_Int32.html">sal_Int32</a> &amp; </td>
<td> rnEnum,</td>
</tr>
<tr>
<td>const ::com::sun::star::uno::<a href="../com/sun/star/uno/c-Any.html">Any</a> &amp;</td>
<td>rAny );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd><pre>* Sets int32 from enum or int in any.
*&lt;BR&gt;
* </pre></dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rnEnum</td>
<td><pre><pre>int32 enum value
* </pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rAny</td>
<td><pre><pre>enum or int
* </pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">sal_True</td>
<td><pre><pre>if enum or int value was set else sal_False.
</pre></pre></td>
</tr>
</table>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="extractInterface-3227"> </a>extractInterface</dt>
<dd class="member"><dl>
<dt class="simple"><br>
<p><strong>template&lt; typename T &gt;</strong></p>
<br>
<a href="../t-sal_Bool.html">sal_Bool</a> <strong>extractInterface</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>::com::sun::star::uno::<a href="../com/sun/star/uno/c-Reference.html">Reference</a>&lt; T &gt; &amp; </td>
<td> rxOut,</td>
</tr>
<tr>
<td>const ::com::sun::star::uno::<a href="../com/sun/star/uno/c-Any.html">Any</a> &amp;</td>
<td>rAny );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Description</dt>
<dd><pre>* Extracts interface from an any.  If given any does not hold the demanded interface,
* it will be queried for it.
* If no interface is available, the out ref will be cleared.
*&lt;BR&gt;
* </pre></dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rxOut</td>
<td><pre><pre>demanded interface
* </pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rAny</td>
<td><pre><pre>interface
* </pre></pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd><pre>sal_True if any reference (including the null ref) was retrieved from any else sal_False.
</pre></dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="int2enum-3223"> </a>int2enum</dt>
<dd class="member"><dl>
<dt class="simple">::com::sun::star::uno::<a href="../com/sun/star/uno/c-Any.html">Any</a> <strong>int2enum</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../t-sal_Int32.html">sal_Int32</a> </td>
<td> nEnum,</td>
</tr>
<tr>
<td>const ::com::sun::star::uno::<a href="../com/sun/star/uno/c-Type.html">Type</a> &amp;</td>
<td>rType );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd><pre>* Sets enum from int32 value.  This function does NOT check for valid enum values!
*&lt;BR&gt;
* </pre></dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">nEnum</td>
<td><pre><pre>int32 enum value
* </pre></pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">rType</td>
<td><pre><pre>enum type
* </pre></pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd><pre>enum or emoty any.
</pre></dd>
</dl>
</dd>
</dl>
<hr>
<a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>

</div> <!-- id="adc-cppref" -->
</body>

</html>