offapi/com/sun/star/linguistic2/XDictionary.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDictionary.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_linguistic2_XDictionary_idl__
  31 #define __com_sun_star_linguistic2_XDictionary_idl__
  32
  33 #ifndef __com_sun_star_container_XNamed_idl__
  34 #include <com/sun/star/container/XNamed.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_Locale_idl__
  38 #include <com/sun/star/lang/Locale.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_linguistic2_DictionaryType_idl__
  42 #include <com/sun/star/linguistic2/DictionaryType.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_linguistic2_XDictionaryEntry_idl__
  46 #include <com/sun/star/linguistic2/XDictionaryEntry.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_linguistic2_XDictionaryEventListener_idl__
  50 #include <com/sun/star/linguistic2/XDictionaryEventListener.idl>
  51 #endif
  52
  53 //=============================================================================
  54
  55 module com { module sun { module star { module linguistic2 {
  56
  57 //=============================================================================
  58 /** This interfaces enables the object to access personal dictionaries.
  59
  60     <P>Personal dictionaries are used to supply additional
  61     information for spellchecking and hyphenation (see
  62     <type scope="com::sun::star::linguistic2">XDictionaryEntry</type>).
  63     Only active dictionaries with an appropriate language are used
  64     for that purpose.
  65     The entries of an active, positive dictionary are words that are
  66     required to be recognized as correct during the spellchecking
  67     process. Additionally, they will be used for hyphenation.
  68     Entries of a negative dictionary are required to be recognized
  69     as negative words, for example, words that should not be used, during
  70     spellcheck. An entry in a negative dictionary may supply a
  71     proposal for a word to be used instead of the one being used.</P>
  72
  73     @see    <type scope="com::sun::star::linguistic2">XDictionaryEvent</type>
  74     @see    <type scope="com::sun::star::container">XNamed</type>
  75 */
  76 published interface XDictionary : com::sun::star::container::XNamed
  77 {
  78     //-------------------------------------------------------------------------
  79     /** returns the type of the dictionary.
  80
  81         @returns
  82             the type of the dictionary.
  83
  84         @see    <type scope="com::sun::star::linguistic2">DictionaryType</type>
  85     */
  86     com::sun::star::linguistic2::DictionaryType getDictionaryType();
  87
  88     //-------------------------------------------------------------------------
  89     /** specifies whether the dictionary should be used or not .
  90
  91         @param  bAcvtivate
  92             <TRUE/> if the dictionary should be used, <FALSE/> otherwise.
  93
  94     */
  95     void setActive( [in] boolean bActivate );
  96
  97     //-------------------------------------------------------------------------
  98     /**
  99         @returns
 100             <TRUE/> if the dictionary is active, <FALSE/> otherwise.
 101     */
 102     boolean isActive();
 103
 104     //-------------------------------------------------------------------------
 105     /**
 106         @returns
 107                the number of entries in the dictionary.
 108     */
 109     long getCount();
 110
 111     //-------------------------------------------------------------------------
 112     /**
 113          @returns
 114              the language of the dictionary.
 115
 116         @see    <type scope="com::sun::star::lang">Locale</type>
 117     */
 118     com::sun::star::lang::Locale getLocale();
 119
 120     //-------------------------------------------------------------------------
 121     /** is used to set the language of the dictionary.
 122
 123          @param aLocale
 124             the new language of the dictionary.
 125
 126         @see    <type scope="com::sun::star::lang">Locale</type>
 127     */
 128     void setLocale( [in] com::sun::star::lang::Locale aLocale );
 129
 130     //-------------------------------------------------------------------------
 131     /** searches for an entry that matches the given word.
 132
 133         @returns
 134             the reference to the entry found. If no entry was found,
 135             it is NULL.
 136
 137         @param  aWord
 138             the word to be looked for.
 139
 140         @see    <type scope="com::sun::star::linguistic2">XDictionaryEntry</type>
 141     */
 142     com::sun::star::linguistic2::XDictionaryEntry getEntry( [in] string aWord );
 143
 144     //-------------------------------------------------------------------------
 145     /** is used to add an entry to the dictionary.
 146
 147         <P>If an entry already exists, the dictionary remains unchanged
 148          and <FALSE/> will be returned.</P>
 149
 150         <P>In positive dictionaries only postive entries
 151         can be made, and in negative ones only negative entries.</P>
 152
 153         @param  xDicEntry
 154             the entry to be added.
 155
 156         @returns
 157             <TRUE/> if the entry was successfully added <FALSE/> otherwise.
 158
 159         @see    <type scope="com::sun::star::linguistic2">XDictionaryEntry</type>
 160         @see    <type scope="com::sun::star::linguistic2">DictionaryType</type>
 161     */
 162     boolean addEntry(
 163         [in] com::sun::star::linguistic2::XDictionaryEntry xDicEntry );
 164
 165     //-------------------------------------------------------------------------
 166     /** is used to make an entry in the dictionary.
 167
 168         <P>If an entry already exists, the dictionary remains unchanged
 169          and <FALSE/> will be returned.</P>
 170
 171         <P>In positive dictionaries only postive entries
 172         can be made, and in negative ones only negative entries.</P>
 173
 174         @param  aWord
 175             the word to be added.
 176
 177         @param  bIsNegative
 178             specifies whether the entry will be a negative one or not.
 179
 180         @param  aRplcText
 181             in the case of a negative entry, this is the replacement text to
 182             be used when replacing aWord. Otherwise, it is undefined.
 183
 184         @returns
 185             <TRUE/> if the entry was successfully added, <FALSE/> otherwise.
 186
 187         @see    <type scope="com::sun::star::linguistic2">DictionaryType</type>
 188     */
 189     boolean add(
 190             [in] string aWord,
 191             [in] boolean bIsNegative,
 192             [in] string aRplcText );
 193
 194     //-------------------------------------------------------------------------
 195     /** removes an entry from the dictionary.
 196
 197         @param  aWord
 198             the word matching the entry to be removed.
 199
 200         @returns
 201             <TRUE/> if the entry was successfully removed, <FALSE/>
 202             otherwise (especially if the entry was not found).
 203     */
 204     boolean remove( [in] string aWord );
 205
 206     //-------------------------------------------------------------------------
 207     /**
 208         @returns
 209              <TRUE/> if the dictionary is full and no further
 210             entry can be made, <FALSE/> otherwise.
 211     */
 212     boolean isFull();
 213
 214     //-------------------------------------------------------------------------
 215     /**
 216         <p>This function should no longer be used since with the expansion of the
 217         maximum number of allowed entries the result may become unreasonable large!</p>
 218
 219          @returns
 220              a sequence with all the entries of the dictionary.
 221
 222         @see    <type scope="com::sun::star::linguistic2">XDictionaryEntry</type>
 223         @see    <type scope="com::sun::star::linguistic2">XSearchableDictionary</type>
 224         @deprecated
 225     */
 226
 227     sequence<com::sun::star::linguistic2::XDictionaryEntry> getEntries();
 228
 229     //-------------------------------------------------------------------------
 230     /** removes all entries from the dictionary.
 231     */
 232     void clear();
 233
 234     //-------------------------------------------------------------------------
 235     /** adds an entry to the list of dictionary event listeners.
 236
 237         <P>On dictionary events, each entry in the listener list will
 238          be notified via a call to
 239         <member scope="com::sun::star::linguistic2">XDictionaryEventListener::processDictionaryEvent</member>.</P>
 240
 241         @param  xListener
 242             the entry to be made, that is, the object that wants notifications.
 243
 244         @returns
 245             <TRUE/> if the entry was successfully made, <FALSE/> otherwise.
 246             If <member scope="com::sun::star::lang">XEventListener::disposing</member> was called before,
 247             it will always fail.
 248
 249         @see    <member scope="com::sun::star::linguistic2">XDictionary::removeDictionaryEventListener</member>
 250         @see    <type scope="com::sun::star::linguistic2">XDictionaryEventListener</type>
 251     */
 252     boolean addDictionaryEventListener(
 253         [in] com::sun::star::linguistic2::XDictionaryEventListener xListener );
 254
 255     //-------------------------------------------------------------------------
 256     /** removes an entry from the list of dictionary event listeners.
 257
 258         @param  xListener
 259             the reference to the listening object to be removed.
 260
 261         @returns
 262             <TRUE/> if the object to be removed was found and removed,
 263             <FALSE/> if the object was not found in the list.
 264
 265         @see    <member scope="com::sun::star::linguistic2">XDictionary::addDictionaryEventListener</member>
 266         @see    <type scope="com::sun::star::linguistic2">XDictionaryEventListener</type>
 267     */
 268     boolean removeDictionaryEventListener(
 269         [in] com::sun::star::linguistic2::XDictionaryEventListener xListener );
 270
 271 };
 272
 273 //=============================================================================
 274
 275 }; }; }; };
 276
 277 #endif
 278