Sophie

Sophie

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

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

<html>
<head>
<title>Service ExportFilter</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="ExportFilter-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Integrating_Import_and_Export_Filters" class="navimain">Devguide</a></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">Services' Summary</td>
<td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td>
<td class="navisub">Properties' Summary</td>
<td class="navisub">Services' Details</td>
<td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td>
<td class="navisub">Properties' 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">document</a> :: </p>
</td>
</tr>
<tr>
<td class="title">service ExportFilter</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>filter for exports

 </dd>
<dd><p>
 Such filters can be used for exporting a content.
 Of course it's possible to combine it with the service <a href="ImportFilter.html">ImportFilter</a>
 if import functionality should be available at same implementation too.
 </p>

 </dd>
<dt><b>See also</b></dt>
<dd><a href="ImportFilter.html">ImportFilter</a></dd>
</dl>
<a name="devmanual"> </a><dl>
<dt><b>Developers Guide</b></dt>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Integrating_Import_and_Export_Filters">OfficeDev - Integrating Import and Export Filters</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces - Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="XExporter.html">XExporter</a></td>
<td class="imsum_right"><p>set source(!) document for this filter

 (<a href="#XExporter">details</a>)</p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XFilter.html">XFilter</a></td>
<td class="imsum_right"><p>filter interface

 (<a href="#XFilter">details</a>)</p>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XInitialization.html">XInitialization</a></td>
<td class="imsum_right"><p>support initialization of filter with its own configuration

 (<a href="#XInitialization">details</a>)</p>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNamed.html">XNamed</a></td>
<td class="imsum_right"><p>provides access to the internal name of this filter

 (<a href="#XNamed">details</a>)</p>
</td>
</tr>
</table>
<a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces - Details</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XExporter" class="membertitle"><a href="XExporter.html">XExporter</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>set source(!) document for this filter

 </dd>
<dd><p>
 The document must be used as the source for following filter operation.
 Any content from there will be exported to another format.
 </p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XFilter" class="membertitle"><a href="XFilter.html">XFilter</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>filter interface

 </dd>
<dd><p>
 It's used to filter a document at saving time.
 The source document should be already setted by using another interface
 <a href="XExporter.html">XExporter</a> which is supported by this service too.
 </p>

 <p>
 Tip:<br>
 If same implementation provides the service <a href="ImportFilter.html">ImportFilter</a> too,
 code must distinguish between filtering from a source document (for export) or
 filtering to a target document (for import). This can be recognized by saving
 state of used interfaces <a href="XExporter.html">XExporter</a> or <a href="XImporter.html">XImporter</a>!
 Otherwise it's not clear which action is required here.
 </p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XInitialization" class="membertitle">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XInitialization.html">XInitialization</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>support initialization of filter with its own configuration

 </dd>
<dd><p>
 A filter object must be created by global service <a href="FilterFactory.html">FilterFactory</a>.
 If filter supports this optional interface, he will be initialized by the factory directly
 after creation. The factory will pass follow informations to this new instance:
 <ul>
 <li>first item will be a set of configuration data of the filter</li>
 <li>after that will follow may given optional parameters of call
 ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XMultiServiceFactory.html">XMultiServiceFactory</a>::<a href="../lang/XMultiServiceFactory.html#createInstanceWithArguments">createInstanceWithArguments()</a>
 of service <a href="FilterFactory.html">FilterFactory</a>.
 </li>
 </ul>
 See description of service <a href="FilterFactory.html">FilterFactory</a>::<a href="FilterFactory.html#XNameContainer">XNameContainer</a> for a description of
 possible configuration data.
 </p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XNamed" class="membertitle">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNamed.html">XNamed</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>provides access to the internal name of this filter

 </dd>
<dd><p>
 This internal filter name can be used on service <a href="FilterFactory.html">FilterFactory</a>
 to get further informations about it (e.g. his registration for mime types or extensions etc.)
 It's important that returned string is the "internal name" of the filter which must be
 unambigous against all other registered filter in current instalation.
 </p>
 <p>
 <strong>Attention!</strong><br>
 Supported method setName() sould be ignored or forwarded to the FilterFactory.
 It's not allowed to set it directly to the configuration. Because it depends
 from real implementation of the FilterFactory if it will be allowed or not!
 </p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<br>&nbsp;<a href="#_top_">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-idlref" -->
</body>

</html>