interface XLinguServiceManager in module com::sun::star::linguistic2::

(Global Index)

Syntax

interface XLinguServiceManager : com::sun::star::uno::XInterface ;

Description

the basic interface to be used to access linguistic functionality.

This interface is used to access spellchecker, hyphenator, and thesaurus functionality. Additionally, it can query what implementations of those services are available (for specific languages or in general). It can select and query which of those implementations should be used for a specific language.

For spellchecking and thesaurus, the order in the list defines the order of creation/usage of those services. That is, if the first spellchecker implementation does not recognize the given word as correct, the second service implementation for that language is created and gets queried. If that one fails, the third one gets created and queried and so on. This chain stops if an implementation reports the word as correct or the end of the list is reached, in which case the word is reported as incorrect.

For the thesaurus, the behavior is the same when no meaning was found.

See also

SpellChecker

See also

Hyphenator

See also

Thesaurus

Method Summary

getSpellChecker

getHyphenator

getThesaurus

addLinguServiceManagerListener adds a listener to the list of event listeners.

removeLinguServiceManagerListener removes a listener from the list of event listeners.

getAvailableServices

setConfiguredServices sets the list of service implementations to be used for a given service and language.

getConfiguredServices queries the list of service implementations to be used for a given service and language.

Known Services Which Export this Interface

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

Method Details



getSpellChecker

Syntax

com::sun::star::linguistic2::XSpellChecker getSpellChecker ();

Description

Returns

the XSpellChecker interface to be used for spellchecking.

getHyphenator

Syntax

com::sun::star::linguistic2::XHyphenator getHyphenator ();

Description

Returns

the XHyphenator interface to be used for hyphenation.

getThesaurus

Syntax

com::sun::star::linguistic2::XThesaurus getThesaurus ();

Description

Returns

the XThesaurus interface to be used for thesaurus functionality.

addLinguServiceManagerListener

Syntax

boolean addLinguServiceManagerListener (
com::sun::star::lang::XEventListener xListener );

Description

adds a listener to the list of event listeners.

The listeners may support one or both of XDictionaryEventListener and XLinguServiceEventListener interfaces.

Returns

true if the listener was succesfully added, false otherwise.

Parameter xListener

the listener to be added.

removeLinguServiceManagerListener

Syntax

boolean removeLinguServiceManagerListener (
com::sun::star::lang::XEventListener xListener );

Description

removes a listener from the list of event listeners.

Returns

true if the listener was succesfully removed, false otherwise.

Parameter xListener

the listener to be removed.

getAvailableServices

Syntax

sequence< string > getAvailableServices (
string aServiceName,
com::sun::star::lang::Locale aLocale );

Description

Returns

the list of implementation names of the available services.

Parameter aServiceName

the name of the service requesting the list of available implementations.

Parameter aLocale

the language used to query the list of available implementations.

setConfiguredServices

Syntax

void setConfiguredServices (
string aServiceName,
com::sun::star::lang::Locale aLocale,
sequence< string > aServiceImplNames );

Description

sets the list of service implementations to be used for a given service and language.

Parameter aServiceName

the name of the service to set the list of implementations to be used.

Parameter aLocale

the language to set the list.

Parameter aServiceImplNames

the name of the service to set the list.

getConfiguredServices

Syntax

sequence< string > getConfiguredServices (
string aServiceName,
com::sun::star::lang::Locale aLocale );

Description

queries the list of service implementations to be used for a given service and language.

Returns

the list of implementation names of the services to be used.

Parameter aServiceName

the name of the service to get queried.

Parameter aLocale

the language to get queried.
Top of Page