|
Syntax
- short getCount
();
Description
Returns
-
the number of dictionaries in the list.
Syntax
- sequence< com::sun::star::linguistic2::XDictionary > getDictionaries
();
Description
Returns
-
a sequence with an entry for every dictionary
in the list.
See also
- XDictionary
-
Syntax
- com::sun::star::linguistic2::XDictionary getDictionaryByName
(
- string aDictionaryName );
Description
searches the list for a dictionary with a given name.
Returns
-
the XDictionary with the specified name. If no such
dictionary exists, NULL
will be returned.
Parameter aDictionaryName
-
specifies the name of the dictionary to look for.
See also
- XDictionary
-
Syntax
- boolean addDictionary
(
- com::sun::star::linguistic2::XDictionary xDictionary );
Description
adds a dictionary to the list.
Additionally, the dictionary-list will add itself to the list of dictionary
event listeners of that dictionary.
Returns
-
true
if the dictionary was added successfully,
false
otherwise.
Parameter xDictionary
-
the dictionary to be added.
See also
- removeDictionary
-
See also
- XDictionary
-
Syntax
- boolean removeDictionary
(
- com::sun::star::linguistic2::XDictionary xDictionary );
Description
removes a single dictionary from the list.
If the dictionary is still active, it will be deactivated
first. The dictionary-list will remove itself from the list of
dictionary event listeners of the dictionary.
Returns
-
true
if the dictionary was removed successfully, false
otherwise.
Parameter xDictionary
-
dictionary to be removed from the list of dictionaries.
See also
- addDictionary
-
See also
- XDictionary
-
Syntax
- boolean addDictionaryListEventListener
(
- com::sun::star::linguistic2::XDictionaryListEventListener xListener,
- boolean bReceiveVerbose );
Description
adds an entry to the list of dictionary-list event listeners.
On dictionary-list events, each entry in the listener list will
be notified via a call to
XDictionaryListEventListener::processDictionaryListEvent .
Returns
-
true
if the entry was made, false
otherwise.
If
XEventListener::disposing was called before,
it will always fail.
Parameter xListener
-
the object to be notified of dictionary-list events.
Parameter bReceiveVerbose
-
if the listener requires more detailed event
notification than usual.
See also
- removeDictionaryListEventListener
-
See also
- XDictionaryListEventListener
-
See also
- XDictionaryListEvent
-
Syntax
- boolean removeDictionaryListEventListener
(
- com::sun::star::linguistic2::XDictionaryListEventListener xListener );
Description
removes an entry from the list of dictionary-list event listeners.
Returns
-
true
if the object to be removed was found and removed,
false
otherwise.
Parameter xListener
-
the object to be removed from the listener list.
See also
- addDictionaryListEventListener
-
See also
- XDictionaryListEventListener
-
Syntax
- short beginCollectEvents
();
Description
increases request level for event buffering by one.
The request level for event buffering is an integer
counter that is initially set to 0.
As long as the request level is not 0, events will be buffered
until the next flushing of the buffer.
Returns
-
the current request level for event buffering.
See also
- XDictionaryListEvent
-
See also
- XDictionaryListEventListener
-
See also
- flushEvents
-
Syntax
- short endCollectEvents
();
Description
flushes the event buffer and decreases the request level for
event buffering by one.
There should be one matching endCollectEvents call for every
beginCollectEvents call. Usually you will group these around
some code where you do not wish to get notfied of every single
event.
Returns
-
the current request level for event buffering.
See also
- XDictionaryListEvent
-
See also
- XDictionaryListEventListener
-
See also
- flushEvents
-
Syntax
- short flushEvents
();
Description
notifies the listeners of all buffered events and then clears
that buffer.
Returns
-
the current request level for event buffering.
See also
- XDictionaryListEvent
-
See also
- XDictionaryListEventListener
-
Syntax
- com::sun::star::linguistic2::XDictionary createDictionary
(
- string aName,
- com::sun::star::lang::Locale aLocale,
- com::sun::star::linguistic2::DictionaryType eDicType,
- string aURL );
Description
creates a new dictionary.
Returns
-
an empty dictionary with the given name, language and type.
NULL
on failure.
Parameter aName
-
is the name of the dictionary (should be unique).
Parameter aLocale
-
defines the language of the dictionary.
Use an empty aLocale for dictionaries which may contain
entries of all languages.
Parameter eDicType
-
specifies the type of the dictionary.
Parameter aURL
-
is the URL of the location where the dictionary is persistent,
if the XStorable interface is supported.
It may be empty, which means the dictionary will not be persistent.
See also
- XDictionary
-
See also
- Locale
-
See also
- DictionaryType
-
|