LibreOffice
LibreOffice 7.4 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 #ifndef __com_sun_star_linguistic2_XDictionary_idl__
20 #define __com_sun_star_linguistic2_XDictionary_idl__
21 
27 
28 
29 module com { module sun { module star { module linguistic2 {
30 
50 {
59 
66  void setActive( [in] boolean bActivate );
67 
72  boolean isActive();
73 
78  long getCount();
79 
87 
96 
109 
127  boolean addEntry(
129 
153  boolean add(
154  [in] string aWord,
155  [in] boolean bIsNegative,
156  [in] string aRplcText );
157 
167  boolean remove( [in] string aWord );
168 
174  boolean isFull();
175 
188  sequence<com::sun::star::linguistic2::XDictionaryEntry> getEntries();
189 
192  void clear();
193 
213 
228 
229 };
230 
231 
232 }; }; }; };
233 
234 #endif
235 
236 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
specifies the name of the object.
Definition: XNamed.idl:33
This interfaces gives access to a dictionary entry.
Definition: XDictionaryEntry.idl:49
This interfaces allows the object to act according to dictionary events.
Definition: XDictionaryEventListener.idl:39
This interfaces enables the object to access personal dictionaries.
Definition: XDictionary.idl:50
boolean removeDictionaryEventListener([in] com::sun::star::linguistic2::XDictionaryEventListener xListener)
removes an entry from the list of dictionary event listeners.
com::sun::star::linguistic2::DictionaryType getDictionaryType()
returns the type of the dictionary.
com::sun::star::lang::Locale getLocale()
void setActive([in] boolean bActivate)
specifies whether the dictionary should be used or not .
boolean add([in] string aWord, [in] boolean bIsNegative, [in] string aRplcText)
is used to make an entry in the dictionary.
boolean addDictionaryEventListener([in] com::sun::star::linguistic2::XDictionaryEventListener xListener)
adds an entry to the list of dictionary event listeners.
com::sun::star::linguistic2::XDictionaryEntry getEntry([in] string aWord)
searches for an entry that matches the given word.
void clear()
removes all entries from the dictionary.
void setLocale([in] com::sun::star::lang::Locale aLocale)
is used to set the language of the dictionary.
sequence< com::sun::star::linguistic2::XDictionaryEntry > getEntries()
boolean addEntry([in] com::sun::star::linguistic2::XDictionaryEntry xDicEntry)
is used to add an entry to the dictionary.
DictionaryType
describes the type of a personal dictionary.
Definition: DictionaryType.idl:38
Definition: Ambiguous.idl:22
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:38