Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: linguistic2 ::

interface XConversionDictionaryList
Description
is used to manage and maintain a list of conversion dictionaries.

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

Since
OOo 1.1.2

Methods' Summary
getDictionaryContainer  
addNewDictionary creates a new dictionary and adds it to the dictionary list.  
queryConversions searches for entries that match the given text.  
queryMaxCharCount returns the maximum number of characters used as left or right text in entries.  
Methods' Details
getDictionaryContainer
::com::sun::star::container::XNameContainer
getDictionaryContainer();

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.

addNewDictionary
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 );

Description
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. NULL on failure.
Parameter aName
is the name of the dictionary (should be unique).
Parameter aLocale
defines the language of the dictionary.
Parameter 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.
queryConversions
sequence< string >
queryConversions( [in] string  aText,
[in] long  nStartPos,
[in] long  nLength,
[in] ::com::sun::star::lang::Locale  aLocale,
[in] short  nConversionDictionaryType,
[in] ConversionDirection  eDirection,
[in] long  nTextConversionOptions )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::NoSupportException );

Description
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.
Parameter aText
the text where the substring to be looked for will be taken from.
Parameter nStartPos
the starting pos of the substring to be looked for.
Parameter nLength
the length of the substring to be looked for.
Parameter aLocale
Locale the conversion is refered to.
Parameter nConversionDictionaryType
specifies the type of conversion the dictionary can be used for. It is one of ConversionDictionaryType.
Parameter eConversionDirection
specifies the direction of the conversion to look for. It is one of ConversionDirection.
Parameter nTextConversionOptions
Combination of ::com::sun::star::i18n::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).
queryMaxCharCount
short
queryMaxCharCount( [in] ::com::sun::star::lang::Locale  aLocale,
[in] short  nConversionDictionaryType,
[in] ConversionDirection  eDirection );

Description
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.

Parameter aLocale
Locale the conversion is refered to.
Parameter nConversionDictionaryType
specifies the type of conversion dictionaries to be looked up. It is one of ConversionDictionaryType.
Parameter eDirection
specifies if the left text or the right text of entries will be used.
See also
ConversionDirection
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.