LibreOffice LibreOffice 25.2 SDK API Reference

XDictionary.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
41published interface XDictionary : com::sun::star::container::XNamed
42{
50 com::sun::star::linguistic2::DictionaryType getDictionaryType();
51
58 void setActive( [in] boolean bActivate );
59
64 boolean isActive();
65
70 long getCount();
71
78 com::sun::star::lang::Locale getLocale();
79
87 void setLocale( [in] com::sun::star::lang::Locale aLocale );
88
100 com::sun::star::linguistic2::XDictionaryEntry getEntry( [in] string aWord );
101
119 boolean addEntry(
120 [in] com::sun::star::linguistic2::XDictionaryEntry xDicEntry );
121
145 boolean add(
146 [in] string aWord,
147 [in] boolean bIsNegative,
148 [in] string aRplcText );
149
159 boolean remove( [in] string aWord );
160
166 boolean isFull();
167
180 sequence<com::sun::star::linguistic2::XDictionaryEntry> getEntries();
181
184 void clear();
185
203 boolean addDictionaryEventListener(
204 [in] com::sun::star::linguistic2::XDictionaryEventListener xListener );
205
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: */
com::sun::star::container::XNamed
specifies the name of the object.
Definition: XNamed.idl:29
com::sun::star::linguistic2::XDictionaryEntry
This interfaces gives access to a dictionary entry.
Definition: XDictionaryEntry.idl:44
com::sun::star::linguistic2::XDictionaryEventListener
This interfaces allows the object to act according to dictionary events.
Definition: XDictionaryEventListener.idl:34
com::sun::star::linguistic2::XDictionary
This interfaces enables the object to access personal dictionaries.
Definition: XDictionary.idl:42
com::sun::star::linguistic2::XDictionary::removeDictionaryEventListener
boolean removeDictionaryEventListener([in] com::sun::star::linguistic2::XDictionaryEventListener xListener)
removes an entry from the list of dictionary event listeners.
com::sun::star::linguistic2::XDictionary::getDictionaryType
com::sun::star::linguistic2::DictionaryType getDictionaryType()
returns the type of the dictionary.
com::sun::star::linguistic2::XDictionary::getLocale
com::sun::star::lang::Locale getLocale()
com::sun::star::linguistic2::XDictionary::getEntries
sequence< com::sun::star::linguistic2::XDictionaryEntry > getEntries()
com::sun::star::linguistic2::XDictionary::isActive
boolean isActive()
com::sun::star::linguistic2::XDictionary::getCount
long getCount()
com::sun::star::linguistic2::XDictionary::setActive
void setActive([in] boolean bActivate)
specifies whether the dictionary should be used or not .
com::sun::star::linguistic2::XDictionary::add
boolean add([in] string aWord, [in] boolean bIsNegative, [in] string aRplcText)
is used to make an entry in the dictionary.
com::sun::star::linguistic2::XDictionary::addDictionaryEventListener
boolean addDictionaryEventListener([in] com::sun::star::linguistic2::XDictionaryEventListener xListener)
adds an entry to the list of dictionary event listeners.
com::sun::star::linguistic2::XDictionary::getEntry
com::sun::star::linguistic2::XDictionaryEntry getEntry([in] string aWord)
searches for an entry that matches the given word.
com::sun::star::linguistic2::XDictionary::clear
void clear()
removes all entries from the dictionary.
com::sun::star::linguistic2::XDictionary::setLocale
void setLocale([in] com::sun::star::lang::Locale aLocale)
is used to set the language of the dictionary.
com::sun::star::linguistic2::XDictionary::isFull
boolean isFull()
com::sun::star::linguistic2::XDictionary::addEntry
boolean addEntry([in] com::sun::star::linguistic2::XDictionaryEntry xDicEntry)
is used to add an entry to the dictionary.
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