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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module linguistic2 {
  22
  23 /** This interfaces enables the object to access personal dictionaries.
  24
  25     <P>Personal dictionaries are used to supply additional
  26     information for spell checking and hyphenation (see
  27     com::sun::star::linguistic2::XDictionaryEntry).
  28     Only active dictionaries with an appropriate language are used
  29     for that purpose.
  30     The entries of an active, positive dictionary are words that are
  31     required to be recognized as correct during the spell checking
  32     process. Additionally, they will be used for hyphenation.
  33     Entries of a negative dictionary are required to be recognized
  34     as negative words, for example, words that should not be used, during
  35     SPELLCHECK. An entry in a negative dictionary may supply a
  36     proposal for a word to be used instead of the one being used.</P>
  37
  38     @see    com::sun::star::linguistic2::XDictionaryEvent
  39     @see    com::sun::star::container::XNamed
  40 */
  41 published interface XDictionary : com::sun::star::container::XNamed
  42 {
  43     /** returns the type of the dictionary.
  44
  45         @returns
  46             the type of the dictionary.
  47
  48         @see    com::sun::star::linguistic2::DictionaryType
  49     */
  50     com::sun::star::linguistic2::DictionaryType getDictionaryType();
  51
  52     /** specifies whether the dictionary should be used or not .
  53
  54         @param  bActivate
  55             `TRUE` if the dictionary should be used, `FALSE` otherwise.
  56
  57     */
  58     void setActive( [in] boolean bActivate );
  59
  60     /**
  61         @returns
  62             `TRUE` if the dictionary is active, `FALSE` otherwise.
  63     */
  64     boolean isActive();
  65
  66     /**
  67         @returns
  68                the number of entries in the dictionary.
  69     */
  70     long getCount();
  71
  72     /**
  73          @returns
  74              the language of the dictionary.
  75
  76         @see    com::sun::star::lang::Locale
  77     */
  78     com::sun::star::lang::Locale getLocale();
  79
  80     /** is used to set the language of the dictionary.
  81
  82          @param aLocale
  83             the new language of the dictionary.
  84
  85         @see    com::sun::star::lang::Locale
  86     */
  87     void setLocale( [in] com::sun::star::lang::Locale aLocale );
  88
  89     /** searches for an entry that matches the given word.
  90
  91         @returns
  92             the reference to the entry found. If no entry was found,
  93             it is NULL.
  94
  95         @param  aWord
  96             the word to be looked for.
  97
  98         @see    com::sun::star::linguistic2::XDictionaryEntry
  99     */
 100     com::sun::star::linguistic2::XDictionaryEntry getEntry( [in] string aWord );
 101
 102     /** is used to add an entry to the dictionary.
 103
 104         <P>If an entry already exists, the dictionary remains unchanged
 105          and `FALSE` will be returned.</P>
 106
 107         <P>In positive dictionaries only positive entries
 108         can be made, and in negative ones only negative entries.</P>
 109
 110         @param  xDicEntry
 111             the entry to be added.
 112
 113         @returns
 114             `TRUE` if the entry was successfully added `FALSE` otherwise.
 115
 116         @see    com::sun::star::linguistic2::XDictionaryEntry
 117         @see    com::sun::star::linguistic2::DictionaryType
 118     */
 119     boolean addEntry(
 120         [in] com::sun::star::linguistic2::XDictionaryEntry xDicEntry );
 121
 122     /** is used to make an entry in the dictionary.
 123
 124         <P>If an entry already exists, the dictionary remains unchanged
 125          and `FALSE` will be returned.</P>
 126
 127         <P>In positive dictionaries only positive entries
 128         can be made, and in negative ones only negative entries.</P>
 129
 130         @param  aWord
 131             the word to be added.
 132
 133         @param  bIsNegative
 134             specifies whether the entry will be a negative one or not.
 135
 136         @param  aRplcText
 137             in the case of a negative entry, this is the replacement text to
 138             be used when replacing aWord. Otherwise, it is undefined.
 139
 140         @returns
 141             `TRUE` if the entry was successfully added, `FALSE` otherwise.
 142
 143         @see    com::sun::star::linguistic2::DictionaryType
 144     */
 145     boolean add(
 146             [in] string aWord,
 147             [in] boolean bIsNegative,
 148             [in] string aRplcText );
 149
 150     /** removes an entry from the dictionary.
 151
 152         @param  aWord
 153             the word matching the entry to be removed.
 154
 155         @returns
 156             `TRUE` if the entry was successfully removed, `FALSE`
 157             otherwise (especially if the entry was not found).
 158     */
 159     boolean remove( [in] string aWord );
 160
 161     /**
 162         @returns
 163              `TRUE` if the dictionary is full and no further
 164             entry can be made, `FALSE` otherwise.
 165     */
 166     boolean isFull();
 167
 168     /**
 169         <p>This function should no longer be used since with the expansion of the
 170         maximum number of allowed entries the result may become unreasonable large!</p>
 171
 172          @returns
 173              a sequence with all the entries of the dictionary.
 174
 175         @see    com::sun::star::linguistic2::XDictionaryEntry
 176         @see    com::sun::star::linguistic2::XSearchableDictionary
 177         @deprecated
 178     */
 179
 180     sequence<com::sun::star::linguistic2::XDictionaryEntry> getEntries();
 181
 182     /** removes all entries from the dictionary.
 183     */
 184     void clear();
 185
 186     /** adds an entry to the list of dictionary event listeners.
 187
 188         <P>On dictionary events, each entry in the listener list will
 189          be notified via a call to
 190         com::sun::star::linguistic2::XDictionaryEventListener::processDictionaryEvent().</P>
 191
 192         @param  xListener
 193             the entry to be made, that is, the object that wants notifications.
 194
 195         @returns
 196             `TRUE` if the entry was successfully made, `FALSE` otherwise.
 197             If com::sun::star::lang::XEventListener::disposing() was called before,
 198             it will always fail.
 199
 200         @see    com::sun::star::linguistic2::XDictionary::removeDictionaryEventListener()
 201         @see    com::sun::star::linguistic2::XDictionaryEventListener
 202     */
 203     boolean addDictionaryEventListener(
 204         [in] com::sun::star::linguistic2::XDictionaryEventListener xListener );
 205
 206     /** removes an entry from the list of dictionary event listeners.
 207
 208         @param  xListener
 209             the reference to the listening object to be removed.
 210
 211         @returns
 212             `TRUE` if the object to be removed was found and removed,
 213             `FALSE` if the object was not found in the list.
 214
 215         @see    com::sun::star::linguistic2::XDictionary::addDictionaryEventListener()
 216         @see    com::sun::star::linguistic2::XDictionaryEventListener
 217     */
 218     boolean removeDictionaryEventListener(
 219         [in] com::sun::star::linguistic2::XDictionaryEventListener xListener );
 220
 221 };
 222
 223
 224 }; }; }; };
 225
 226 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */