<html> <head> <title>Interface XDictionary</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="XDictionary-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 XDictionary</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XDictionary</strong> ┗ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNamed.html">XNamed</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="../container/module-ix.html">container</a>::<a href="../container/XNamed.html">XNamed</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>specifies the name of the object. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This interfaces enables the object to access personal dictionaries. </dd> <dd><P>Personal dictionaries are used to supply additional information for spellchecking and hyphenation (see <a href="XDictionaryEntry.html">XDictionaryEntry</a>). Only active dictionaries with an appropriate language are used for that purpose. The entries of an active, positive dictionary are words that are required to be recognized as correct during the spellchecking process. Additionally, they will be used for hyphenation. Entries of a negative dictionary are required to be recognized as negative words, for example, words that should not be used, during spellcheck. An entry in a negative dictionary may supply a proposal for a word to be used instead of the one being used.</P> </dd> <dt><b>See also</b></dt> <dd>com::sun::star::linguistic2::XDictionaryEvent, ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNamed.html">XNamed</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="#getDictionaryType">getDictionaryType</a></td> <td class="imsum_right">returns the type of the dictionary. </td> </tr> <tr> <td class="imsum_left"><a href="#setActive">setActive</a></td> <td class="imsum_right">specifies whether the dictionary should be used or not . </td> </tr> <tr> <td class="imsum_left"><a href="#isActive">isActive</a></td> <td class="imsum_right"> </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="#getLocale">getLocale</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#setLocale">setLocale</a></td> <td class="imsum_right">is used to set the language of the dictionary. </td> </tr> <tr> <td class="imsum_left"><a href="#getEntry">getEntry</a></td> <td class="imsum_right">searches for an entry that matches the given word. </td> </tr> <tr> <td class="imsum_left"><a href="#addEntry">addEntry</a></td> <td class="imsum_right">is used to add an entry to the dictionary. </td> </tr> <tr> <td class="imsum_left"><a href="#add">add</a></td> <td class="imsum_right">is used to make an entry in the dictionary. </td> </tr> <tr> <td class="imsum_left"><a href="#remove">remove</a></td> <td class="imsum_right">removes an entry from the dictionary. </td> </tr> <tr> <td class="imsum_left"><a href="#isFull">isFull</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getEntries">getEntries</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#clear">clear</a></td> <td class="imsum_right">removes all entries from the dictionary. </td> </tr> <tr> <td class="imsum_left"><a href="#addDictionaryEventListener">addDictionaryEventListener</a></td> <td class="imsum_right">adds an entry to the list of dictionary event listeners. </td> </tr> <tr> <td class="imsum_left"><a href="#removeDictionaryEventListener">removeDictionaryEventListener</a></td> <td class="imsum_right">removes an entry from the list of dictionary event listeners. </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="getDictionaryType" class="membertitle">getDictionaryType</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="DictionaryType.html">DictionaryType</a></td> </tr> <tr> <td valign="top"><b>getDictionaryType</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the type of the dictionary. </dd> <dt><b>Returns</b></dt> <dd>the type of the dictionary. </dd> <dt><b>See also</b></dt> <dd><a href="DictionaryType.html">DictionaryType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setActive" class="membertitle">setActive</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>setActive</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bActivate );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies whether the dictionary should be used or not . </dd> <dt><b>Parameter bAcvtivate</b></dt> <dd><b>true</b> if the dictionary should be used, <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isActive" class="membertitle">isActive</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>isActive</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd><b>true</b> if the dictionary is active, <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </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 entries in the dictionary. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLocale" class="membertitle">getLocale</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">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> </tr> <tr> <td valign="top"><b>getLocale</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the language of the dictionary. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setLocale" class="membertitle">setLocale</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>setLocale</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>is used to set the language of the dictionary. </dd> <dt><b>Parameter aLocale</b></dt> <dd>the new language of the dictionary. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getEntry" class="membertitle">getEntry</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="XDictionaryEntry.html">XDictionaryEntry</a></td> </tr> <tr> <td valign="top"><b>getEntry</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aWord );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>searches for an entry that matches the given word. </dd> <dt><b>Returns</b></dt> <dd>the reference to the entry found. If no entry was found, it is NULL. </dd> <dt><b>Parameter aWord</b></dt> <dd>the word to be looked for. </dd> <dt><b>See also</b></dt> <dd><a href="XDictionaryEntry.html">XDictionaryEntry</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addEntry" class="membertitle">addEntry</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>addEntry</b>(</td> <td valign="top">[in] <a href="XDictionaryEntry.html">XDictionaryEntry</a></td> <td valign="bottom"> xDicEntry );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is used to add an entry to the dictionary. </dd> <dd><P>If an entry already exists, the dictionary remains unchanged and <b>false</b> will be returned.</P> <P>In positive dictionaries only postive entries can be made, and in negative ones only negative entries.</P> </dd> <dt><b>Parameter xDicEntry</b></dt> <dd>the entry to be added. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the entry was successfully added <b>false</b> otherwise. </dd> <dt><b>See also</b></dt> <dd><a href="XDictionaryEntry.html">XDictionaryEntry</a>, <a href="DictionaryType.html">DictionaryType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="add" class="membertitle">add</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>add</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aWord,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bIsNegative,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aRplcText );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is used to make an entry in the dictionary. </dd> <dd><P>If an entry already exists, the dictionary remains unchanged and <b>false</b> will be returned.</P> <P>In positive dictionaries only postive entries can be made, and in negative ones only negative entries.</P> </dd> <dt><b>Parameter aWord</b></dt> <dd>the word to be added. </dd> <dt><b>Parameter bIsNegative</b></dt> <dd>specifies whether the entry will be a negative one or not. </dd> <dt><b>Parameter aRplcText</b></dt> <dd>in the case of a negative entry, this is the replacement text to be used when replacing aWord. Otherwise, it is undefined. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the entry was successfully added, <b>false</b> otherwise. </dd> <dt><b>See also</b></dt> <dd><a href="DictionaryType.html">DictionaryType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="remove" class="membertitle">remove</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>remove</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aWord );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes an entry from the dictionary. </dd> <dt><b>Parameter aWord</b></dt> <dd>the word matching the entry to be removed. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the entry was successfully removed, <b>false</b> otherwise (especially if the entry was not found). </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isFull" class="membertitle">isFull</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>isFull</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd><b>true</b> if the dictionary is full and no further entry can be made, <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getEntries" class="membertitle">getEntries</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="XDictionaryEntry.html">XDictionaryEntry</a> ></td> </tr> <tr> <td valign="top"><b>getEntries</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a sequence with all the entries of the dictionary. </dd> <dt><b>See also</b></dt> <dd><a href="XDictionaryEntry.html">XDictionaryEntry</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="clear" class="membertitle">clear</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>clear</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes all entries from the dictionary. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addDictionaryEventListener" class="membertitle">addDictionaryEventListener</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>addDictionaryEventListener</b>(</td> <td valign="top">[in] <a href="XDictionaryEventListener.html">XDictionaryEventListener</a></td> <td valign="bottom"> xListener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>adds an entry to the list of dictionary event listeners. </dd> <dd><P>On dictionary events, each entry in the listener list will be notified via a call to <a href="XDictionaryEventListener.html">XDictionaryEventListener</a>::<a href="XDictionaryEventListener.html#processDictionaryEvent">processDictionaryEvent</a>.</P> </dd> <dt><b>Parameter xListener</b></dt> <dd>the entry to be made, that is, the object that wants notifications. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the entry was successfully 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>See also</b></dt> <dd><a href="XDictionary.html">XDictionary</a>::<a href="XDictionary.html#removeDictionaryEventListener">removeDictionaryEventListener</a>, <a href="XDictionaryEventListener.html">XDictionaryEventListener</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeDictionaryEventListener" class="membertitle">removeDictionaryEventListener</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>removeDictionaryEventListener</b>(</td> <td valign="top">[in] <a href="XDictionaryEventListener.html">XDictionaryEventListener</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 event listeners. </dd> <dt><b>Parameter xListener</b></dt> <dd>the reference to the listening object to be removed. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the object to be removed was found and removed, <b>false</b> if the object was not found in the list. </dd> <dt><b>See also</b></dt> <dd><a href="XDictionary.html">XDictionary</a>::<a href="XDictionary.html#addDictionaryEventListener">addDictionaryEventListener</a>, <a href="XDictionaryEventListener.html">XDictionaryEventListener</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 © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
4129
