|
Syntax
- com::sun::star::linguistic2::DictionaryType getDictionaryType
();
Description
returns the type of the dictionary.
Returns
-
the type of the dictionary.
See also
- DictionaryType
-
Syntax
- void setActive
(
- boolean bActivate );
Description
specifies whether the dictionary should be used or not .
Parameter bAcvtivate
-
true
if the dictionary should be used, false
otherwise.
Syntax
- boolean isActive
();
Description
Returns
-
true
if the dictionary is active, false
otherwise.
Syntax
- short getCount
();
Description
Returns
-
the number of entries in the dictionary.
Syntax
- com::sun::star::lang::Locale getLocale
();
Description
Returns
-
the language of the dictionary.
See also
- Locale
-
Syntax
- void setLocale
(
- com::sun::star::lang::Locale aLocale );
Description
is used to set the language of the dictionary.
Parameter aLocale
-
the new language of the dictionary.
See also
- Locale
-
Syntax
- com::sun::star::linguistic2::XDictionaryEntry getEntry
(
- string aWord );
Description
searches for an entry that matches the given word.
Returns
-
the reference to the entry found. If no entry was found,
it is NULL.
Parameter aWord
-
the word to be looked for.
See also
- XDictionaryEntry
-
Syntax
- boolean addEntry
(
- com::sun::star::linguistic2::XDictionaryEntry xDicEntry );
Description
is used to add an entry to the dictionary.
If an entry already exists, the dictionary remains unchanged
and false
will be returned.
In positive dictionaries only postive entries
can be made, and in negative ones only negative entries.
Parameter xDicEntry
-
the entry to be added.
Returns
-
true
if the entry was successfully added false
otherwise.
See also
- add
-
See also
- remove
-
See also
- isFull
-
See also
- XDictionaryEntry
-
See also
- DictionaryType
-
Syntax
- boolean add
(
- string aWord,
- boolean bIsNegative,
- string aRplcText );
Description
is used to make an entry in the dictionary.
If an entry already exists, the dictionary remains unchanged
and false
will be returned.
In positive dictionaries only postive entries
can be made, and in negative ones only negative entries.
Parameter aWord
-
the word to be added.
Parameter bIsNegative
-
specifies whether the entry will be a negative one or not.
Parameter aRplcText
-
in the case of a negative entry, this is the replacement text to
be used when replacing aWord. Otherwise, it is undefined.
Returns
-
true
if the entry was successfully added, false
otherwise.
See also
- addEntry
-
See also
- remove
-
See also
- isFull
-
See also
- DictionaryType
-
Syntax
- boolean remove
(
- string aWord );
Description
removes an entry from the dictionary.
Parameter aWord
-
the word matching the entry to be removed.
Returns
-
true
if the entry was successfully removed, false
otherwise (especially if the entry was not found).
See also
- addEntry
-
See also
- add
-
Syntax
- boolean isFull
();
Description
Returns
-
true
if the dictionary is full and no further
entry can be made, false
otherwise.
See also
- addEntry
-
See also
- add
-
Syntax
- sequence< com::sun::star::linguistic2::XDictionaryEntry > getEntries
();
Description
Returns
-
a sequence with all the entries of the dictionary.
See also
- XDictionaryEntry
-
Syntax
- void clear
();
Description
removes all entries from the dictionary.
Syntax
- boolean addDictionaryEventListener
(
- com::sun::star::linguistic2::XDictionaryEventListener xListener );
Description
adds an entry to the list of dictionary event listeners.
On dictionary events, each entry in the listener list will
be notified via a call to
XDictionaryEventListener::processDictionaryEvent .
Parameter xListener
-
the entry to be made, that is, the object that wants notifications.
Returns
-
true
if the entry was successfully made, false
otherwise.
If
XEventListener::disposing was called before,
it will always fail.
See also
- removeDictionaryEventListener
-
See also
- XDictionaryEventListener
-
Syntax
- boolean removeDictionaryEventListener
(
- com::sun::star::linguistic2::XDictionaryEventListener xListener );
Description
removes an entry from the list of dictionary event listeners.
Parameter xListener
-
the reference to the listening object to be removed.
Returns
-
true
if the object to be removed was found and removed,
false
if the object was not found in the list.
See also
- addDictionaryEventListener
-
See also
- XDictionaryEventListener
-
|