<html> <head> <title>Interface XFilter</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="XFilter-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/XML_Based_Filter_Development#Introduction" 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"><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">document</a> :: </p> </td> </tr> <tr> <td class="title">interface XFilter</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>interface to filter documents </dd> <dd><p> This interface will be used by service <a href="ImportFilter.html">ImportFilter</a> or <a href="ExportFilter.html">ExportFilter</a> to support loading/saving of documents in different formats. The target/source of such filter operations must be known <em>before</em> filtering will be started. (see <a href="XImporter.html">XImporter</a> and <a href="XExporter.html">XExporter</a> too) Otherwise this interface can't work right. <p> </dd> <dt><b>See also</b></dt> <dd><a href="ImportFilter.html">ImportFilter</a>, <a href="ExportFilter.html">ExportFilter</a>, <a href="XImporter.html">XImporter</a>, <a href="XExporter.html">XExporter</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/XML_Based_Filter_Development#Introduction">OfficeDev - XML Based Filter Development - Introduction</a></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="#filter">filter</a></td> <td class="imsum_right">filter the document. </td> </tr> <tr> <td class="imsum_left"><a href="#cancel">cancel</a></td> <td class="imsum_right">cancel the process. </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="filter" class="membertitle">filter</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">boolean</td> </tr> <tr> <td valign="top"><b>filter</b>(</td> <td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> aDescriptor );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>filter the document. </dd> <dd><p> The given <a href="MediaDescriptor.html">MediaDescriptor</a> holds all neccessary information about the document. Don't hold hard references to the descriptor items. You must copy needed information! Otherwise we couldn't destroy (for example) an existing input stream! </p> </dd> <dt><b>Parameter aDescriptor</b></dt> <dd>the MediaDescriptor describing the respective document. </dd> <dt><b>Returns</b></dt> <dd>a boolean value indicating whether the filter operation was successful or not. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="cancel" class="membertitle">cancel</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>cancel</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>cancel the process. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
2431
