Methods' Details |
getDictionaryType
- Description
- returns the type of the dictionary.
- Returns
- the type of the dictionary.
|
|
setActive
void |
setActive( |
[in] boolean |
bActivate ); |
- Description
- specifies whether the dictionary should be used or not .
- Parameter bAcvtivate
- true if the dictionary should be used, false otherwise.
|
|
isActive
- Returns
- true if the dictionary is active, false otherwise.
|
|
getCount
- Returns
- the number of entries in the dictionary.
|
|
getLocale
- Returns
- the language of the dictionary.
|
|
setLocale
void |
setLocale( |
[in] ::com::sun::star::lang::Locale |
aLocale ); |
- Description
- is used to set the language of the dictionary.
- Parameter aLocale
- the new language of the dictionary.
|
|
getEntry
- 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.
|
|
addEntry
- 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.
|
|
add
boolean |
add( |
[in] string |
aWord, |
| [in] boolean |
bIsNegative, |
| [in] 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.
|
|
remove
boolean |
remove( |
[in] 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).
|
|
isFull
- Returns
- true if the dictionary is full and no further
entry can be made, false otherwise.
|
|
getEntries
- Usage Restrictions
- deprecated
- Description
This function should no longer be used since with the expansion of the
maximum number of allowed entries the result may become unreasonable large!
- Returns
- a sequence with all the entries of the dictionary.
|
|
clear
- Description
- removes all entries from the dictionary.
|
|
addDictionaryEventListener
- 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 ::com::sun::star::lang::XEventListener::disposing was called before,
it will always fail.
|
|
removeDictionaryEventListener
- 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.
|
|
Copyright © 2010 Sun Microsystems, Inc.