Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 7811

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XRenderable</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XRenderable-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">view</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XRenderable</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>represents something that can be rendered.

 </dd>
<dt><b/></dt>
<dd/></dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getRendererCount">getRendererCount</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getRenderer">getRenderer</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#render">render</a></td>
<td class="imsum_right">renders the object.

 &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="getRendererCount" class="membertitle">getRendererCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">long</td>
</tr>
<tr>
<td valign="top"><b>getRendererCount</b>(</td>
<td valign="top">[in] any</td>
<td valign="bottom">&nbsp;aSelection,</td>
</tr>
<tr>
<td/><td valign="top">[in] sequence&lt; ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> &gt;</td>
<td valign="bottom">&nbsp;xOptions )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>the count of renderers (based on paper count of a document, for example). 
 
 <p> If a selection is given, the count has to be calculated 
 based on this selection. The other methods of this interface
 will rely on this value if called.
 
 <p> If the selection contains a valid XModel interface, 
 it is assumed that the whole document should be rendered.
 If the selection is empty, nothing should be rendered.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="RenderOptions.html">RenderOptions</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getRenderer" class="membertitle">getRenderer</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getRenderer</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nRenderer,</td>
</tr>
<tr>
<td/><td valign="top">[in] any</td>
<td valign="bottom">&nbsp;aSelection,</td>
</tr>
<tr>
<td/><td valign="top">[in] sequence&lt; ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> &gt;</td>
<td valign="bottom">&nbsp;xOptions )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>a descriptor of the specific renderer. 
 
 <p> returns the specific renderer properties based on the given selection. 
 
 <p> If the selection contains a valid XModel interface, 
 it is assumed that the whole document should be rendered.
 If the selection is empty, nothing should be rendered.
 
 </dd>
<dt><b>See also</b></dt>
<dd><a href="RenderDescriptor.html">RenderDescriptor</a>, <a href="RenderOptions.html">RenderOptions</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="render" class="membertitle">render</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>render</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nRenderer,</td>
</tr>
<tr>
<td/><td valign="top">[in] any</td>
<td valign="bottom">&nbsp;aSelection,</td>
</tr>
<tr>
<td/><td valign="top">[in] sequence&lt; ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> &gt;</td>
<td valign="bottom">&nbsp;xOptions )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>renders the object.

 </dd>
<dd><p> renders the object with the specific renderer based on the given selection. 

 <p> If the selection contains a valid XModel interface, 
 it is assumed that the whole document should be rendered.
 If the selection is empty, nothing should be rendered.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="RenderOptions.html">RenderOptions</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

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

</html>