summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/linguistic2/XDictionary.idl
diff options
context:
space:
mode:
authorMichael Stahl <mstahl@redhat.com>2012-01-28 20:57:40 +0100
committerMichael Stahl <mstahl@redhat.com>2012-01-28 20:57:40 +0100
commit2716f7dce26f16a2b677c178aa7d01cea096ae47 (patch)
tree9e9f67205cd5b72f1031721273e1534a3a1e5b0f /offapi/com/sun/star/linguistic2/XDictionary.idl
parent10ac9e750447fd57e3cef7993b0ad6c6538d6269 (diff)
replace obsolete "master" branch with README that points at new repoHEADmaster-deletedmaster
Diffstat (limited to 'offapi/com/sun/star/linguistic2/XDictionary.idl')
-rw-r--r--offapi/com/sun/star/linguistic2/XDictionary.idl261
1 files changed, 0 insertions, 261 deletions
diff --git a/offapi/com/sun/star/linguistic2/XDictionary.idl b/offapi/com/sun/star/linguistic2/XDictionary.idl
deleted file mode 100644
index 342e68006..000000000
--- a/offapi/com/sun/star/linguistic2/XDictionary.idl
+++ /dev/null
@@ -1,261 +0,0 @@
-/*************************************************************************
- *
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * Copyright 2000, 2010 Oracle and/or its affiliates.
- *
- * OpenOffice.org - a multi-platform office productivity suite
- *
- * This file is part of OpenOffice.org.
- *
- * OpenOffice.org is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License version 3
- * only, as published by the Free Software Foundation.
- *
- * OpenOffice.org is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License version 3 for more details
- * (a copy is included in the LICENSE file that accompanied this code).
- *
- * You should have received a copy of the GNU Lesser General Public License
- * version 3 along with OpenOffice.org. If not, see
- * <http://www.openoffice.org/license.html>
- * for a copy of the LGPLv3 License.
- *
- ************************************************************************/
-#ifndef __com_sun_star_linguistic2_XDictionary_idl__
-#define __com_sun_star_linguistic2_XDictionary_idl__
-
-#include <com/sun/star/container/XNamed.idl>
-#include <com/sun/star/lang/Locale.idl>
-#include <com/sun/star/linguistic2/DictionaryType.idl>
-#include <com/sun/star/linguistic2/XDictionaryEntry.idl>
-#include <com/sun/star/linguistic2/XDictionaryEventListener.idl>
-
-//=============================================================================
-
-module com { module sun { module star { module linguistic2 {
-
-//=============================================================================
-/** This interfaces enables the object to access personal dictionaries.
-
- <P>Personal dictionaries are used to supply additional
- information for spell checking and hyphenation (see
- <type scope="com::sun::star::linguistic2">XDictionaryEntry</type>).
- Only active dictionaries with an appropriate language are used
- for that purpose.
- The entries of an active, positive dictionary are words that are
- required to be recognized as correct during the spell checking
- process. Additionally, they will be used for hyphenation.
- Entries of a negative dictionary are required to be recognized
- as negative words, for example, words that should not be used, during
- SPELLCHECK. An entry in a negative dictionary may supply a
- proposal for a word to be used instead of the one being used.</P>
-
- @see <type scope="com::sun::star::linguistic2">XDictionaryEvent</type>
- @see <type scope="com::sun::star::container">XNamed</type>
-*/
-published interface XDictionary : com::sun::star::container::XNamed
-{
- //-------------------------------------------------------------------------
- /** returns the type of the dictionary.
-
- @returns
- the type of the dictionary.
-
- @see <type scope="com::sun::star::linguistic2">DictionaryType</type>
- */
- com::sun::star::linguistic2::DictionaryType getDictionaryType();
-
- //-------------------------------------------------------------------------
- /** specifies whether the dictionary should be used or not .
-
- @param bAcvtivate
- <TRUE/> if the dictionary should be used, <FALSE/> otherwise.
-
- */
- void setActive( [in] boolean bActivate );
-
- //-------------------------------------------------------------------------
- /**
- @returns
- <TRUE/> if the dictionary is active, <FALSE/> otherwise.
- */
- boolean isActive();
-
- //-------------------------------------------------------------------------
- /**
- @returns
- the number of entries in the dictionary.
- */
- long getCount();
-
- //-------------------------------------------------------------------------
- /**
- @returns
- the language of the dictionary.
-
- @see <type scope="com::sun::star::lang">Locale</type>
- */
- com::sun::star::lang::Locale getLocale();
-
- //-------------------------------------------------------------------------
- /** is used to set the language of the dictionary.
-
- @param aLocale
- the new language of the dictionary.
-
- @see <type scope="com::sun::star::lang">Locale</type>
- */
- void setLocale( [in] com::sun::star::lang::Locale aLocale );
-
- //-------------------------------------------------------------------------
- /** searches for an entry that matches the given word.
-
- @returns
- the reference to the entry found. If no entry was found,
- it is NULL.
-
- @param aWord
- the word to be looked for.
-
- @see <type scope="com::sun::star::linguistic2">XDictionaryEntry</type>
- */
- com::sun::star::linguistic2::XDictionaryEntry getEntry( [in] string aWord );
-
- //-------------------------------------------------------------------------
- /** is used to add an entry to the dictionary.
-
- <P>If an entry already exists, the dictionary remains unchanged
- and <FALSE/> will be returned.</P>
-
- <P>In positive dictionaries only positive entries
- can be made, and in negative ones only negative entries.</P>
-
- @param xDicEntry
- the entry to be added.
-
- @returns
- <TRUE/> if the entry was successfully added <FALSE/> otherwise.
-
- @see <type scope="com::sun::star::linguistic2">XDictionaryEntry</type>
- @see <type scope="com::sun::star::linguistic2">DictionaryType</type>
- */
- boolean addEntry(
- [in] com::sun::star::linguistic2::XDictionaryEntry xDicEntry );
-
- //-------------------------------------------------------------------------
- /** is used to make an entry in the dictionary.
-
- <P>If an entry already exists, the dictionary remains unchanged
- and <FALSE/> will be returned.</P>
-
- <P>In positive dictionaries only positive entries
- can be made, and in negative ones only negative entries.</P>
-
- @param aWord
- the word to be added.
-
- @param bIsNegative
- specifies whether the entry will be a negative one or not.
-
- @param aRplcText
- in the case of a negative entry, this is the replacement text to
- be used when replacing aWord. Otherwise, it is undefined.
-
- @returns
- <TRUE/> if the entry was successfully added, <FALSE/> otherwise.
-
- @see <type scope="com::sun::star::linguistic2">DictionaryType</type>
- */
- boolean add(
- [in] string aWord,
- [in] boolean bIsNegative,
- [in] string aRplcText );
-
- //-------------------------------------------------------------------------
- /** removes an entry from the dictionary.
-
- @param aWord
- the word matching the entry to be removed.
-
- @returns
- <TRUE/> if the entry was successfully removed, <FALSE/>
- otherwise (especially if the entry was not found).
- */
- boolean remove( [in] string aWord );
-
- //-------------------------------------------------------------------------
- /**
- @returns
- <TRUE/> if the dictionary is full and no further
- entry can be made, <FALSE/> otherwise.
- */
- boolean isFull();
-
- //-------------------------------------------------------------------------
- /**
- <p>This function should no longer be used since with the expansion of the
- maximum number of allowed entries the result may become unreasonable large!</p>
-
- @returns
- a sequence with all the entries of the dictionary.
-
- @see <type scope="com::sun::star::linguistic2">XDictionaryEntry</type>
- @see <type scope="com::sun::star::linguistic2">XSearchableDictionary</type>
- @deprecated
- */
-
- sequence<com::sun::star::linguistic2::XDictionaryEntry> getEntries();
-
- //-------------------------------------------------------------------------
- /** removes all entries from the dictionary.
- */
- void clear();
-
- //-------------------------------------------------------------------------
- /** adds an entry to the list of dictionary event listeners.
-
- <P>On dictionary events, each entry in the listener list will
- be notified via a call to
- <member scope="com::sun::star::linguistic2">XDictionaryEventListener::processDictionaryEvent</member>.</P>
-
- @param xListener
- the entry to be made, that is, the object that wants notifications.
-
- @returns
- <TRUE/> if the entry was successfully made, <FALSE/> otherwise.
- If <member scope="com::sun::star::lang">XEventListener::disposing</member> was called before,
- it will always fail.
-
- @see <member scope="com::sun::star::linguistic2">XDictionary::removeDictionaryEventListener</member>
- @see <type scope="com::sun::star::linguistic2">XDictionaryEventListener</type>
- */
- boolean addDictionaryEventListener(
- [in] com::sun::star::linguistic2::XDictionaryEventListener xListener );
-
- //-------------------------------------------------------------------------
- /** removes an entry from the list of dictionary event listeners.
-
- @param xListener
- the reference to the listening object to be removed.
-
- @returns
- <TRUE/> if the object to be removed was found and removed,
- <FALSE/> if the object was not found in the list.
-
- @see <member scope="com::sun::star::linguistic2">XDictionary::addDictionaryEventListener</member>
- @see <type scope="com::sun::star::linguistic2">XDictionaryEventListener</type>
- */
- boolean removeDictionaryEventListener(
- [in] com::sun::star::linguistic2::XDictionaryEventListener xListener );
-
-};
-
-//=============================================================================
-
-}; }; }; };
-
-#endif
-