<html> <head> <title>Interface XDictionaryList</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="XDictionaryList-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">linguistic2</a> :: </p> </td> </tr> <tr> <td class="title">interface XDictionaryList</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>is used to manage and maintain a list of dictionaries. </dd> <dd><P>A dictionary-list may be given to a spellchecker or hyphenator service implementation on their creation in order to supply a set of dictionaries and additional information to be used for those purposes.</P> </dd> <dt><b>See also</b></dt> <dd><a href="XDictionary.html">XDictionary</a>, ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</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="#getCount">getCount</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getDictionaries">getDictionaries</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getDictionaryByName">getDictionaryByName</a></td> <td class="imsum_right">searches the list for a dictionary with a given name. </td> </tr> <tr> <td class="imsum_left"><a href="#addDictionary">addDictionary</a></td> <td class="imsum_right">adds a dictionary to the list. </td> </tr> <tr> <td class="imsum_left"><a href="#removeDictionary">removeDictionary</a></td> <td class="imsum_right">removes a single dictionary from the list. </td> </tr> <tr> <td class="imsum_left"><a href="#addDictionaryListEventListener">addDictionaryListEventListener</a></td> <td class="imsum_right">adds an entry to the list of dictionary-list event listeners. </td> </tr> <tr> <td class="imsum_left"><a href="#removeDictionaryListEventListener">removeDictionaryListEventListener</a></td> <td class="imsum_right">removes an entry from the list of dictionary-list event listeners. </td> </tr> <tr> <td class="imsum_left"><a href="#beginCollectEvents">beginCollectEvents</a></td> <td class="imsum_right">increases request level for event buffering by one. </td> </tr> <tr> <td class="imsum_left"><a href="#endCollectEvents">endCollectEvents</a></td> <td class="imsum_right">flushes the event buffer and decreases the request level for event buffering by one. </td> </tr> <tr> <td class="imsum_left"><a href="#flushEvents">flushEvents</a></td> <td class="imsum_right">notifies the listeners of all buffered events and then clears that buffer. </td> </tr> <tr> <td class="imsum_left"><a href="#createDictionary">createDictionary</a></td> <td class="imsum_right">creates a new dictionary. </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="getCount" class="membertitle">getCount</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">short</td> </tr> <tr> <td valign="top"><b>getCount</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the number of dictionaries in the list. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDictionaries" class="membertitle">getDictionaries</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< <a href="XDictionary.html">XDictionary</a> ></td> </tr> <tr> <td valign="top"><b>getDictionaries</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a sequence with an entry for every dictionary in the list. </dd> <dt><b>See also</b></dt> <dd><a href="XDictionary.html">XDictionary</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDictionaryByName" class="membertitle">getDictionaryByName</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="XDictionary.html">XDictionary</a></td> </tr> <tr> <td valign="top"><b>getDictionaryByName</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aDictionaryName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>searches the list for a dictionary with a given name. </dd> <dt><b>Returns</b></dt> <dd>the XDictionary with the specified name. If no such dictionary exists, <b>NULL</b> will be returned. </dd> <dt><b>Parameter aDictionaryName</b></dt> <dd>specifies the name of the dictionary to look for. </dd> <dt><b>See also</b></dt> <dd><a href="XDictionary.html">XDictionary</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addDictionary" class="membertitle">addDictionary</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>addDictionary</b>(</td> <td valign="top">[in] <a href="XDictionary.html">XDictionary</a></td> <td valign="bottom"> xDictionary );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>adds a dictionary to the list. </dd> <dd><P>Additionally, the dictionary-list will add itself to the list of dictionary event listeners of that dictionary.</P> </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the dictionary was added successfully, <b>false</b> otherwise. </dd> <dt><b>Parameter xDictionary</b></dt> <dd>the dictionary to be added. </dd> <dt><b>See also</b></dt> <dd><a href="XDictionary.html">XDictionary</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeDictionary" class="membertitle">removeDictionary</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>removeDictionary</b>(</td> <td valign="top">[in] <a href="XDictionary.html">XDictionary</a></td> <td valign="bottom"> xDictionary );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes a single dictionary from the list. </dd> <dd><P>If the dictionary is still active, it will be deactivated first. The dictionary-list will remove itself from the list of dictionary event listeners of the dictionary.</P> </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the dictionary was removed successfully, <b>false</b> otherwise. </dd> <dt><b>Parameter xDictionary</b></dt> <dd>dictionary to be removed from the list of dictionaries. </dd> <dt><b>See also</b></dt> <dd><a href="XDictionary.html">XDictionary</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addDictionaryListEventListener" class="membertitle">addDictionaryListEventListener</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>addDictionaryListEventListener</b>(</td> <td valign="top">[in] <a href="XDictionaryListEventListener.html">XDictionaryListEventListener</a></td> <td valign="bottom"> xListener,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bReceiveVerbose );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>adds an entry to the list of dictionary-list event listeners. </dd> <dd><P>On dictionary-list events, each entry in the listener list will be notified via a call to <a href="XDictionaryListEventListener.html">XDictionaryListEventListener</a>::<a href="XDictionaryListEventListener.html#processDictionaryListEvent">processDictionaryListEvent</a>.</P> </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the entry was made, <b>false</b> otherwise. If ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XEventListener.html">XEventListener</a>::<a href="../lang/XEventListener.html#disposing">disposing</a> was called before, it will always fail. </dd> <dt><b>Parameter xListener</b></dt> <dd>the object to be notified of dictionary-list events. </dd> <dt><b>Parameter bReceiveVerbose</b></dt> <dd><b>true</b> if the listener requires more detailed event notification than usual. </dd> <dt><b>See also</b></dt> <dd><a href="XDictionaryListEventListener.html">XDictionaryListEventListener</a>, com::sun::star::linguistic2::XDictionaryListEvent</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeDictionaryListEventListener" class="membertitle">removeDictionaryListEventListener</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>removeDictionaryListEventListener</b>(</td> <td valign="top">[in] <a href="XDictionaryListEventListener.html">XDictionaryListEventListener</a></td> <td valign="bottom"> xListener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes an entry from the list of dictionary-list event listeners. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the object to be removed was found and removed, <b>false</b> otherwise. </dd> <dt><b>Parameter xListener</b></dt> <dd>the object to be removed from the listener list. </dd> <dt><b>See also</b></dt> <dd><a href="XDictionaryListEventListener.html">XDictionaryListEventListener</a>, com::sun::star::linguistic2::XDictionaryListEvent</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="beginCollectEvents" class="membertitle">beginCollectEvents</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">short</td> </tr> <tr> <td valign="top"><b>beginCollectEvents</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>increases request level for event buffering by one. </dd> <dd><P>The request level for event buffering is an integer counter that is initially set to 0. As long as the request level is not 0, events will be buffered until the next flushing of the buffer.</P> </dd> <dt><b>Returns</b></dt> <dd>the current request level for event buffering. </dd> <dt><b>See also</b></dt> <dd>com::sun::star::linguistic2::XDictionaryListEvent, <a href="XDictionaryListEventListener.html">XDictionaryListEventListener</a>, <a href="XDictionaryList.html">XDictionaryList</a>::<a href="XDictionaryList.html#endCollectEvents">endCollectEvents</a>, <a href="XDictionaryList.html">XDictionaryList</a>::<a href="XDictionaryList.html#flushEvents">flushEvents</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="endCollectEvents" class="membertitle">endCollectEvents</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">short</td> </tr> <tr> <td valign="top"><b>endCollectEvents</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>flushes the event buffer and decreases the request level for event buffering by one. </dd> <dd><P>There should be one matching endCollectEvents call for every beginCollectEvents call. Usually you will group these around some code where you do not wish to get notfied of every single event.</P> </dd> <dt><b>Returns</b></dt> <dd>the current request level for event buffering. </dd> <dt><b>See also</b></dt> <dd>com::sun::star::linguistic2::XDictionaryListEvent, <a href="XDictionaryListEventListener.html">XDictionaryListEventListener</a>, <a href="XDictionaryList.html">XDictionaryList</a>::<a href="XDictionaryList.html#beginCollectEvents">beginCollectEvents</a>, <a href="XDictionaryList.html">XDictionaryList</a>::<a href="XDictionaryList.html#flushEvents">flushEvents</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="flushEvents" class="membertitle">flushEvents</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">short</td> </tr> <tr> <td valign="top"><b>flushEvents</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>notifies the listeners of all buffered events and then clears that buffer. </dd> <dt><b>Returns</b></dt> <dd>the current request level for event buffering. </dd> <dt><b>See also</b></dt> <dd>com::sun::star::linguistic2::XDictionaryListEvent, <a href="XDictionaryListEventListener.html">XDictionaryListEventListener</a>, <a href="XDictionaryList.html">XDictionaryList</a>::<a href="XDictionaryList.html#beginCollectEvents">beginCollectEvents</a>, <a href="XDictionaryList.html">XDictionaryList</a>::<a href="XDictionaryList.html#endCollectEvents">endCollectEvents</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createDictionary" class="membertitle">createDictionary</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="XDictionary.html">XDictionary</a></td> </tr> <tr> <td valign="top"><b>createDictionary</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName,</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] <a href="DictionaryType.html">DictionaryType</a></td> <td valign="bottom"> eDicType,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aURL );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a new dictionary. </dd> <dt><b>Returns</b></dt> <dd>an empty dictionary with the given name, language and type. <b>NULL</b> on failure. </dd> <dt><b>Parameter aName</b></dt> <dd>is the name of the dictionary (should be unique). </dd> <dt><b>Parameter aLocale</b></dt> <dd>defines the language of the dictionary. Use an empty aLocale for dictionaries which may contain entries of all languages. </dd> <dt><b>Parameter eDicType</b></dt> <dd>specifies the type of the dictionary. </dd> <dt><b>Parameter aURL</b></dt> <dd>is the URL of the location where the dictionary is persistent, if the XStorable interface is supported. It may be empty, which means the dictionary will not be persistent. </dd> <dt><b>See also</b></dt> <dd><a href="XDictionary.html">XDictionary</a>, ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a>, <a href="DictionaryType.html">DictionaryType</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
4223
