LibreOffice LibreOffice 25.2 SDK API Reference

Exported Interfaces | List of all members
ConversionDictionary Service Referencepublished

represents a dictionary used in a conversion dictionary list. More...

`import"ConversionDictionary.idl";`

Inheritance diagram for ConversionDictionary:

## Exported Interfaces
interface | com::sun::star::linguistic2::XConversionDictionary
| to access the conversion dictionary functionality. More...
interface | com::sun::star::util::XFlushable
| to flush (save) the dictionary content to file More...
interface | com::sun::star::linguistic2::XConversionPropertyType

## Additional Inherited Members
Public Member Functions inherited from XConversionDictionary
string | getName ()
com::sun::star::lang::Locale | getLocale ()
short | getConversionType ()
void | setActive ([in] boolean bActivate)
| specifies whether the dictionary should be used or not . More...
boolean | isActive ()
void | clear ()
| removes all entries from the dictionary. More...
sequence< string > | getConversions ([in] string aText, [in] long nStartPos, [in] long nLength, [in] com::sun::star::linguistic2::ConversionDirection eDirection, [in] long nTextConversionOptions) raises ( com::sun::star::lang::IllegalArgumentException )
| searches for entries or conversions that match the given text. More...
void | addEntry ([in] string aLeftText, [in] string aRightText) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::ElementExistException)
| is used to add a conversion pair to the dictionary. More...
void | removeEntry ([in] string aLeftText, [in] string aRightText) raises ( com::sun::star::container::NoSuchElementException )
| removes a conversion pair from the dictionary. More...
short | getMaxCharCount ([in] com::sun::star::linguistic2::ConversionDirection eDirection)
| returns the maximum number of characters used as left or right text in entries. More...
sequence< string > | getConversionEntries ([in] com::sun::star::linguistic2::ConversionDirection eDirection)
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object. More...
void | acquire ()
| increases the reference counter by one. More...
void | release ()
| decreases the reference counter by one. More...
Protected Member Functions inherited from XFlushable
void | flush ()
| flushes the data of the object to the connected data source. More...
void | addFlushListener ([in] com::sun::star::util::XFlushListener l)
| adds the specified listener to receive event "flushed." More...
void | removeFlushListener ([in] com::sun::star::util::XFlushListener l)
| removes the specified listener. More...
Protected Member Functions inherited from XConversionPropertyType
void | setPropertyType ([in] string aLeftText, [in] string aRightText, [in] short nPropertyType) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::IllegalArgumentException )
| sets the property type for the specified entry. More...
short | getPropertyType ([in] string aLeftText, [in] string aRightText) raises ( com::sun::star::container::NoSuchElementException )
| returns the property type for the specified entry. More...

## Detailed Description

represents a dictionary used in a conversion dictionary list.

Specific implementations may put some restrictions for the dictionary or it's entries. Namely usually the order for the string pairs within a single entry will be defined.

See also
  com::sun::star::linguistic2::ConversionDictionaryList
  com::sun::star::linguistic2::HangulHanjaConversionDictionary
  com::sun::star::linguistic2::XConversionDictionary
  com::sun::star::linguistic2::XConversionPropertyType

Since
  OOo 1.1.2

## Exported Interfaces

## ◆ com::sun::star::linguistic2::XConversionDictionary

interface com::sun::star::linguistic2::XConversionDictionary

to access the conversion dictionary functionality.

## ◆ com::sun::star::linguistic2::XConversionPropertyType

interface com::sun::star::linguistic2::XConversionPropertyType
| optional

Since
  OOo 2.0

## ◆ com::sun::star::util::XFlushable

interface com::sun::star::util::XFlushable
| optional

to flush (save) the dictionary content to file

The documentation for this service was generated from the following file:

- com/sun/star/linguistic2/ConversionDictionary.idl