offapi/com/sun/star/linguistic2/XDictionaryList.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 #ifndef __com_sun_star_linguistic2_XDictionaryList_idl__
  20 #define __com_sun_star_linguistic2_XDictionaryList_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/linguistic2/XDictionary.idl>
  24 #include <com/sun/star/linguistic2/XDictionaryListEventListener.idl>
  25
  26
  27 module com { module sun { module star { module linguistic2 {
  28
  29 /** is used to manage and maintain a list of dictionaries.
  30
  31     <P>A dictionary-list may be given to a spell checker or hyphenator
  32     service implementation on their creation in order to supply a set
  33     of dictionaries and additional information to be used for
  34     those purposes.</P>
  35
  36     @see    com::sun::star::linguistic2::XDictionary
  37     @see    com::sun::star::uno::XInterface
  38 */
  39 published interface XDictionaryList : com::sun::star::uno::XInterface
  40 {
  41     /**
  42         @returns
  43             the number of dictionaries in the list.
  44     */
  45     short getCount();
  46
  47     /**
  48         @returns
  49              a sequence with an entry for every dictionary
  50             in the list.
  51
  52         @see    com::sun::star::linguistic2::XDictionary
  53     */
  54     sequence<com::sun::star::linguistic2::XDictionary> getDictionaries();
  55
  56     /** searches the list for a dictionary with a given name.
  57
  58          @returns
  59             the XDictionary with the specified name. If no such
  60             dictionary exists, `NULL` will be returned.
  61
  62         @param  aDictionaryName
  63             specifies the name of the dictionary to look for.
  64
  65         @see    com::sun::star::linguistic2::XDictionary
  66     */
  67     com::sun::star::linguistic2::XDictionary getDictionaryByName(
  68             [in] string aDictionaryName );
  69
  70     /** adds a dictionary to the list.
  71
  72         <P>Additionally, the dictionary-list will add itself to the list of dictionary
  73          event listeners of that dictionary.</P>
  74
  75         @returns
  76              `TRUE` if the dictionary was added successfully,
  77             `FALSE` otherwise.
  78
  79         @param  xDictionary
  80             the dictionary to be added.
  81
  82         @see    com::sun::star::linguistic2::XDictionary
  83     */
  84     boolean addDictionary(
  85             [in] com::sun::star::linguistic2::XDictionary xDictionary );
  86
  87     /** removes a single dictionary from the list.
  88
  89         <P>If the dictionary is still active, it will be deactivated
  90         first. The dictionary-list will remove itself from the list of
  91         dictionary event listeners of the dictionary.</P>
  92
  93         @returns
  94              `TRUE` if the dictionary was removed successfully, `FALSE`
  95              otherwise.
  96
  97         @param  xDictionary
  98             dictionary to be removed from the list of dictionaries.
  99
 100         @see    com::sun::star::linguistic2::XDictionary
 101     */
 102     boolean removeDictionary(
 103             [in] com::sun::star::linguistic2::XDictionary xDictionary );
 104
 105     /** adds an entry to the list of dictionary-list event listeners.
 106
 107         <P>On dictionary-list events, each entry in the listener list will
 108          be notified via a call to
 109         com::sun::star::linguistic2::XDictionaryListEventListener::processDictionaryListEvent().</P>
 110
 111         @returns
 112             `TRUE` if the entry was made, `FALSE` otherwise.
 113             If com::sun::star::lang::XEventListener::disposing()
 114             was called before, it will always fail.
 115
 116         @param  xListener
 117             the object to be notified of dictionary-list events.
 118
 119         @param  bReceiveVerbose
 120             `TRUE` if the listener requires more detailed event
 121             notification than usual.
 122
 123         @see    com::sun::star::linguistic2::XDictionaryListEventListener
 124         @see    com::sun::star::linguistic2::XDictionaryListEvent
 125     */
 126     boolean addDictionaryListEventListener(
 127         [in] com::sun::star::linguistic2::XDictionaryListEventListener xListener,
 128         [in] boolean bReceiveVerbose );
 129
 130     /** removes an entry from the list of dictionary-list event listeners.
 131
 132         @returns
 133             `TRUE` if the object to be removed was found and removed,
 134             `FALSE` otherwise.
 135
 136         @param  xListener
 137             the object to be removed from the listener list.
 138
 139         @see    com::sun::star::linguistic2::XDictionaryListEventListener
 140         @see    com::sun::star::linguistic2::XDictionaryListEvent
 141     */
 142     boolean removeDictionaryListEventListener(
 143         [in] com::sun::star::linguistic2::XDictionaryListEventListener xListener );
 144
 145     /** increases request level for event buffering by one.
 146
 147          <P>The request level for event buffering is an integer
 148          counter that is initially set to 0.
 149         As long as the request level is not 0, events will be buffered
 150          until the next flushing of the buffer.</P>
 151
 152         @returns
 153              the current request level for event buffering.
 154
 155         @see    com::sun::star::linguistic2::XDictionaryListEvent
 156         @see    com::sun::star::linguistic2::XDictionaryListEventListener
 157         @see    com::sun::star::linguistic2::XDictionaryList::endCollectEvents()
 158         @see    com::sun::star::linguistic2::XDictionaryList::flushEvents()
 159     */
 160     short beginCollectEvents();
 161
 162     /** flushes the event buffer and decreases the request level for
 163          event buffering by one.
 164
 165          <P>There should be one matching endCollectEvents call for every
 166          beginCollectEvents call. Usually you will group these around
 167          some code where you do not wish to get notified of every single
 168          event.</P>
 169
 170         @returns
 171              the current request level for event buffering.
 172
 173         @see    com::sun::star::linguistic2::XDictionaryListEvent
 174         @see    com::sun::star::linguistic2::XDictionaryListEventListener
 175         @see    com::sun::star::linguistic2::XDictionaryList::beginCollectEvents()
 176         @see    com::sun::star::linguistic2::XDictionaryList::flushEvents()
 177     */
 178     short endCollectEvents();
 179
 180     /** notifies the listeners of all buffered events and then clears
 181          that buffer.
 182
 183         @returns
 184              the current request level for event buffering.
 185
 186         @see    com::sun::star::linguistic2::XDictionaryListEvent
 187         @see    com::sun::star::linguistic2::XDictionaryListEventListener
 188         @see    com::sun::star::linguistic2::XDictionaryList::beginCollectEvents()
 189         @see    com::sun::star::linguistic2::XDictionaryList::endCollectEvents()
 190     */
 191     short flushEvents();
 192
 193     /** creates a new dictionary.
 194
 195         @returns
 196             an empty dictionary with the given name, language and type.
 197              `NULL` on failure.
 198
 199         @param  aName
 200             is the name of the dictionary (should be unique).
 201
 202         @param  aLocale
 203             defines the language of the dictionary.
 204              Use an empty aLocale for dictionaries which may contain
 205             entries of all languages.
 206
 207         @param  eDicType
 208             specifies the type of the dictionary.
 209
 210          @param aURL
 211             is the URL of the location where the dictionary is persistent,
 212             if the XStorable interface is supported.
 213             It may be empty, which means the dictionary will not be persistent.
 214
 215         @see    com::sun::star::linguistic2::XDictionary
 216         @see    com::sun::star::lang::Locale
 217         @see    com::sun::star::linguistic2::DictionaryType
 218     */
 219     com::sun::star::linguistic2::XDictionary createDictionary(
 220             [in] string aName,
 221             [in] com::sun::star::lang::Locale aLocale,
 222             [in] com::sun::star::linguistic2::DictionaryType eDicType,
 223             [in] string aURL );
 224
 225 };
 226
 227
 228 }; }; }; };
 229
 230 #endif
 231
 232 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */