LibreOffice LibreOffice 25.8 SDK API Reference

XDictionaryList.idl
Go to the documentation of this file.
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
21module com { module sun { module star { module linguistic2 {
22
33published interface XDictionaryList : com::sun::star::uno::XInterface
34{
39 short getCount();
40
48 sequence<com::sun::star::linguistic2::XDictionary> getDictionaries();
49
61 com::sun::star::linguistic2::XDictionary getDictionaryByName(
62 [in] string aDictionaryName );
63
78 boolean addDictionary(
79 [in] com::sun::star::linguistic2::XDictionary xDictionary );
80
96 boolean removeDictionary(
97 [in] com::sun::star::linguistic2::XDictionary xDictionary );
98
120 boolean addDictionaryListEventListener(
121 [in] com::sun::star::linguistic2::XDictionaryListEventListener xListener,
122 [in] boolean bReceiveVerbose );
123
136 boolean removeDictionaryListEventListener(
137 [in] com::sun::star::linguistic2::XDictionaryListEventListener xListener );
138
154 short beginCollectEvents();
155
172 short endCollectEvents();
173
185 short flushEvents();
186
213 com::sun::star::linguistic2::XDictionary createDictionary(
214 [in] string aName,
215 [in] com::sun::star::lang::Locale aLocale,
216 [in] com::sun::star::linguistic2::DictionaryType eDicType,
217 [in] string aURL );
218
219};
220
221
222}; }; }; };
223
224/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::linguistic2::XDictionaryListEventListener
This interfaces allows the object to act according to dictionary-list events.
Definition: XDictionaryListEventListener.idl:35
com::sun::star::linguistic2::XDictionaryList
is used to manage and maintain a list of dictionaries.
Definition: XDictionaryList.idl:34
com::sun::star::linguistic2::XDictionaryList::getDictionaries
sequence< com::sun::star::linguistic2::XDictionary > getDictionaries()
com::sun::star::linguistic2::XDictionaryList::removeDictionary
boolean removeDictionary([in] com::sun::star::linguistic2::XDictionary xDictionary)
removes a single dictionary from the list.
com::sun::star::linguistic2::XDictionaryList::beginCollectEvents
short beginCollectEvents()
increases request level for event buffering by one.
com::sun::star::linguistic2::XDictionaryList::endCollectEvents
short endCollectEvents()
flushes the event buffer and decreases the request level for event buffering by one.
com::sun::star::linguistic2::XDictionaryList::getDictionaryByName
com::sun::star::linguistic2::XDictionary getDictionaryByName([in] string aDictionaryName)
searches the list for a dictionary with a given name.
com::sun::star::linguistic2::XDictionaryList::getCount
short getCount()
com::sun::star::linguistic2::XDictionaryList::createDictionary
com::sun::star::linguistic2::XDictionary createDictionary([in] string aName, [in] com::sun::star::lang::Locale aLocale, [in] com::sun::star::linguistic2::DictionaryType eDicType, [in] string aURL)
creates a new dictionary.
com::sun::star::linguistic2::XDictionaryList::addDictionary
boolean addDictionary([in] com::sun::star::linguistic2::XDictionary xDictionary)
adds a dictionary to the list.
com::sun::star::linguistic2::XDictionaryList::removeDictionaryListEventListener
boolean removeDictionaryListEventListener([in] com::sun::star::linguistic2::XDictionaryListEventListener xListener)
removes an entry from the list of dictionary-list event listeners.
com::sun::star::linguistic2::XDictionaryList::addDictionaryListEventListener
boolean addDictionaryListEventListener([in] com::sun::star::linguistic2::XDictionaryListEventListener xListener, [in] boolean bReceiveVerbose)
adds an entry to the list of dictionary-list event listeners.
com::sun::star::linguistic2::XDictionaryList::flushEvents
short flushEvents()
notifies the listeners of all buffered events and then clears that buffer.
com::sun::star::linguistic2::XDictionary
This interfaces enables the object to access personal dictionaries.
Definition: XDictionary.idl:42
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com::sun::star::linguistic2::DictionaryType
DictionaryType
describes the type of a personal dictionary.
Definition: DictionaryType.idl:36
com
Definition: Ambiguous.idl:20
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:34