<html> <head> <title>Interface XTypeDetection</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="XTypeDetection-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">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></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 XTypeDetection</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>support "flat" and "deep" type detection of a given document </dd> <dd><p> A "flat" detection means specifying the document format by using the URL and some configuration data only. That will perform but produce may invalid results if e.g., the extension of the document is wrong. A "deep" detection means looking into the document stream to be right which format it supports. Of course that includes a "flat" detection before. The combination of both ones should produce stable results every time. </p> </dd> <dt><b>See also</b></dt> <dd><a href="TypeDetection.html">TypeDetection</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="#queryTypeByURL">queryTypeByURL</a></td> <td class="imsum_right">make a "flat" detection by using the URL of the document </td> </tr> <tr> <td class="imsum_left"><a href="#queryTypeByDescriptor">queryTypeByDescriptor</a></td> <td class="imsum_right">make a "deep" detection or optional a "flat" detection by using a <a href="MediaDescriptor.html">MediaDescriptor</a> </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="queryTypeByURL" class="membertitle">queryTypeByURL</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">string</td> </tr> <tr> <td valign="top"><b>queryTypeByURL</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> URL );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>make a "flat" detection by using the URL of the document </dd> <dd><p> It use given URL in combination with the internal configuration of well known types only to specify the format of given document. </p> </dd> <dt><b>Parameter URL</b></dt> <dd>specify the document by name </dd> <dt><b>Returns</b></dt> <dd>an internal type name which represent the detected format <br> or an empty value for unknown ones </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="queryTypeByDescriptor" class="membertitle">queryTypeByDescriptor</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">string</td> </tr> <tr> <td valign="top"><b>queryTypeByDescriptor</b>(</td> <td valign="top">[inout] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> Descriptor,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> AllowDeep );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>make a "deep" detection or optional a "flat" detection by using a <a href="MediaDescriptor.html">MediaDescriptor</a> </dd> <dd><p> Instead of <a href="XTypeDetection.html">XTypeDetection</a>::<a href="XTypeDetection.html#queryTypeByURL">queryTypeByURL()</a> this function use a <a href="MediaDescriptor.html">MediaDescriptor</a> to specify the document for detection. Such descriptor hold different informations about the document. He will be passed to any part of made detection process and every part can change it to actualize it. The property <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#URL">URL</a> should be set on this descriptor as minimum. It specifies the location of the document. If this parameter is missing another one is required: <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#InputStream">InputStream</a>. This can be useful to prevent operation against multiple opening of the stream and perform the operation. If this stream isn't already included the detection will open it (if allowed!) and add it to the descriptor so it will be available for all following parts. A combination of both parameters can be useful to perform the operation and make results more stable; but only one of them is required. Of course its possible to specify more document properties (e.g. <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#ReadOnly">ReadOnly</a>). <br> As an additional feature it's possible to suppress "deep" detection by using argument <var>AllowDeep</var>. </p> </dd> <dt><b>Parameter Descriptor</b></dt> <dd>means the <a href="MediaDescriptor.html">MediaDescriptor</a> which specify the resource for detection </dd> <dt><b>Parameter AllowDeep</b></dt> <dd>if it is set to <b>true</b> a "deep" detection will be follow a "flat" detection <br> if it is set to <b>false</b> a "flat" detection will be made only </dd> <dt><b>Returns</b></dt> <dd>an internal type name which represent the detected format <br> or an empty value for unknown ones </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
