Sophie

Sophie

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

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

<html>
<head>
<title>Interface XLinguServiceManager</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="XLinguServiceManager-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">linguistic2</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XLinguServiceManager</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>the basic interface to be used to access linguistic functionality.

 </dd>
<dd><P>This interface is used to access spellchecker, hyphenator, and 
 thesaurus functionality.
 Additionally, it can query what implementations of those services are
 available (for specific languages or in general).
 It can select and query which of those implementations should
 be used for a specific language.</P>

 <P>
 For spellchecking and thesaurus, the order in the list defines the order
 of creation/usage of those services.
 That is, if the first spellchecker implementation does not recognize
 the given word as correct, the second service implementation for that
 language is created and gets queried. If that one fails, the third one 
 gets created and queried and so on. 
 This chain stops if an implementation reports the word as correct or the
 end of the list is reached, in which case the word is reported as incorrect.
 </P>

 <P> For the thesaurus, the behavior is the same when no meaning was found.
 </P>

 </dd>
<dt><b>See also</b></dt>
<dd><a href="SpellChecker.html">SpellChecker</a>, <a href="Hyphenator.html">Hyphenator</a>, <a href="Thesaurus.html">Thesaurus</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="#getSpellChecker">getSpellChecker</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getHyphenator">getHyphenator</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getThesaurus">getThesaurus</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#addLinguServiceManagerListener">addLinguServiceManagerListener</a></td>
<td class="imsum_right">adds a listener to the list of event listeners.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#removeLinguServiceManagerListener">removeLinguServiceManagerListener</a></td>
<td class="imsum_right">removes a listener from the list of event listeners.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getAvailableServices">getAvailableServices</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setConfiguredServices">setConfiguredServices</a></td>
<td class="imsum_right">sets the list of service implementations to be used for a
 given service and language.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getConfiguredServices">getConfiguredServices</a></td>
<td class="imsum_right">queries the list of service implementations to be used for a
 given service and language.

 &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="getSpellChecker" class="membertitle">getSpellChecker</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"><a href="XSpellChecker.html">XSpellChecker</a></td>
</tr>
<tr>
<td valign="top"><b>getSpellChecker</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>the <a href="XSpellChecker.html">XSpellChecker</a>
 interface to be used for spellchecking.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getHyphenator" class="membertitle">getHyphenator</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"><a href="XHyphenator.html">XHyphenator</a></td>
</tr>
<tr>
<td valign="top"><b>getHyphenator</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>the <a href="XHyphenator.html">XHyphenator</a>
 interface to be used for hyphenation.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getThesaurus" class="membertitle">getThesaurus</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"><a href="XThesaurus.html">XThesaurus</a></td>
</tr>
<tr>
<td valign="top"><b>getThesaurus</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>the <a href="XThesaurus.html">XThesaurus</a>
 interface to be used for thesaurus functionality.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="addLinguServiceManagerListener" class="membertitle">addLinguServiceManagerListener</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>addLinguServiceManagerListener</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XEventListener.html">XEventListener</a></td>
<td valign="bottom">&nbsp;xListener );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>adds a listener to the list of event listeners.

 </dd>
<dd><P>The listeners may support one or both of
 <a href="XDictionaryEventListener.html">XDictionaryEventListener</a>
 and 
 <a href="XLinguServiceEventListener.html">XLinguServiceEventListener</a>
 interfaces.
 </P>

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b> if the listener was succesfully added, <b>false</b> otherwise.

 </dd>
<dt><b>Parameter xListener</b></dt>
<dd>the listener to be added.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="removeLinguServiceManagerListener" class="membertitle">removeLinguServiceManagerListener</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>removeLinguServiceManagerListener</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XEventListener.html">XEventListener</a></td>
<td valign="bottom">&nbsp;xListener );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>removes a listener from the list of event listeners.

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b> if the listener was succesfully removed, <b>false</b> otherwise.

 </dd>
<dt><b>Parameter xListener</b></dt>
<dd>the listener to be removed.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getAvailableServices" class="membertitle">getAvailableServices</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; string &gt;</td>
</tr>
<tr>
<td valign="top"><b>getAvailableServices</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aServiceName,</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">&nbsp;aLocale );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>the list of implementation names of the available services.

 </dd>
<dt><b>Parameter aServiceName</b></dt>
<dd>the name of the service requesting the list of available
 implementations.

 </dd>
<dt><b>Parameter aLocale</b></dt>
<dd>the language used to query the list of available implementations.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setConfiguredServices" class="membertitle">setConfiguredServices</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>setConfiguredServices</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aServiceName,</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">&nbsp;aLocale,</td>
</tr>
<tr>
<td/><td valign="top">[in] sequence&lt; string &gt;</td>
<td valign="bottom">&nbsp;aServiceImplNames );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>sets the list of service implementations to be used for a
 given service and language.

 </dd>
<dt><b>Parameter aServiceName</b></dt>
<dd>the name of the service to set the list of implementations
 to be used.

 </dd>
<dt><b>Parameter aLocale</b></dt>
<dd>the language to set the list.

 </dd>
<dt><b>Parameter aServiceImplNames</b></dt>
<dd>the name of the service to set the list.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getConfiguredServices" class="membertitle">getConfiguredServices</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; string &gt;</td>
</tr>
<tr>
<td valign="top"><b>getConfiguredServices</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aServiceName,</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">&nbsp;aLocale );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>queries the list of service implementations to be used for a
 given service and language.

 </dd>
<dt><b>Returns</b></dt>
<dd>the list of implementation names of the services to be used.

 </dd>
<dt><b>Parameter aServiceName</b></dt>
<dd>the name of the service to get queried.

 </dd>
<dt><b>Parameter aLocale</b></dt>
<dd>the language to get queried.
 </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>