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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_linguistic2_XDictionaryList_idl__
  29 #define __com_sun_star_linguistic2_XDictionaryList_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #include <com/sun/star/linguistic2/XDictionary.idl>
  33 #include <com/sun/star/linguistic2/XDictionaryListEventListener.idl>
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module linguistic2 {
  38
  39 //=============================================================================
  40 /** is used to manage and maintain a list of dictionaries.
  41
  42     <P>A dictionary-list may be given to a spell checker or hyphenator
  43     service implementation on their creation in order to supply a set
  44     of dictionaries and additional information to be used for
  45     those purposes.</P>
  46
  47     @see    <type scope="com::sun::star::linguistic2">XDictionary</type>
  48     @see    <type scope="com::sun::star::uno">XInterface</type>
  49 */
  50 published interface XDictionaryList : com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53     /**
  54         @returns
  55             the number of dictionaries in the list.
  56     */
  57     short getCount();
  58
  59     //-------------------------------------------------------------------------
  60     /**
  61         @returns
  62              a sequence with an entry for every dictionary
  63             in the list.
  64
  65         @see    <type scope="com::sun::star::linguistic2">XDictionary</type>
  66     */
  67     sequence<com::sun::star::linguistic2::XDictionary> getDictionaries();
  68
  69     //-------------------------------------------------------------------------
  70     /** searches the list for a dictionary with a given name.
  71
  72          @returns
  73             the XDictionary with the specified name. If no such
  74             dictionary exists, <NULL/> will be returned.
  75
  76         @param  aDictionaryName
  77             specifies the name of the dictionary to look for.
  78
  79         @see    <type scope="com::sun::star::linguistic2">XDictionary</type>
  80     */
  81     com::sun::star::linguistic2::XDictionary getDictionaryByName(
  82             [in] string aDictionaryName );
  83
  84     //-------------------------------------------------------------------------
  85     /** adds a dictionary to the list.
  86
  87         <P>Additionally, the dictionary-list will add itself to the list of dictionary
  88          event listeners of that dictionary.</P>
  89
  90         @returns
  91              <TRUE/> if the dictionary was added successfully,
  92             <FALSE/> otherwise.
  93
  94         @param  xDictionary
  95             the dictionary to be added.
  96
  97         @see    <type scope="com::sun::star::linguistic2">XDictionary</type>
  98     */
  99     boolean addDictionary(
 100             [in] com::sun::star::linguistic2::XDictionary xDictionary );
 101
 102     //-------------------------------------------------------------------------
 103     /** removes a single dictionary from the list.
 104
 105         <P>If the dictionary is still active, it will be deactivated
 106         first. The dictionary-list will remove itself from the list of
 107         dictionary event listeners of the dictionary.</P>
 108
 109         @returns
 110              <TRUE/> if the dictionary was removed successfully, <FALSE/>
 111              otherwise.
 112
 113         @param  xDictionary
 114             dictionary to be removed from the list of dictionaries.
 115
 116         @see    <type scope="com::sun::star::linguistic2">XDictionary</type>
 117     */
 118     boolean removeDictionary(
 119             [in] com::sun::star::linguistic2::XDictionary xDictionary );
 120
 121     //-------------------------------------------------------------------------
 122     /** adds an entry to the list of dictionary-list event listeners.
 123
 124         <P>On dictionary-list events, each entry in the listener list will
 125          be notified via a call to
 126         <member scope="com::sun::star::linguistic2">XDictionaryListEventListener::processDictionaryListEvent</member>.</P>
 127
 128         @returns
 129             <TRUE/> if the entry was made, <FALSE/> otherwise.
 130             If <member scope="com::sun::star::lang">XEventListener::disposing</member>
 131             was called before, it will always fail.
 132
 133         @param  xListener
 134             the object to be notified of dictionary-list events.
 135
 136         @param  bReceiveVerbose
 137             <TRUE/> if the listener requires more detailed event
 138             notification than usual.
 139
 140         @see    <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type>
 141         @see    <type scope="com::sun::star::linguistic2">XDictionaryListEvent</type>
 142     */
 143     boolean addDictionaryListEventListener(
 144         [in] com::sun::star::linguistic2::XDictionaryListEventListener xListener,
 145         [in] boolean bReceiveVerbose );
 146
 147     //-------------------------------------------------------------------------
 148     /** removes an entry from the list of dictionary-list event listeners.
 149
 150         @returns
 151             <TRUE/> if the object to be removed was found and removed,
 152             <FALSE/> otherwise.
 153
 154         @param  xListener
 155             the object to be removed from the listener list.
 156
 157         @see    <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type>
 158         @see    <type scope="com::sun::star::linguistic2">XDictionaryListEvent</type>
 159     */
 160     boolean removeDictionaryListEventListener(
 161         [in] com::sun::star::linguistic2::XDictionaryListEventListener xListener );
 162
 163     //-------------------------------------------------------------------------
 164     /** increases request level for event buffering by one.
 165
 166          <P>The request level for event buffering is an integer
 167          counter that is initially set to 0.
 168         As long as the request level is not 0, events will be buffered
 169          until the next flushing of the buffer.</P>
 170
 171         @returns
 172              the current request level for event buffering.
 173
 174         @see    <type scope="com::sun::star::linguistic2">XDictionaryListEvent</type>
 175         @see    <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type>
 176         @see    <member scope="com::sun::star::linguistic2">XDictionaryList::endCollectEvents</member>
 177         @see    <member scope="com::sun::star::linguistic2">XDictionaryList::flushEvents</member>
 178     */
 179     short beginCollectEvents();
 180
 181     //-------------------------------------------------------------------------
 182     /** flushes the event buffer and decreases the request level for
 183          event buffering by one.
 184
 185          <P>There should be one matching endCollectEvents call for every
 186          beginCollectEvents call. Usually you will group these around
 187          some code where you do not wish to get notified of every single
 188          event.</P>
 189
 190         @returns
 191              the current request level for event buffering.
 192
 193         @see    <type scope="com::sun::star::linguistic2">XDictionaryListEvent</type>
 194         @see    <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type>
 195         @see    <member scope="com::sun::star::linguistic2">XDictionaryList::beginCollectEvents</member>
 196         @see    <member scope="com::sun::star::linguistic2">XDictionaryList::flushEvents</member>
 197     */
 198     short endCollectEvents();
 199
 200     //-------------------------------------------------------------------------
 201     /** notifies the listeners of all buffered events and then clears
 202          that buffer.
 203
 204         @returns
 205              the current request level for event buffering.
 206
 207         @see    <type scope="com::sun::star::linguistic2">XDictionaryListEvent</type>
 208         @see    <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type>
 209         @see    <member scope="com::sun::star::linguistic2">XDictionaryList::beginCollectEvents</member>
 210         @see    <member scope="com::sun::star::linguistic2">XDictionaryList::endCollectEvents</member>
 211     */
 212     short flushEvents();
 213
 214     //-------------------------------------------------------------------------
 215     /** creates a new dictionary.
 216
 217         @returns
 218             an empty dictionary with the given name, language and type.
 219              <NULL/> on failure.
 220
 221         @param  aName
 222             is the name of the dictionary (should be unique).
 223
 224         @param  aLocale
 225             defines the language of the dictionary.
 226              Use an empty aLocale for dictionaries which may contain
 227             entries of all languages.
 228
 229         @param  eDicType
 230             specifies the type of the dictionary.
 231
 232          @param aURL
 233             is the URL of the location where the dictionary is persistent,
 234             if the XStorable interface is supported.
 235             It may be empty, which means the dictionary will not be persistent.
 236
 237         @see    <type scope="com::sun::star::linguistic2">XDictionary</type>
 238         @see    <type scope="com::sun::star::lang">Locale</type>
 239         @see    <type scope="com::sun::star::linguistic2">DictionaryType</type>
 240     */
 241     com::sun::star::linguistic2::XDictionary createDictionary(
 242             [in] string aName,
 243             [in] com::sun::star::lang::Locale aLocale,
 244             [in] com::sun::star::linguistic2::DictionaryType eDicType,
 245             [in] string aURL );
 246
 247 };
 248
 249 //=============================================================================
 250
 251 }; }; }; };
 252
 253 #endif
 254
 255 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */