LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | List of all members
Dictionary Service Reference

represents a dictionary used for spell checking and hyphenation. More...

import"Dictionary.idl";

Inheritance diagram for Dictionary:
XDictionary XSearchableDictionary XStorable XNamed XDictionary XInterface XInterface XNamed XInterface

Exported Interfaces

interface com::sun::star::linguistic2::XDictionary
 to access the dictionary functionality. More...
 
interface com::sun::star::linguistic2::XSearchableDictionary
 provide search for similar words functionality. More...
 
interface com::sun::star::frame::XStorable
 to save the dictionary content to file More...
 

Additional Inherited Members

- Public Member Functions inherited from XDictionary
com::sun::star::linguistic2::DictionaryType getDictionaryType ()
 returns the type of the dictionary. More...
 
void setActive ([in] boolean bActivate)
 specifies whether the dictionary should be used or not . More...
 
boolean isActive ()
 
long getCount ()
 
com::sun::star::lang::Locale getLocale ()
 
void setLocale ([in] com::sun::star::lang::Locale aLocale)
 is used to set the language of the dictionary. More...
 
com::sun::star::linguistic2::XDictionaryEntry getEntry ([in] string aWord)
 searches for an entry that matches the given word. More...
 
boolean addEntry ([in] com::sun::star::linguistic2::XDictionaryEntry xDicEntry)
 is used to add an entry to the dictionary. More...
 
boolean add ([in] string aWord, [in] boolean bIsNegative, [in] string aRplcText)
 is used to make an entry in the dictionary. More...
 
boolean remove ([in] string aWord)
 removes an entry from the dictionary. More...
 
boolean isFull ()
 
sequence< com::sun::star::linguistic2::XDictionaryEntrygetEntries ()
 
void clear ()
 removes all entries from the dictionary. More...
 
boolean addDictionaryEventListener ([in] com::sun::star::linguistic2::XDictionaryEventListener xListener)
 adds an entry to the list of dictionary event listeners. More...
 
boolean removeDictionaryEventListener ([in] com::sun::star::linguistic2::XDictionaryEventListener xListener)
 removes an entry from the list of dictionary event listeners. More...
 
- Public Member Functions inherited from XNamed
string getName ()
 
void setName ([in] string aName)
 sets the programmatic name of the object. More...
 
- 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 XSearchableDictionary
sequence< com::sun::star::linguistic2::XDictionaryEntrysearchSimilarEntries ([in] string aWord)
 search for similar entries in the dictionary. More...
 
- Protected Member Functions inherited from XStorable
boolean hasLocation ()
 The object may know the location because it was loaded from there, or because it is stored there. More...
 
string getLocation ()
 After XStorable::storeAsURL() it returns the URL the object was stored to. More...
 
boolean isReadonly ()
 It is not possible to call XStorable::store() successfully when the data store is read-only. More...
 
void store () raises ( com::sun::star::io::IOException )
 stores the data to the URL from which it was loaded. More...
 
void storeAsURL ([in] string sURL, [in] sequence< com::sun::star::beans::PropertyValue > lArguments) raises ( com::sun::star::io::IOException )
 stores the object's persistent data to a URL and makes this URL the new location of the object. More...
 
void storeToURL ([in] string sURL, [in] sequence< com::sun::star::beans::PropertyValue > lArguments) raises ( com::sun::star::io::IOException )
 stores the object's persistent data to a URL and continues to be a representation of the old URL. More...
 

Detailed Description

represents a dictionary used for spell checking and hyphenation.

See also
com::sun::star::linguistic2::DictionaryList
com::sun::star::linguistic2::XSearchableDictionaryList
Since
OOo 3.0.1

Exported Interfaces

to save the dictionary content to file

storeAsURL and storeToURL are empty implementations since the dictionaries are expected to be found in specific locations

to access the dictionary functionality.

provide search for similar words functionality.


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