<html> <head> <title>Interface XSmartTagRecognizer</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="XSmartTagRecognizer-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"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></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">smarttags</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XSmartTagRecognizer</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XSmartTagRecognizer</strong> ┗ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XInitialization.html">XInitialization</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <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"><dl> <dt>(referenced interface's summary:)</dt> <dd>initializes an object directly after its creation. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides access to a smart tag recognizer. </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="#getName">getName</a></td> <td class="imsum_right">obtains a name that describes this recognizer component. </td> </tr> <tr> <td class="imsum_left"><a href="#getDescription">getDescription</a></td> <td class="imsum_right">obtains a detailed description of this recognizer component. </td> </tr> <tr> <td class="imsum_left"><a href="#getSmartTagName">getSmartTagName</a></td> <td class="imsum_right">obtains the name of one specific smart tag type supported by this recognizer component. </td> </tr> <tr> <td class="imsum_left"><a href="#getSmartTagDownloadURL">getSmartTagDownloadURL</a></td> <td class="imsum_right">obtains the URL that can be used to download new or updated recognizers. </td> </tr> <tr> <td class="imsum_left"><a href="#recognize">recognize</a></td> <td class="imsum_right">recognizes smart tags. </td> </tr> <tr> <td class="imsum_left"><a href="#hasPropertyPage">hasPropertyPage</a></td> <td class="imsum_right">indicates whether there is a property page for a smart tag type. </td> </tr> <tr> <td class="imsum_left"><a href="#displayPropertyPage">displayPropertyPage</a></td> <td class="imsum_right">launches the property page for a smart tag type. </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="getName" class="membertitle">getName</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>getName</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>obtains a name that describes this recognizer component. </dd> <dt><b>Parameter aLocale</b></dt> <dd>Is used for localization of the name. </dd> <dt><b>Returns</b></dt> <dd>the name of the recognizer component. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDescription" class="membertitle">getDescription</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>getDescription</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>obtains a detailed description of this recognizer component. </dd> <dt><b>Parameter aLocale</b></dt> <dd>Is used for localization of the description. </dd> <dt><b>Returns</b></dt> <dd>the description of the recognizer component. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSmartTagName" class="membertitle">getSmartTagName</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>getSmartTagName</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nSmartTagIndex )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>obtains the name of one specific smart tag type supported by this recognizer component. </dd> <dt><b>Parameter nSmartTagIndex</b></dt> <dd>Index of the wanted smart tag type. Value needs to be between 0 and the number of smarttags available (exclusively). </dd> <dt><b>Returns</b></dt> <dd>the unique name of the smart tag type. Smart tag type names are always in the format of namespaceURI#tagname. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IndexOutOfBoundsException if nSmartTagIndex is greater than SmartTagCount </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSmartTagDownloadURL" class="membertitle">getSmartTagDownloadURL</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>getSmartTagDownloadURL</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nSmartTagIndex )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>obtains the URL that can be used to download new or updated recognizers. </dd> <dt><b>Parameter nSmartTagIndex</b></dt> <dd>Index of the wanted smart tag type. Value needs to be between 0 and the number of smarttags available (exclusively). </dd> <dt><b>Returns</b></dt> <dd>the download URL. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IndexOutOfBoundsException if nSmartTagIndex is greater than SmartTagCount </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="recognize" class="membertitle">recognize</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>recognize</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aText,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nStart,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nLength,</td> </tr> <tr> <td/><td valign="top">[in] <a href="SmartTagRecognizerMode.html">SmartTagRecognizerMode</a></td> <td valign="bottom"> eDataType,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/XTextMarkup.html">XTextMarkup</a></td> <td valign="bottom"> xTextMarkup,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aApplicationName,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a></td> <td valign="bottom"> xController,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../i18n/module-ix.html">i18n</a>::<a href="../i18n/XBreakIterator.html">XBreakIterator</a></td> <td valign="bottom"> xTokenizer );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>recognizes smart tags. </dd> <dt><b>Parameter aText</b></dt> <dd>The text that should be scanned by the recognizer. aText is UFT16 encoded. </dd> <dt><b>Parameter nStart</b></dt> <dd>Denotes the start position of the region to scan. </dd> <dt><b>Parameter nLength</b></dt> <dd>Denotes the length of the text to scan. </dd> <dt><b>Parameter eDataType</b></dt> <dd>This value indicates the type of the passed text. </dd> <dt><b>Parameter aLocale</b></dt> <dd>Is used to indicate the language of the passed text. </dd> <dt><b>Parameter xTextMarkup</b></dt> <dd>This object is used to submit any recognized smart tags to the calling application. </dd> <dt><b>Parameter aApplicationName</b></dt> <dd>A string containing the name of the calling application. </dd> <dt><b>Parameter xController</b></dt> <dd>The current controller of the document. </dd> <dt><b>Parameter xTokenizer</b></dt> <dd>This can be used to tokenize the string to recognize. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasPropertyPage" class="membertitle">hasPropertyPage</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>hasPropertyPage</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nSmartTagIndex,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>indicates whether there is a property page for a smart tag type. </dd> <dt><b>Parameter nSmartTagIndex</b></dt> <dd>Index of the wanted smart tag type. Value needs to be between 0 and the number of smarttags available (exclusively). </dd> <dt><b>Parameter aLocale</b></dt> <dd>Is used for localization of the property page. </dd> <dt><b>Returns</b></dt> <dd>true if there is a property page matching the requested smart tag type and locale. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IndexOutOfBoundsException if nSmartTagIndex is greater than SmartTagCount </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="displayPropertyPage" class="membertitle">displayPropertyPage</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>displayPropertyPage</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nSmartTagIndex,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>launches the property page for a smart tag type. </dd> <dt><b>Parameter nSmartTagIndex</b></dt> <dd>Index of the wanted smart tag type. Value needs to be between 0 and the number of smarttags available (exclusively). </dd> <dt><b>Parameter aLocale</b></dt> <dd>Is used for localization of the property page. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IndexOutOfBoundsException if nSmartTagIndex is greater than SmartTagCount </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#SmartTagCount">SmartTagCount</a></td> <td class="imsum_right">The number of smart tag types supported by this recognizer component. </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="SmartTagCount" class="membertitle">SmartTagCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>SmartTagCount</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The number of smart tag types supported by this recognizer component. </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
>
6005
