/************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * Copyright 2008 by Sun Microsystems, Inc. * * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: XConversionDictionaryList.idl,v $ * $Revision: 1.10 $ * * 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 * * for a copy of the LGPLv3 License. * ************************************************************************/ #ifndef __com_sun_star_linguistic2_XConversionDictionaryList_idl__ #define __com_sun_star_linguistic2_XConversionDictionaryList_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include #endif #ifndef __com_sun_star_container_XNameContainer_idl__ #include #endif #ifndef __com_sun_star_linguistic2_XConversionDictionary_idl__ #include #endif #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ #include #endif #ifndef __com_sun_star_lang_NoSupportException_idl__ #include #endif #ifndef __com_sun_star_container_ElementExistException_idl__ #include #endif //============================================================================= module com { module sun { module star { module linguistic2 { //============================================================================= /** is used to manage and maintain a list of conversion dictionaries.

The dictionaries added to the list may or may not support the XFlushable interface. If they do those dictionaries have to be flushed upon termination of the dictionary list.

@since OOo 1.1.2 */ published interface XConversionDictionaryList : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** @returns the name container interface to the dictionaries in the list.

The interface can be used to add, remove or retrieve dictionaries from the list by specifying the name of the dictionary, and (in case of inserting) the interface to the dictionary as second parameter.

A dictionary to be added must support the XConversionDictionary interface. The dictionary to be added needs not necessarily be created by this service.

The replaceByName function is implemented empty since renaming of dictionaries is not allowed.

*/ com::sun::star::container::XNameContainer getDictionaryContainer(); //------------------------------------------------------------------------- /** creates a new dictionary and adds it to the dictionary list.

The dictionary will be empty and active.

@returns an empty dictionary with the given name, locale and conversion type. on failure. @param aName is the name of the dictionary (should be unique). @param aLocale defines the language of the dictionary. @param nConversionDictionaryType One of ConversionDictionaryType values. @throws NoSupportException when nConversionDictionaryType is not known by the implementation. @throws ElementExistException when a dictionary with the specified name already exists. */ com::sun::star::linguistic2::XConversionDictionary addNewDictionary( [in] string aName, [in] com::sun::star::lang::Locale aLocale, [in] short nConversionDictionaryType ) raises( com::sun::star::lang::NoSupportException, com::sun::star::container::ElementExistException ); //------------------------------------------------------------------------- /** searches for entries that match the given text.

All active dictionaries with matching locales and conversion type will be searched for entries matching the given text.

The exact string to be looked for is the substring from the aText parameter that starts at position nStartPos and has the length nLength.

@returns the list of entries found. If no entry was found, it is empty. @param aText the text where the substring to be looked for will be taken from. @param nStartPos the starting pos of the substring to be looked for. @param nLength the length of the substring to be looked for. @param aLocale Locale the conversion is refered to. @param nConversionDictionaryType specifies the type of conversion the dictionary can be used for. It is one of ConversionDictionaryType. @param eConversionDirection specifies the direction of the conversion to look for. It is one of ConversionDirection. @param nTextConversionOptions Combination of TextConversionOption values. @throws com::sun::star::lang::IllegalArgumentException if the nTextConversionOptions parameter is invalid for the given locale. @throws NoSupportException when nConversionDictionaryType is not known by the implementation, or when the locale is not supported (i.e. there are no dictionaries for that locale available). */ sequence< string > queryConversions( [in] string aText, [in] long nStartPos, [in] long nLength, [in] com::sun::star::lang::Locale aLocale, [in] short nConversionDictionaryType, [in] com::sun::star::linguistic2::ConversionDirection eDirection, [in] long nTextConversionOptions ) raises( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::NoSupportException ); //------------------------------------------------------------------------- /** returns the maximum number of characters used as left or right text in entries.

All active dictionaries of the specified locale and type will be looked up to get the result.

The parameter eDirection specifies if only the left text or the right text from entries should be considered.

@param aLocale Locale the conversion is refered to. @param nConversionDictionaryType specifies the type of conversion dictionaries to be looked up. It is one of ConversionDictionaryType. @param eDirection specifies if the left text or the right text of entries will be used. @see com::sun::star::linguistic2::ConversionDirection */ short queryMaxCharCount( [in] com::sun::star::lang::Locale aLocale, [in] short nConversionDictionaryType, [in] com::sun::star::linguistic2::ConversionDirection eDirection ); }; //============================================================================= }; }; }; }; #endif