diff options
| author | Thomas Lange <tl@openoffice.org> | 2000-12-04 13:15:31 +0000 |
|---|---|---|
| committer | Thomas Lange <tl@openoffice.org> | 2000-12-04 13:15:31 +0000 |
| commit | 7b508ab7fe63028a908e58c3124c5deaac9916d4 (patch) | |
| tree | fd5931e4a047e5abd3e97f2bcf6eaab2c72f8ba8 /offapi | |
| parent | 8045eea737946bdc91621f41ca16093431f6ac80 (diff) | |
API documentation added
Diffstat (limited to 'offapi')
34 files changed, 1459 insertions, 421 deletions
diff --git a/offapi/com/sun/star/linguistic2/DictionaryEvent.idl b/offapi/com/sun/star/linguistic2/DictionaryEvent.idl index 41747397cd21..a9384fbf3ab4 100644 --- a/offapi/com/sun/star/linguistic2/DictionaryEvent.idl +++ b/offapi/com/sun/star/linguistic2/DictionaryEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DictionaryEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,25 +75,36 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** This structure represents a dictionary event. +/** represents a dictionary event. - @see XDictionaryEventListener - @see EventObject + <P>This type of event is used by a dictionary to inform + it's listeners about changes in it's properties or it's entry list. + It consists of an event type and may supply an affected + dictionary entry.</P> + + @see com::sun::star::linguistic2::XDictionary + @see com::sun::star::linguistic2::XDictionaryEventListener + @see com::sun::star::lang::EventObject */ struct DictionaryEvent : com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - /** The type of event. + /** is the type of event. + + <p>This must be the value of a single flag. No combinations are + allowed.</p> - @see DicEventFlags + @see com::sun::star::linguistic2::DictionaryEventFlags */ short nEvent; //------------------------------------------------------------------------- - /** Corresponding DictionaryEntry. Must be set if an entry was - added or deleted, otherwise it will be empty. + /** is the affected dictionary entry (if any). + + <p>It must be set if an entry was + added or deleted, otherwise it should be empty.</p> - @see XDictionaryEntry + @see com::sun::star::linguistic2::XDictionaryEntry */ com::sun::star::linguistic2::XDictionaryEntry xDictionaryEntry; diff --git a/offapi/com/sun/star/linguistic2/DictionaryEventFlags.idl b/offapi/com/sun/star/linguistic2/DictionaryEventFlags.idl index 156e2f51ffdc..b402c21e26f2 100644 --- a/offapi/com/sun/star/linguistic2/DictionaryEventFlags.idl +++ b/offapi/com/sun/star/linguistic2/DictionaryEventFlags.idl @@ -2,9 +2,9 @@ * * $RCSfile: DictionaryEventFlags.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,46 +67,47 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** These constants represents the possible dictionary events. - Events can be combined with logical or. +/** flags used for the event type in dictionary events. - @see XDictionaryEventListener - @see DictionaryEvent + <P>These flags represent the types of event that a dictionary + may broadcast.</P> + + @see com::sun::star::linguistic2::DictionaryEvent */ constants DictionaryEventFlags { //------------------------------------------------------------------------- - /** At least one entry has been added. + /** indicates that at least one entry has been added. */ const short ADD_ENTRY = 1; //------------------------------------------------------------------------- - /** At least one entry has been deleted. + /** indicates that at least one entry has been deleted. */ const short DEL_ENTRY = 2; //------------------------------------------------------------------------- - /** The name has changed. + /** the dictionaries name has changed. */ const short CHG_NAME = 4; //------------------------------------------------------------------------- - /** The language has changed. + /** the dictionaries language has changed. */ const short CHG_LANGUAGE = 8; //------------------------------------------------------------------------- - /** All entries have been removed. + /** all entries have been removed. */ const short ENTRIES_CLEARED = 16; //------------------------------------------------------------------------- - /** Dictionary was activated. + /** used when the dictionary was activated. */ const short ACTIVATE_DIC = 32; //------------------------------------------------------------------------- - /** Dictionary was deactivated. + /** used when the dictionary was deactivated. */ const short DEACTIVATE_DIC = 64; diff --git a/offapi/com/sun/star/linguistic2/DictionaryList.idl b/offapi/com/sun/star/linguistic2/DictionaryList.idl new file mode 100644 index 000000000000..123c0fa68219 --- /dev/null +++ b/offapi/com/sun/star/linguistic2/DictionaryList.idl @@ -0,0 +1,98 @@ +/************************************************************************* + * + * $RCSfile: DictionaryList.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tl $ $Date: 2000-12-04 14:12:24 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems iNc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_linguistic2_DictionaryList_idl__ +#define __com_sun_star_linguistic2_DictionaryList_idl__ + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif +#ifndef __com_sun_star_lang_XServiceInfo_idl__ +#include <com/sun/star/lang/XServiceInfo.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module linguistic2 { + +interface XSearchableDictionaryList; + +//============================================================================= +/** is the list of personal dictionaries. + + <P>The active dictionaries of this list will be used for + spellchecking and hyphenation.</P> + + @see com::sun::star::linguistic2::XDictionary + @see com::sun::star::linguistic2::XDictionaryList; + @see com::sun::star::linguistic2::XSearchableDictionaryList; +*/ +service DictionaryList +{ + interface com::sun::star::linguistic2::XSearchableDictionaryList; + interface com::sun::star::lang::XComponent; + interface com::sun::star::lang::XServiceInfo; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/linguistic2/DictionaryListEvent.idl b/offapi/com/sun/star/linguistic2/DictionaryListEvent.idl index 0edae8c0a127..5747174de09a 100644 --- a/offapi/com/sun/star/linguistic2/DictionaryListEvent.idl +++ b/offapi/com/sun/star/linguistic2/DictionaryListEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DictionaryListEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,32 +75,47 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** This structure represents a dictionary-list event. +/** structure representing a dictionary-list event. - @see XDictionaryListEventListener - @see EventObject + <P>This structure is used by the dictionary-list to inform + it's listeners about certain events. + Since the dictionary-list + is able to collect several single events before broadcasting + an to it's listeners the interger argument may be a + combination of several event types. + If more specific information about the events is requested by a + listener a sequence of all dictionary-list events since the + last broadcasting will be supplied. Otherwise that list will + be empty.</P> + + @see com::sun::star::linguistic2::XDictionaryList + @see com::sun::star::linguistic2::XDictionaryListEventListener + @see com::sun::star::lang::EventObject */ struct DictionaryListEvent : com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - /** The type of the occured Events. + /** the combined type of the accumulated events. - <P>It can be the combination of multiple + <p>The value can be the combination of multiple <type scope="com::sun::star::linguistic2">DictionaryListEventFlags</type> - by building the logical OR of them.</P> + by applying the logical OR to them.</p> - @see DictionaryListEventFlags - @see XDictionaryList + @see com::sun::star::linguistic2::DictionaryListEventFlags */ short nCondensedEvent; //------------------------------------------------------------------------- - /** A list of events. - ** It may be empty if all <type>XDictionaryListEventListener</type> - ** are satisfied with the the condensed representation of the above - ** member. + /** list of accumulated dictionary events. + + <p>It will be empty if all + <type scope="com::sun::star::linguistic2::"> + XDictionaryListEventListener</type> + are satisfied with the the condensed representation of the + <member scope="com::sun::star::linguistic2"> + DictionaryListEvent::nCondensedEvent</member>.</p> - @see XDictionaryList + @see com::sun::star::linguistic2::DictionaryEvent */ sequence< com::sun::star::linguistic2::DictionaryEvent > aDictionaryEvents; diff --git a/offapi/com/sun/star/linguistic2/DictionaryListEventFlags.idl b/offapi/com/sun/star/linguistic2/DictionaryListEventFlags.idl index f9ff0af8a9e3..3b8e6936ac6c 100644 --- a/offapi/com/sun/star/linguistic2/DictionaryListEventFlags.idl +++ b/offapi/com/sun/star/linguistic2/DictionaryListEventFlags.idl @@ -2,9 +2,9 @@ * * $RCSfile: DictionaryListEventFlags.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,61 +67,64 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** These constants represents the possible dictionary-list events. - Events can be combined with logical or. +/** constants representing a single dictionary-list event. - @see XDictionaryListEventListener - @see DictionaryListEvent + <P>These flags define the possible types for a + dictionary-list event.</P> + + @see com::sun::star::linguistic2::DictionaryListEvent + @see com::sun::star::linguistic2::XDictionaryListEventListener + @see com::sun::star::linguistic2::XDictionaryList */ constants DictionaryListEventFlags { //------------------------------------------------------------------------- /** A positive entry was added to a dictionary from the - ** dictionary list. + dictionary list. */ const short ADD_POS_ENTRY = 1; //------------------------------------------------------------------------- /** A positive entry was deleted from a dictionary of the - ** dictionary list or an active dictionary with positive entries - ** was cleared. + dictionary list or a dictionary with positive entries + was cleared. */ const short DEL_POS_ENTRY = 2; //------------------------------------------------------------------------- /** A negative entry was added to a dictionary from the - ** dictionary list. + dictionary list. */ const short ADD_NEG_ENTRY = 4; //------------------------------------------------------------------------- /** A negative entry was deleted from a dictionary of the - ** dictionary list or an active dictionary with negative entries - ** was cleared. + dictionary list or a dictionary with negative entries + was cleared. */ const short DEL_NEG_ENTRY = 8; //------------------------------------------------------------------------- /** A dictionary with positive entries was activated or - ** an active dictionary with positive entries has changed its language. + has changed its language. */ const short ACTIVATE_POS_DIC = 16; //------------------------------------------------------------------------- /** A dictionary with positive entries was deactivated or - ** an active dictionary with positive entries has changed its language. + has changed its language. */ const short DEACTIVATE_POS_DIC = 32; //------------------------------------------------------------------------- /** A dictionary with negative entries was activated or - ** an active dictionary with negative entries has changed its language. + has changed its language. */ const short ACTIVATE_NEG_DIC = 64; //------------------------------------------------------------------------- /** A dictionary with negative entries was deactivated or - ** an active dictionary with negative entries has changed its language. + has changed its language. */ const short DEACTIVATE_NEG_DIC = 128; }; diff --git a/offapi/com/sun/star/linguistic2/DictionaryType.idl b/offapi/com/sun/star/linguistic2/DictionaryType.idl index b6a1db38058d..79f4dacecb5d 100644 --- a/offapi/com/sun/star/linguistic2/DictionaryType.idl +++ b/offapi/com/sun/star/linguistic2/DictionaryType.idl @@ -2,9 +2,9 @@ * * $RCSfile: DictionaryType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,25 +67,29 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** Enum describing the type of a personal dictionary. +/** describes the type of a personal dictionary. - @see XDictionary + <P>This type defines the type of a dictionary. + It may be positive or negative. A positive dictionary may hold + only positive entries and a negative one only negative entries.</P> + + @see com::sun::star::linguistic2::XDictionary + @see com::sun::star::linguistic2::XDictionaryEntry */ enum DictionaryType { //------------------------------------------------------------------------- - /** all words in the dictionary are positive. + /** all entries in the dictionary are positive. */ POSITIVE, //------------------------------------------------------------------------- - /** all words in the dictionary are negative. + /** all entries in the dictionary are negative. */ NEGATIVE, //------------------------------------------------------------------------- - /** This type is not yet supported! - + /** @deprecated */ MIXED diff --git a/offapi/com/sun/star/linguistic2/Hyphenator.idl b/offapi/com/sun/star/linguistic2/Hyphenator.idl new file mode 100644 index 000000000000..f1d587aa1d4f --- /dev/null +++ b/offapi/com/sun/star/linguistic2/Hyphenator.idl @@ -0,0 +1,101 @@ +/************************************************************************* + * + * $RCSfile: Hyphenator.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tl $ $Date: 2000-12-04 14:12:38 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems iNc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_linguistic2_Hyphenator_idl__ +#define __com_sun_star_linguistic2_Hyphenator_idl__ + +#ifndef __com_sun_star_lang_XInitialization_idl__ +#include <com/sun/star/lang/XInitialization.idl> +#endif +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif +#ifndef __com_sun_star_lang_XServiceInfo_idl__ +#include <com/sun/star/lang/XServiceInfo.idl> +#endif +#ifndef __com_sun_star_lang_XServiceDisplayName_idl__ +#include <com/sun/star/lang/XServiceDisplayName.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module linguistic2 { + +interface XHyphenator; +interface XLinguServiceEventBroadcaster; + +//============================================================================= +/** offers hyphenation functionality. +*/ +service Hyphenator +{ + interface com::sun::star::linguistic2::XHyphenator; + interface com::sun::star::linguistic2::XLinguServiceEventBroadcaster; + interface com::sun::star::lang::XInitialization; + interface com::sun::star::lang::XComponent; + interface com::sun::star::lang::XServiceInfo; + interface com::sun::star::lang::XServiceDisplayName; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/linguistic2/LinguProperties.idl b/offapi/com/sun/star/linguistic2/LinguProperties.idl new file mode 100644 index 000000000000..20412996e6c7 --- /dev/null +++ b/offapi/com/sun/star/linguistic2/LinguProperties.idl @@ -0,0 +1,210 @@ +/************************************************************************* + * + * $RCSfile: LinguProperties.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tl $ $Date: 2000-12-04 14:12:57 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems iNc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_linguistic2_LinguProperties_idl__ +#define __com_sun_star_linguistic2_LinguProperties_idl__ + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif +#ifndef __com_sun_star_beans_XFastPropertySet_idl__ +#include <com/sun/star/beans/XFastPropertySet.idl> +#endif +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif +#ifndef __com_sun_star_lang_XServiceInfo_idl__ +#include <com/sun/star/lang/XServiceInfo.idl> +#endif +#ifndef __com_sun_star_lang_Locale_idl__ +#include <com/sun/star/lang/Locale.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module linguistic2 { + +//============================================================================= +/** the set of linguistic relevant properties. +*/ +service LinguProperties +{ + interface com::sun::star::beans::XPropertySet; + interface com::sun::star::beans::XFastPropertySet; + interface com::sun::star::lang::XComponent; + interface com::sun::star::lang::XServiceInfo; + + //------------------------------------------------------------------------- + /** defines wether new German spelling rules should be used for German + text or not when doing spellchecking or hyphenation, or using the + thesaurus. + */ + [property] boolean IsGermanPreReform; + + //------------------------------------------------------------------------- + /** defines if the dictionary-list should be used for spellchecking + and hyphenation or not. + */ + [property] boolean IsUseDictionaryList; + + //------------------------------------------------------------------------- + /** defines if control characters should be ignored by the linguistic + (i.e. spellchecker, hyphenator and thesaurus) or not. + */ + [property] boolean IsIgnoreControlCharacters; + + //------------------------------------------------------------------------- + /** defines if words with uppercase letters only should be + subject for spellchecking or not. + */ + [property] boolean IsSpellUpperCase; + + //------------------------------------------------------------------------- + /** defines if words containing digits (or numbers) should be + subject for spellchecking or not. + */ + [property] boolean IsSpellWithDigits; + + //------------------------------------------------------------------------- + /** defines if the captitalization of words should be checked or not. + */ + [property] boolean IsSpellCapitalization; + + //------------------------------------------------------------------------- + /** the minimum number of characters of a word to remain before the + hyphen when doing hyphenation. + */ + [property] short HyphMinLeading; + + //------------------------------------------------------------------------- + /** the minimum number of characters of a word to remain after the + hyphen when doing hyphenation. + */ + [property] short HyphMinTrailing; + + //------------------------------------------------------------------------- + /** the minimum length of a word in order to be hyphenated. + */ + [property] short HyphMinWordLength; + + //------------------------------------------------------------------------- + /** the default language for new documents. + */ + [property] com::sun::star::lang::Locale DefaultLocale; + + //------------------------------------------------------------------------- + /** defines wether interactive hyphenation should be performed without + requiring the user to select every hyphenation position after he has + triggered the hyphenation. + */ + [property] boolean IsHyphAuto; + + //------------------------------------------------------------------------- + /** defines wether hyphenation should be done in special regions of + documents or not. + */ + [property] boolean IsHyphSpecial; + + //------------------------------------------------------------------------- + /** indicates wether spellchecking should be done automatically or not. + */ + [property] boolean IsSpellAuto; + + //------------------------------------------------------------------------- + /** indicates wether the markings for incorrect spelled text should be + hidden or not. + */ + [property] boolean IsSpellHide; + + //------------------------------------------------------------------------- + /** indicates if spellchecking should be performed in all available + languages. + */ + [property] boolean IsSpellInAllLanguages; + + //------------------------------------------------------------------------- + /** defines wether spellchecking should be done in special regions of + documents or not. + */ + [property] boolean IsSpellSpecial; + + //------------------------------------------------------------------------- + /** defines wether spellchecking should be done in reverse + direction or not. + */ + [property] boolean IsWrapReverse; + + //------------------------------------------------------------------------- + /** the default language for CJK languages. + */ + [property] com::sun::star::lang::Locale DefaultLocale_CJK; + + //------------------------------------------------------------------------- + /** the default language for CTL languages. + */ + [property] com::sun::star::lang::Locale DefaultLocale_CTL; + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/linguistic2/LinguServiceEvent.idl b/offapi/com/sun/star/linguistic2/LinguServiceEvent.idl index 3170f6dfad20..4e90b37150e1 100644 --- a/offapi/com/sun/star/linguistic2/LinguServiceEvent.idl +++ b/offapi/com/sun/star/linguistic2/LinguServiceEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: LinguServiceEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,17 +70,29 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** This structure represents a linguistic service event. +/** represents a linguistic service event. - @see XLinguServiceEventListener - @see EventObject + <P>This type of event may be broadcastet by a spellchecker or + hyphenator service implementation to inform it's listeners (clients) + that the results of previous function calls may be different now. + It is possible to suggest that hyphenation should be done again + and/or the spelling of previously incorrect or correct words + should be checked again.</P> + + @see com::sun::star::linguistic2::XLinguServiceEventBroadcaster + @see com::sun::star::linguistic2::XLinguServiceEventListener + @see com::sun::star::linguistic2::SpellChecker + @see com::sun::star::linguistic2::Hyphenator + @see com::sun::star::lang::EventObject */ struct LinguServiceEvent : com::sun::star::lang::EventObject { //------------------------------------------------------------------------- /** The type of event. - @see LinguServiceEventFlags + <p>The value may be combined via logical OR from those values + defined in <type scope="com::sun::star::linguistic2"> + LinguServiceEventFlags</type></p> */ short nEvent; diff --git a/offapi/com/sun/star/linguistic2/LinguServiceEventFlags.idl b/offapi/com/sun/star/linguistic2/LinguServiceEventFlags.idl index 93b429f54a2c..562b5f1b7c69 100644 --- a/offapi/com/sun/star/linguistic2/LinguServiceEventFlags.idl +++ b/offapi/com/sun/star/linguistic2/LinguServiceEventFlags.idl @@ -2,9 +2,9 @@ * * $RCSfile: LinguServiceEventFlags.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,17 +67,27 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** +/** to be used in lingu-service events. + + <P>These values define the flags which may be logically combined + to build the event type of a + <type scope="com::sun::star::linguistic2">LinguServiceEvent</type></P> */ constants LinguServiceEventFlags { //------------------------------------------------------------------------- + /** The spelling of previously correct words should be checked again. + */ const short SPELL_CORRECT_WORDS_AGAIN = 1; //------------------------------------------------------------------------- + /** The spelling of previously misspelled words should be checked again. + */ const short SPELL_WRONG_WORDS_AGAIN = 2; //------------------------------------------------------------------------- + /** The hyphenation of words may have changed. + */ const short HYPHENATE_AGAIN = 4; }; diff --git a/offapi/com/sun/star/linguistic2/LinguServiceManager.idl b/offapi/com/sun/star/linguistic2/LinguServiceManager.idl new file mode 100644 index 000000000000..43d433a1c8db --- /dev/null +++ b/offapi/com/sun/star/linguistic2/LinguServiceManager.idl @@ -0,0 +1,91 @@ +/************************************************************************* + * + * $RCSfile: LinguServiceManager.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tl $ $Date: 2000-12-04 14:13:14 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems iNc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_linguistic2_LinguServiceManager_idl__ +#define __com_sun_star_linguistic2_LinguServiceManager_idl__ + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif +#ifndef __com_sun_star_lang_XServiceInfo_idl__ +#include <com/sun/star/lang/XServiceInfo.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module linguistic2 { + +interface XLinguServiceManager; + +//============================================================================= +/** offers linguistic functionality. +*/ +service LinguServiceManager +{ + interface com::sun::star::linguistic2::XLinguServiceManager; + interface com::sun::star::lang::XComponent; + interface com::sun::star::lang::XServiceInfo; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/linguistic2/SpellChecker.idl b/offapi/com/sun/star/linguistic2/SpellChecker.idl new file mode 100644 index 000000000000..1f3d056ef056 --- /dev/null +++ b/offapi/com/sun/star/linguistic2/SpellChecker.idl @@ -0,0 +1,101 @@ +/************************************************************************* + * + * $RCSfile: SpellChecker.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tl $ $Date: 2000-12-04 14:13:43 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems iNc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_linguistic2_SpellChecker_idl__ +#define __com_sun_star_linguistic2_SpellChecker_idl__ + +#ifndef __com_sun_star_lang_XInitialization_idl__ +#include <com/sun/star/lang/XInitialization.idl> +#endif +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif +#ifndef __com_sun_star_lang_XServiceInfo_idl__ +#include <com/sun/star/lang/XServiceInfo.idl> +#endif +#ifndef __com_sun_star_lang_XServiceDisplayName_idl__ +#include <com/sun/star/lang/XServiceDisplayName.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module linguistic2 { + +interface XSpellChecker; +interface XLinguServiceEventBroadcaster; + +//============================================================================= +/** offers spellchecking functionality. +*/ +service SpellChecker +{ + interface com::sun::star::linguistic2::XSpellChecker; + interface com::sun::star::linguistic2::XLinguServiceEventBroadcaster; + interface com::sun::star::lang::XInitialization; + interface com::sun::star::lang::XComponent; + interface com::sun::star::lang::XServiceInfo; + interface com::sun::star::lang::XServiceDisplayName; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/linguistic2/SpellFailure.idl b/offapi/com/sun/star/linguistic2/SpellFailure.idl index a8327e6e8d8e..a73b2c4735ca 100644 --- a/offapi/com/sun/star/linguistic2/SpellFailure.idl +++ b/offapi/com/sun/star/linguistic2/SpellFailure.idl @@ -2,9 +2,9 @@ * * $RCSfile: SpellFailure.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,18 +67,19 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** These constants define the various types for spellchecking to - fail verification. +/** these define the various types for spellchecking to fail verification. - <P>New constants may be added in the future.</P> + <P>A value of this type may be obtained as part of the + <type scope="com::sun::star::linguistic2">XSpellAlternatives</type> + interface that is the return type for an unsuccessfull + spelling attempt.</P> - @see XSpellAlternatives - @see XSpellChecker + @see com::sun::star::linguistic2::XSpellChecker */ constants SpellFailure { //------------------------------------------------------------------------- - /** The word is a negativ one and should not be used. + /** The word is a negativ one, i.e. it should not be used. */ const short IS_NEGATIVE_WORD = 2; diff --git a/offapi/com/sun/star/linguistic2/Thesaurus.idl b/offapi/com/sun/star/linguistic2/Thesaurus.idl new file mode 100644 index 000000000000..50e319a91c4c --- /dev/null +++ b/offapi/com/sun/star/linguistic2/Thesaurus.idl @@ -0,0 +1,99 @@ +/************************************************************************* + * + * $RCSfile: Thesaurus.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: tl $ $Date: 2000-12-04 14:13:56 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems iNc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_linguistic2_Thesaurus_idl__ +#define __com_sun_star_linguistic2_Thesaurus_idl__ + +#ifndef __com_sun_star_lang_XInitialization_idl__ +#include <com/sun/star/lang/XInitialization.idl> +#endif +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif +#ifndef __com_sun_star_lang_XServiceInfo_idl__ +#include <com/sun/star/lang/XServiceInfo.idl> +#endif +#ifndef __com_sun_star_lang_XServiceDisplayName_idl__ +#include <com/sun/star/lang/XServiceDisplayName.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module linguistic2 { + +interface XThesaurus; + +//============================================================================= +/** offers thesaurus functionality. +*/ +service Thesaurus +{ + interface com::sun::star::linguistic2::XThesaurus; + interface com::sun::star::lang::XInitialization; + interface com::sun::star::lang::XComponent; + interface com::sun::star::lang::XServiceInfo; + interface com::sun::star::lang::XServiceDisplayName; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/linguistic2/XDictionary.idl b/offapi/com/sun/star/linguistic2/XDictionary.idl index 71103adb93e0..a705a6f33bbb 100644 --- a/offapi/com/sun/star/linguistic2/XDictionary.idl +++ b/offapi/com/sun/star/linguistic2/XDictionary.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDictionary.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,128 +88,140 @@ module com { module sun { module star { module linguistic2 { //============================================================================= /** This interfaces enables the object to access personal dictionaries. - @see XDictionaryEntry - @see XDictionaryEvent - @see XNamed + <P>Personal dictionaries are used to supply additional + information for spellchecking and hyphenation (see + <type scope="com::sun::star::linguistic2">XDictionaryEntry</type>). + Only active dictionaries with an appropriate language are used + for that purpose. + The entries of a active positive dictionary are words that are + required to be recognized as correct during the spellchecking + process. Additionally they will be used for hyphenation. + Entries of a negative dictionary are required to be recognized + as negative words (i.e. words that should not be used) during + spellcheck. An entry of a negative dictionary may supply a + proposal for a word to be used instead of used one.</P> + + @see com::sun::star::linguistic2::XDictionaryEvent + @see com::sun::star::container::XNamed */ [ uik(4BD5A950-5D68-11d4-9F090050-04D8BBC5), ident( "XDictionary", 1.0 ) ] interface XDictionary : com::sun::star::container::XNamed { //------------------------------------------------------------------------- - /** This method returns the type of the dictionary. + /** returns the type of the dictionary. @returns - the type of the dictionary. + the type of the dictionary. - @see DictionaryType + @see com::sun::star::linguistic2::DictionaryType */ com::sun::star::linguistic2::DictionaryType getDictionaryType(); //------------------------------------------------------------------------- - /** This method determines wether the dictionary should be - used or not. + /** specifies wether the dictionary should be used or not. @param bAvtivate - <TRUE/> if the dictionary should be used, <FALSE/> else. + <TRUE/> if the dictionary should be used, <FALSE/> else. */ void setActive( [in] boolean bActivate ); //------------------------------------------------------------------------- /** @returns - <TRUE/> if the dictionary is active, <FALSE/> otherwise. + <TRUE/> if the dictionary is active, <FALSE/> otherwise. */ boolean isActive(); //------------------------------------------------------------------------- /** @returns - the number of entries in the dictionary. + the number of entries in the dictionary. */ short getCount(); //------------------------------------------------------------------------- - /** @returns - the language of the dictionary. + /** + @returns + the language of the dictionary. - @see Locale + @see com::sun::star::lang::Locale */ com::sun::star::lang::Locale getLocale(); //------------------------------------------------------------------------- - /** This method sets the language of the dictionary. + /** is used to set the language of the dictionary. @param aLocale - the language of the dictionary. + the (new) language of the dictionary. - @see Locale + @see com::sun::star::lang::Locale */ void setLocale( [in] com::sun::star::lang::Locale aLocale ); //------------------------------------------------------------------------- - /** This method returns the reference to the dictionary entry that - matches the given word. + /** searches for an entry that matches the given word. @returns - the reference to the entry found. If no entry was found - it is NULL. + the reference to the entry found. If no entry was found + it is NULL. @param aWord - the word to be looked for. + the word to be looked for. - @see XDictionaryEntry + @see com::sun::star::linguistic2::XDictionaryEntry */ com::sun::star::linguistic2::XDictionaryEntry getEntry( [in] string aWord ); //------------------------------------------------------------------------- - /** This method adds an entry to the dictionary. + /** is used to add an entry to the dictionary. <P>If an entry already exists the dictionary remains unchanged and <FALSE/> will be returned.</P> - <P>Of course in positive dictionaries only postiv entries + <P>In positive dictionaries only postiv entries can be made, and in negativ ones only negativ entries.</P> @param xDicEntry - the entry to be added. + the entry to be added. @returns - <TRUE/> if the entry was successfully added <FALSE/> else. + <TRUE/> if the entry was successfully added <FALSE/> else. @see add @see remove @see isFull - @see XDictionaryEntry - @see DictionaryType + @see com::sun::star::linguistic2::XDictionaryEntry + @see com::sun::star::linguistic2::DictionaryType */ - boolean addEntry( [in] com::sun::star::linguistic2::XDictionaryEntry xDicEntry ); + boolean addEntry( + [in] com::sun::star::linguistic2::XDictionaryEntry xDicEntry ); //------------------------------------------------------------------------- - /** This method adds an entry to the dictionary. + /** is used to make an entry in the dictionary. <P>If an entry already exists the dictionary remains unchanged and <FALSE/> will be returned.</P> - <P>Of course in positive dictionaries only postiv entries + <P>In positive dictionaries only postiv entries can be made, and in negativ ones only negativ entries.</P> @param aWord - the word to be added. + the word to be added. @param bIsNegative - specifies wether the entry will be a negative one or not. + specifies wether the entry will be a negative one or not. @param aRplcText - in case of a negative entry this is the replacement text to - be used when replacing aWord. Otherwise it is undefined. + in 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/> else. + <TRUE/> if the entry was successfully added <FALSE/> else. @see addEntry @see remove @see isFull - @see DictionaryType + @see com::sun::star::linguistic2::DictionaryType */ boolean add( [in] string aWord, @@ -217,14 +229,14 @@ interface XDictionary : com::sun::star::container::XNamed [in] string aRplcText ); //------------------------------------------------------------------------- - /** This method removes an entry from the dictionary. + /** removes an entry from the dictionary. @param aWord - the word corresponding to the entry to be removed. + 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). + <TRUE/> if the entry was successfully removed, <FALSE/> + otherwise (especially if the entry was not found). @see addEntry @see add @@ -233,8 +245,9 @@ interface XDictionary : com::sun::star::container::XNamed //------------------------------------------------------------------------- /** - @returns <TRUE/> if the dictionary is full and no further - item can be added, <FALSE/> else. + @returns + <TRUE/> if the dictionary is full and no further + entry can be made, <FALSE/> else. @see addEntry @see add @@ -244,50 +257,51 @@ interface XDictionary : com::sun::star::container::XNamed //------------------------------------------------------------------------- /** @returns - a sequence with all the entries of the dictionary. + a sequence with all the entries of the dictionary. - @see XDictionaryEntry + @see com::sun::star::linguistic2::XDictionaryEntry */ sequence<com::sun::star::linguistic2::XDictionaryEntry> getEntries(); //------------------------------------------------------------------------- - /** This method removes all entries from the dictionary. + /** removes all entries from the dictionary. */ void clear(); //------------------------------------------------------------------------- /** add an entry to the list of dictionary event listeners. - <P>On events each entry in the list is getting a notification.</P> + <P>On dictionary events each entry in the listener list will + be notified via a call to + <member scope="com::sun::star::linguistic2"> + XDictionaryEventListener::processDictionaryEvent</member>.</P> @param xListener - the entry to be made (i.e. the object that wants get notifications). + the entry to be made (i.e. the object that wants get notifications). @returns - <TRUE/> if the entry was successfully made, <FALSE/> else. - If the object disposes it will always fail. + <TRUE/> if the entry was successfully made, <FALSE/> else. + If the object disposes it will always fail. - @see DictionaryEvent @see removeDictionaryEventListener - @see dispose + @see com::sun::star::linguistic2::XDictionaryEventListener */ boolean addDictionaryEventListener( [in] com::sun::star::linguistic2::XDictionaryEventListener xListener ); //------------------------------------------------------------------------- - /** remove an entry from he list of dictionary event listeners. + /** remove an entry from the list of dictionary event listeners. @param xListener - the reference to the listening object. + 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. + <TRUE/> if the object to be removed was found (and removed), + <FALSE/> if the object was not found in the list. - @see DictionaryEvent @see addDictionaryEventListener - @see dispose + @see com::sun::star::linguistic2::XDictionaryEventListener */ boolean removeDictionaryEventListener( [in] com::sun::star::linguistic2::XDictionaryEventListener xListener ); diff --git a/offapi/com/sun/star/linguistic2/XDictionary1.idl b/offapi/com/sun/star/linguistic2/XDictionary1.idl index fb510493dd8b..63b5a0a8b37d 100644 --- a/offapi/com/sun/star/linguistic2/XDictionary1.idl +++ b/offapi/com/sun/star/linguistic2/XDictionary1.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDictionary1.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,6 +83,7 @@ module com { module sun { module star { module linguistic2 { //============================================================================= /** + @depricated */ [ uik(4BD5A951-5D68-11d4-9F090050-04D8BBC5), ident( "XDictionary1", 1.0 ) ] interface XDictionary1 : com::sun::star::container::XNamed diff --git a/offapi/com/sun/star/linguistic2/XDictionaryEntry.idl b/offapi/com/sun/star/linguistic2/XDictionaryEntry.idl index 8cfae3460bd0..e2c2d4040fc0 100644 --- a/offapi/com/sun/star/linguistic2/XDictionaryEntry.idl +++ b/offapi/com/sun/star/linguistic2/XDictionaryEntry.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDictionaryEntry.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,19 +74,25 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** This interfaces gives access to a single dictionary entry. +/** This interfaces gives access to a dictionary entry. <P>A dictionary entry can supply a word and it's hyhenation - and indicate if it is a neagtiv word. If the entry is a - negativ one a replacement text/language may have been supplied.</P> + and indicate if it is a negative word. + If it is a negative entry it may supply a replacement text to + ne used instead of the entries word.</P> <P>Hyphenation positions are represented by a '=' in the word. If the '=' is the last character of the word this means it should not - be hyphenated. If there is no '=' charcter in the word hyphenation - positions will be determined automatically.</P> + be hyphenated. If there is no '=' charcter in the word, hyphenation + positions will be determined automatically (i.e. from the hyphenator + service alone).</P> - @see XDictionary - @see XInterface + <P>Entries whose words only differ in hyphenation are considered + to be equal. Also a '.' at the end of the word will make no + difference.</P> + + @see com::sun::star::linguistic2::XDictionary + @see com::sun::star::uno::XInterface */ [ uik(4BD5A952-5D68-11d4-9F090050-04D8BBC5), ident( "XDictionaryEntry", 1.0 ) ] interface XDictionaryEntry : com::sun::star::uno::XInterface @@ -94,29 +100,30 @@ interface XDictionaryEntry : com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** @returns - the word defining this entry. + the word defining this entry. */ string getDictionaryWord(); //------------------------------------------------------------------------- /** @returns - <TRUE/> if the word is a negativ one, <FALSE/> else. + <TRUE/> if the word (entry) is a negativ one and should not be + used, <FALSE/> else. @see getReplacementText - @see getReplacementLocale */ boolean isNegative(); //------------------------------------------------------------------------- - /** + /** is the suggested replacement text for negativ words. + + <p>It is undefined if the entry is not negativ.</p> + @returns - the replacement text for a negativ entry. - An empty string indicates that no replacement text is provided. - It is undefined if the entry is not negativ. + the replacement text for a negativ entry. + An empty string indicates that no replacement text is provided. @see isNegative - @see getReplacementLocale */ string getReplacementText(); diff --git a/offapi/com/sun/star/linguistic2/XDictionaryEventListener.idl b/offapi/com/sun/star/linguistic2/XDictionaryEventListener.idl index 342f5b2262a6..d573ab5085aa 100644 --- a/offapi/com/sun/star/linguistic2/XDictionaryEventListener.idl +++ b/offapi/com/sun/star/linguistic2/XDictionaryEventListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDictionaryEventListener.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,24 +75,28 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** This interfaces allows the object to act according to dictionary - events. +/** This interfaces allows the object to act according to dictionary events. - @see XDictionary - @see XEventListener + <P>The single method is used by a dictionary to notify it's + listeners about + <type scope="com::sun::star::linguistic2">DictionaryEvent</type>s.</P> + + @see com::sun::star::linguistic2::XDictionary + @see com::sun::star::lang::XEventListener */ [ uik(4BD5A953-5D68-11d4-9F090050-04D8BBC5), ident( "XDictionaryEventListener", 1.0 ) ] interface XDictionaryEventListener : com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - /** By this method the object is notifed about dictionary events. + /** is used to get notified about dictionary events. @param aDicEvent - the event to be notified of. + the event to be notified of. - @see DictionaryEvent + @see com::sun::star::linguistic2::DictionaryEvent */ - void processDictionaryEvent( [in] com::sun::star::linguistic2::DictionaryEvent aDicEvent ); + void processDictionaryEvent( + [in] com::sun::star::linguistic2::DictionaryEvent aDicEvent ); }; diff --git a/offapi/com/sun/star/linguistic2/XDictionaryList.idl b/offapi/com/sun/star/linguistic2/XDictionaryList.idl index fcf40b444daa..903e4ee7aefb 100644 --- a/offapi/com/sun/star/linguistic2/XDictionaryList.idl +++ b/offapi/com/sun/star/linguistic2/XDictionaryList.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDictionaryList.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,140 +78,153 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** This interface allows to maintain a list of dictionaries. +/** is used to manage and maintain a list of dictionaries. - @see XDictionary - @see XInterface + <P>A dictionary-list may be given to a spellchecker or hyphenator + service implementation on their creation in order to supply a set + of dictionaries and thus additional information to be used for + those purposes.</P> + + @see com::sun::star::linguistic2::XDictionary + @see com::sun::star::uno::XInterface */ [ uik(4BD5A954-5D68-11d4-9F090050-04D8BBC5), ident( "XDictionaryList", 1.0 ) ] interface XDictionaryList : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** This method returns the number of available dictionaries in - the list. - + /** @returns - the number of dictionaries. + the number of dictionaries in the list. */ short getCount(); //------------------------------------------------------------------------- /** - @returns - a sequence with an entry for every dictionary in the list. + @returns + a sequence with an entry for every dictionary + in the list. - @see XDictionary + @see com::sun::star::linguistic2::XDictionary */ sequence<com::sun::star::linguistic2::XDictionary> getDictionaries(); //------------------------------------------------------------------------- - /** @returns - the XDictionary with the specified name. If no such - dictionary exists <NULL/> will be returned. + /** 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. @param aDictionaryName - specify the name of the dictionary to look for. + specifies the name of the dictionary to look for. - @see XDictionary + @see com::sun::star::linguistic2::XDictionary */ com::sun::star::linguistic2::XDictionary getDictionaryByName( [in] string aDictionaryName ); //------------------------------------------------------------------------- - /** This method adds a dictionary to the list. + /** adds a dictionary to the list. + + <P>Additionally the dictionary-list will add itself to the list of dictionary + event listeners of that dictionary.</P> @returns - <TRUE/> if the dictionary was added successfully, <FALSE/> - otherwise. + <TRUE/> if the dictionary was added successfully, + <FALSE/> otherwise. @param xDictionary - the dictionary to be added. + the dictionary to be added. @see removeDictionary - @see XDictionary + @see com::sun::star::linguistic2::XDictionary */ boolean addDictionary( [in] com::sun::star::linguistic2::XDictionary xDictionary ); //------------------------------------------------------------------------- - /** This method removes a single dictionary from the list of - available ones. + /** removes a single dictionary from the list. - <P>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.</P> + <P>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.</P> @returns - <TRUE/> if the dictionary was removed successfully, <FALSE/> - otherwise. + <TRUE/> if the dictionary was removed successfully, <FALSE/> + otherwise. @param xDictionary - dictionary to be removed from the list of available dictionaries. + dictionary to be removed from the list of dictionaries. @see addDictionary - @see XDictionary + @see com::sun::star::linguistic2::XDictionary */ boolean removeDictionary( [in] com::sun::star::linguistic2::XDictionary xDictionary ); //------------------------------------------------------------------------- - /** This method adds an entry to the list of dictionary-list event - listeners. + /** adds an entry to the list of dictionary-list event listeners. - <P>On events each entry in the listener list will be notified.</P> + <P>On dictionary-list events each entry in the listener list will + be notified via a call to + <member scope="com::sun::star::linguistic2"> + XDictionaryListEventListener::processDictionaryListEvent</member>.</P> @returns - <TRUE/> if the entry was made, <FALSE/> else. - If the object disposes it will always fail. + <TRUE/> if the entry was made, <FALSE/> else. + If the object disposes it will always fail. @param xListener - the object to be notified of dictionary list events. + the object to be notified of dictionary-list events. + + @param bReceiveVerbose + </TRUE> if the listener requires are more detailed event + notification as usual. @see removeDictionaryListEventListener - @see XDictionaryListEventListener + @see com::sun::star::linguistic2::XDictionaryListEventListener + @see com::sun::star::linguistic2::XDictionaryListEvent */ boolean addDictionaryListEventListener( [in] com::sun::star::linguistic2::XDictionaryListEventListener xListener, [in] boolean bReceiveVerbose ); //------------------------------------------------------------------------- - /** This method removes an entry from the list of dictionary-list - event listeners. + /** removes an entry from the list of dictionary-list event listeners. @returns - <TRUE/> if the object to be removed was found (and removed), - <FALSE/> if the object was not found in the list. + <TRUE/> if the object to be removed was found and removed, + <FALSE/> otherwise. @param xListener - the object to be removed from the listener-list. + the object to be removed from the listener list. @see addDictionaryListEventListener - @see XDictionaryListEventListener + @see com::sun::star::linguistic2::XDictionaryListEventListener */ boolean removeDictionaryListEventListener( [in] com::sun::star::linguistic2::XDictionaryListEventListener xListener ); //------------------------------------------------------------------------- - /** increase calling level for beginCollectEvents by one. - - <P>The calling level for beginCollectEvents is just an integer - counter that is initially set to 0.</P> + /** increase request level for event buffering by one. - <P>As long as the calling level for beginCollectEvents is not 0 - events will be buffered untill the next call to flushEvents.</P> + <P>The request level for event buffering is just 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.</P> @returns - the current number of calling levels for beginCollectEvents. + the current request level for event buffering. - @see XDictionaryListEvent - @see XDictionaryListEventListener + @see com::sun::star::linguistic2::XDictionaryListEvent + @see com::sun::star::linguistic2::XDictionaryListEventListener @see flushEvents */ short beginCollectEvents(); //------------------------------------------------------------------------- - /** flush the buffered events and decrease calling level for - beginCollectEvents by one. + /** flushes the event buffer and decreases the request level for + event buffering by one. <P>There should be one matching endCollectEvents call for every beginCollectEvents call. Usually you will group these around @@ -219,10 +232,10 @@ interface XDictionaryList : com::sun::star::uno::XInterface event.</P> @returns - the current number of calling levels for beginCollectEvents. + the current request level for event buffering. - @see XDictionaryListEvent - @see XDictionaryListEventListener + @see com::sun::star::linguistic2::XDictionaryListEvent + @see com::sun::star::linguistic2::XDictionaryListEventListener @see flushEvents */ short endCollectEvents(); @@ -232,39 +245,39 @@ interface XDictionaryList : com::sun::star::uno::XInterface that buffer. @returns - the current number of calling levels for beginCollectEvents. + the current request level for event buffering. - @see XDictionaryListEvent - @see XDictionaryListEventListener + @see com::sun::star::linguistic2::XDictionaryListEvent + @see com::sun::star::linguistic2::XDictionaryListEventListener */ short flushEvents(); //------------------------------------------------------------------------- - /** creates a new personal dictionary. + /** creates a new dictionary. @returns - an empty dictionary with the given name, language and type. - <NULL/> on failure. + an empty dictionary with the given name, language and type. + <NULL/> on failure. @param aName - is the name of the dictionary (should be unique). + is the name of the dictionary (should be unique). @param aLocale - defines the language of the dictionary. - Use an empty Locale - for dictionaries which may contain entries of all languages. + defines the language of the dictionary. + Use an empty Locale + for dictionaries which may contain entries of all languages. @param eDicType - specifies the type of the dictionary. + specifies the type of the dictionary. @param 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. + 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 XDictionary - @see Locale - @see DictionaryType + @see com::sun::star::linguistic2::XDictionary + @see com::sun::star::lang::Locale + @see com::sun::star::linguistic2::DictionaryType */ com::sun::star::linguistic2::XDictionary createDictionary( [in] string aName, diff --git a/offapi/com/sun/star/linguistic2/XDictionaryListEventListener.idl b/offapi/com/sun/star/linguistic2/XDictionaryListEventListener.idl index f38cf7f8e727..2495753b5a9b 100644 --- a/offapi/com/sun/star/linguistic2/XDictionaryListEventListener.idl +++ b/offapi/com/sun/star/linguistic2/XDictionaryListEventListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDictionaryListEventListener.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,19 +78,23 @@ module com { module sun { module star { module linguistic2 { /** This interfaces allows the object to act according to dictionary-list events. - @see XDictionaryList + <P>This interface is the base class for all dictionary-list event + listeners. It's single function will be called by the broadcasting + dictionary-list in order to notify it's registered listeners.</P> + + @see com::sun::star::linguistic2::DictionaryListEvent + @see com::sun::star::linguistic2::XDictionaryList */ [ uik(4BD5A955-5D68-11d4-9F090050-04D8BBC5), ident( "XDictionaryListEventListener", 1.0 ) ] interface XDictionaryListEventListener : com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - /** By this method the object is notifed about dictionary-list - events. + /** is used to notify the object about dictionary-list events. @param aDicListEvent - the event to be notified of. + the event to be notified of. - @see DictionaryListEvent + @see com::sun::star::linguistic2::DictionaryListEvent */ void processDictionaryListEvent( [in] com::sun::star::linguistic2::DictionaryListEvent aDicListEvent ); diff --git a/offapi/com/sun/star/linguistic2/XHyphenatedWord.idl b/offapi/com/sun/star/linguistic2/XHyphenatedWord.idl index d3104e32f980..a618ad024ffa 100644 --- a/offapi/com/sun/star/linguistic2/XHyphenatedWord.idl +++ b/offapi/com/sun/star/linguistic2/XHyphenatedWord.idl @@ -2,9 +2,9 @@ * * $RCSfile: XHyphenatedWord.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,9 +75,12 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** Specifies the information obtained by a successful hyphenation attempt. +/** gives information obtained by a successfull hyphenation attempt. - @see XHyphenator + <P>This interface is used as a return value for some of the hyphenators + functions.</P> + + @see com::sun::star::linguistic2::XHyphenator */ [ uik(4BD5A957-5D68-11d4-9F090050-04D8BBC5), ident( "XHyphenatedWord", 1.0 ) ] interface XHyphenatedWord : com::sun::star::uno::XInterface @@ -85,54 +88,57 @@ interface XHyphenatedWord : com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** @returns - the word that was hyphenated. + the word that was hyphenated. */ string getWord(); //------------------------------------------------------------------------- - /** @returns - the language of the hyphenated word. + /** + @returns + the language of the hyphenated word. - @see Locale + @see com::sun::star::lang::Locale */ com::sun::star::lang::Locale getLocale(); //------------------------------------------------------------------------- - /** @returns - the position where hyphenation was applied in the word. + /** + @returns + the position where hyphenation was applied in the word. <P>The value has to be in the range from 0 (after the first character) to n-2 (before the last character) where n is the length of the word.</P> - - @see getWord - @see getHyphenPos */ short getHyphenationPos(); //------------------------------------------------------------------------- /** @returns - the hyphenated word as it should be written (without the hyphen - character though). + the hyphenated word as it should be written (without the hyphen + character though). */ string getHyphenatedWord(); //------------------------------------------------------------------------- /** @returns - the position of the hyphen in the hyphenated word. + the position of the hyphen in the hyphenated word. <P>The value has to be in the range from 0 (after the first character) to m-2 (before the last character) where m is the length of the hyphenated word.</P> - - @see getHyphenatedWord */ short getHyphenPos(); //------------------------------------------------------------------------- - /** + /** is used to query if the hyphenation result is an alternative spelling. + + <p>A hyphenation result is an alternative spelling if the hyphenated + word is different from the word that was hyphenated.</p> + + @returns + <TRUE/> if it is an alternative spelling, <FALSE/> otherwise. */ boolean isAlternativeSpelling(); diff --git a/offapi/com/sun/star/linguistic2/XHyphenator.idl b/offapi/com/sun/star/linguistic2/XHyphenator.idl index d07d65d0f641..061cf045fa9c 100644 --- a/offapi/com/sun/star/linguistic2/XHyphenator.idl +++ b/offapi/com/sun/star/linguistic2/XHyphenator.idl @@ -2,9 +2,9 @@ * * $RCSfile: XHyphenator.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -96,7 +96,12 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** Get a suitable hyphenation position (for breaking lines within words). +/** provides functionality for hyphenation of single words. + + <P>It's three main functionalities are to provide a suitable position for + breaking lines within a word, query about the existence of an alternative + spelling at a specific position of a word and providing a list of + possible hyphenation positions within a word.</P> <P>A hyphenation position for a word with n characters is represented by a value in the range from 0 to n-2, indicating the position @@ -107,7 +112,8 @@ module com { module sun { module star { module linguistic2 { fulfills all the restrictions implied by the properties MinLeading, MinTrailing and MinWordLength.</P> - @see XSupportedLocales + @see com::sun::star::linguistic2::LinguProperties + @see com::sun::star::linguistic2::XSupportedLocales */ [ uik(4BD5A958-5D68-11d4-9F090050-04D8BBC5), ident( "XHyphenator", 1.0 ) ] interface XHyphenator : com::sun::star::linguistic2::XSupportedLocales @@ -120,27 +126,32 @@ interface XHyphenator : com::sun::star::linguistic2::XSupportedLocales to left!</P> @returns - the XHyphenatedWord for the last valid hyphenation position - that is less or equal to nMaxLeading - 1. - If there is no such valid hyphenation position <NULL/> is returned. + the XHyphenatedWord for the last valid hyphenation position + that is less or equal to nMaxLeading - 1. + If there is no such valid hyphenation position <NULL/> is returned. @param aWord - is the word to be hyphenated. + is the word to be hyphenated. @param aLocale - defines the language to be used. + defines the language to be used. - <P>If the language is not supported an IllegalArgumentException - exception is raised.</P> + <P>If the language is not supported an IllegalArgumentException + exception is raised.</P> @param nMaxLeading - specifies the maximum number of characters to remain - before the hyphen in the hyphenated word. + specifies the maximum number of characters to remain + before the hyphen in the hyphenated word. + + <P>It has to be greater or equal 0.</P> - <P>It has to be greater or equal 0.</P> + @param aProperties + provides property values to be used for this function call only. + It is usually empty in order to use the default values supplied with + the property set. - @see XSupportedLocales - @see XHyphenatedWord + @see com::sun::star::linguistic2::XSupportedLocales + @see com::sun::star::linguistic2::XHyphenatedWord */ com::sun::star::linguistic2::XHyphenatedWord hyphenate( [in] string aWord, @@ -162,27 +173,33 @@ interface XHyphenator : com::sun::star::linguistic2::XSupportedLocales alternative spelling position!</P> @returns - ... - otherwise <NULL/> is returned. + the information about the alternative spelling found at the + specified position. Otherwise, if no alternative spelling was + found, <NULL/> is returned. @param aWord - is the (original) word to be looked at for having an alternative - spelling if hyphenation is done at position nIndex. + is the (original) word to be looked at for having an alternative + spelling if hyphenation is done at position nIndex. @param aLocale - specifies the language to be used. + specifies the language to be used. - <P>If the language is not supported an IllegalArgumentException - exception is raised.</P> + <P>If the language is not supported an IllegalArgumentException + exception is raised.</P> @param nIndex - is the position in the word to be looked at. + is the position in the word to be looked at. + + <P>If the length of the word is n the value of this + parameter has to be in the range from 0 to n-2.</P> - <P>If the length of the word is n the value of this - parameter has to be in the range from 0 to n-2.</P> + @param aProperties + provides property values to be used for this function call only. + It is usually empty in order to use the default values supplied with + the property set. - @see XSupportedLocales - @see XHyphenatedWord + @see com::sun::star::linguistic2::XSupportedLocales + @see com::sun::star::linguistic2::XHyphenatedWord */ com::sun::star::linguistic2::XHyphenatedWord queryAlternativeSpelling( [in] string aWord, @@ -192,27 +209,30 @@ interface XHyphenator : com::sun::star::linguistic2::XSupportedLocales raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - /** - <P>If the language is not supported an IllegalArgumentException - exception is raised.</P> + /** returns information abou all possible hyphenation positions of a word. + + @returns + a <type scope="com::sun::star::linguistic2">XPossibleHyphens</type> + for the given word and language if there are any hyphenation + positions. <NULL/> otherwise. @param aWord - is the word for which information about the possible - hyphenation positions is to be retrieved. + is the word for which information about the possible + hyphenation positions is to be retrieved. @param aLocale - defines the language of the word. + defines the language of the word. - <P>If the language is not supported an IllegalArgumentException - exception is raised.</P> + <P>If the language is not supported an IllegalArgumentException + exception is raised.</P> - @returns - a XPossibleHyphens for the given word and - language if there are any hyphenation positions. - <NULL/> otherwise. + @param aProperties + provides property values to be used for this function call only. + It is usually empty in order to use the default values supplied with + the property set. - @see XPossibleHyphens - @see Locale + @see com::sun::star::linguistic2::XPossibleHyphens + @see com::sun::star::lang::Locale */ com::sun::star::linguistic2::XPossibleHyphens createPossibleHyphens( [in] string aWord, diff --git a/offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.idl b/offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.idl index 810e2a930f89..263e5acd619b 100644 --- a/offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.idl +++ b/offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLinguServiceEventBroadcaster.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,14 +75,46 @@ module com { module sun { module star { module linguistic2 { //============================================================================= +/** is used to register as listener for LinguServiceEvents. + + <P>This interface may be used by spellchecker or hyphenator implementations + to allow clients to be registered and informed about + <type scope="com::sun::star::linguistic2">LinguServiceEvent</type>s. + </P> + + <P>Note: The LinguServiceManager forwards the + <type scope="com::sun::star::linguistic2">LinguServiceEvent</type>s + it receives (from spellcheckers or hyphenators) to it's own listeners. + Thus there should be no need to register + as listener for a specific implementation of those./P> + + @see com::sun::star::linguistic2::XLinguServiceManager + @see com::sun::star::linguistic2::XLinguServiceEventListener +*/ [ uik(4BD5A959-5D68-11d4-9F090050-04D8BBC5), ident( "XLinguServiceEventBroadcaster", 1.0 ) ] interface XLinguServiceEventBroadcaster : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- + /** + @returns + </TRUE> if the listener was successfully added, + </FALSE> otherwise. + + @param xLstnr + the listener to be addded. + */ boolean addLinguServiceEventListener ( [in] com::sun::star::linguistic2::XLinguServiceEventListener xLstnr ); //------------------------------------------------------------------------- + /** + @returns + </TRUE> if the listener was successfully removed, + </FALSE> otherwise. + + @param xLstnr + the listener to be removed. + */ boolean removeLinguServiceEventListener ( [in] com::sun::star::linguistic2::XLinguServiceEventListener xLstnr ); diff --git a/offapi/com/sun/star/linguistic2/XLinguServiceEventListener.idl b/offapi/com/sun/star/linguistic2/XLinguServiceEventListener.idl index fef123f17d1e..13a49ec15125 100644 --- a/offapi/com/sun/star/linguistic2/XLinguServiceEventListener.idl +++ b/offapi/com/sun/star/linguistic2/XLinguServiceEventListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLinguServiceEventListener.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,10 +75,24 @@ module com { module sun { module star { module linguistic2 { //============================================================================= +/** is used to inform listeners about LinguServiceEvents. + + <P>The function of this interface is used by the + <type scope="com::sun::star::linguistic2">XLinguServiceEventBroadcaster</type> + to inform its listeners about the + <type scope="com::sun::star::linguistic2">LinguServiceEventt</type>s. + </P> + + @see com::sun::star::linguistic2::XLinguServiceManager +*/ [ uik(4BD5A95A-5D68-11d4-9F090050-04D8BBC5), ident( "XLinguServiceEventListener", 1.0 ) ] interface XLinguServiceEventListener : com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- + /** + @param aLngSvcEvent + the event the listener will be informed about. + */ void processLinguServiceEvent( [in] com::sun::star::linguistic2::LinguServiceEvent aLngSvcEvent ); diff --git a/offapi/com/sun/star/linguistic2/XLinguServiceManager.idl b/offapi/com/sun/star/linguistic2/XLinguServiceManager.idl index ce088c02f60c..b7451e3bc5f6 100644 --- a/offapi/com/sun/star/linguistic2/XLinguServiceManager.idl +++ b/offapi/com/sun/star/linguistic2/XLinguServiceManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLinguServiceManager.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: tl $ $Date: 2000-11-30 14:37:52 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,48 +83,151 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** +/** the basic interface to be used to access linguistic functionality. + + <P>This interface is used to access spellchecker, hyphenator and thesaurus + functionality. + Additionaly it can be queries what implementations of those services are + availbale (for specific languages or in general). + It can be selected and queried which of those implementations should + be used for a specific language.</P> + + <P> + For spellchecking and thesaurus the order in the list defines the order + of creation/usage of those services. + That is if if the first spellchecker implementation does not recognize + the given word as correct the second service implementation for that + language is created and gets queries. 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. + </P> + + <P> For the thesaurus the behaviour is the same when no meaning was found. + </P> + + @see com::sun::star::linguistic2::SpellChecker + @see com::sun::star::linguistic2::Hyphenator + @see com::sun::star::linguistic2::Thesaurus + */ [ uik(4BD5A95B-5D68-11d4-9F090050-04D8BBC5), ident( "XLinguServiceManager", 1.0 ) ] interface XLinguServiceManager : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- + /** + @returns + the <type scope="com::sun::star::linguistic2">XSpellChecker</type> + interface to be used for spellchecking. + */ com::sun::star::linguistic2::XSpellChecker getSpellChecker(); //------------------------------------------------------------------------- + /** + @returns + the <type scope="com::sun::star::linguistic2">XHyphenator</type> + interface to be used for hyphenation. + */ com::sun::star::linguistic2::XHyphenator getHyphenator(); //------------------------------------------------------------------------- + /** + @returns + the <type scope="com::sun::star::linguistic2">XThesaurus</type> + interface to be used for thesaurus functionality. + */ com::sun::star::linguistic2::XThesaurus getThesaurus(); //------------------------------------------------------------------------- + /** adds a listener to the list of event listeners. + + <P>The listeners may support one or both of + <type scope="com::sun::star::linguistic2">XDictionaryEventListener</type> + or + <type scope="com::sun::star::linguistic2">XLinguServiceEventListener</type> + interface(s). + </P> + + @returns + </TRUE> if the listener was succesfully aded, </FALSE> otherwise. + + @param xListener + the listener to be added. + */ boolean addLinguServiceManagerListener( [in] com::sun::star::lang::XEventListener xListener ); //------------------------------------------------------------------------- + /** removes a listener to the list of event listeners. + + @returns + </TRUE> if the listener was succesfully removed, + </FALSE> otherwise. + + @param xListener + the listener to be removed. + */ boolean removeLinguServiceManagerListener( [in] com::sun::star::lang::XEventListener xListener ); //------------------------------------------------------------------------- - /* appropriate exception statement needed! */ + /** + @returns + the list of implementation names of the available services. + + @param aServiceName + the name of the service to get the list of available + implementations for. + + @param aLocale + the language for which to query the list of available + implementations for. + */ sequence< string > getAvailableServices( [in] string aServiceName, [in] com::sun::star::lang::Locale aLocale ); //------------------------------------------------------------------------- - /* appropriate exception statement needed! */ + /** retrieves a list of available Locales for a given service + + @param aServiceName + the name of the service to get the list of available Locales for. + */ sequence< com::sun::star::lang::Locale > getAvailableLocales( [in] string aServiceName ); //------------------------------------------------------------------------- - /* appropriate exception statement needed! */ + /** set the list of service implementations to be used for a + given service and language. + + @param aServiceName + the name of the service to set the list of implementations + to be used for. + + @param aLocale + the language to set the list for. + + @param aServiceImplNames + the name of the service to set the list for. + */ void setConfiguredServices( [in] string aServiceName, [in] com::sun::star::lang::Locale aLocale, [in] sequence< string > aServiceImplNames ); //------------------------------------------------------------------------- - /* appropriate exception statement needed! */ + /** query 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 + + @param aServiceName + the name of the service to get queried for. + + @param aLocale + the language to get queried for. + */ sequence< string > getConfiguredServices( [in] string aServiceName, [in] com::sun::star::lang::Locale aLocale ); diff --git a/offapi/com/sun/star/linguistic2/XMeaning.idl b/offapi/com/sun/star/linguistic2/XMeaning.idl index 36bc5012c033..f2eedbb809e5 100644 --- a/offapi/com/sun/star/linguistic2/XMeaning.idl +++ b/offapi/com/sun/star/linguistic2/XMeaning.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMeaning.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,11 +71,14 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** - Represents one of the possible meanings that may be returned from a - XThesaurus::queryMeanings call and allows for retrieval of its synonyms. +/** one of the possible meanings for a word. - @see XThesaurus + <P> Represents one of the possible meanings that may be returned from a + <member scope="com::sun::star::linguistic2">XThesaurus::queryMeanings</member> + call and allows for retrieval of its synonyms. + </P> + + @see com::sun::star::linguistic2::XThesaurus */ [ uik(4BD5A95C-5D68-11d4-9F090050-04D8BBC5), ident( "XMeaning", 1.0 ) ] interface XMeaning : com::sun::star::uno::XInterface @@ -83,15 +86,15 @@ interface XMeaning : com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** @returns - the meaning represented by this object. + the meaning represented by this object. */ string getMeaning(); //------------------------------------------------------------------------- /** @returns - a sequence of string where each entry is a synonym of the - current objects meaning. + a sequence of string where each entry is a synonym of the + current objects meaning. */ sequence<string> querySynonyms(); diff --git a/offapi/com/sun/star/linguistic2/XPossibleHyphens.idl b/offapi/com/sun/star/linguistic2/XPossibleHyphens.idl index 1abe45f3af94..80d183302465 100644 --- a/offapi/com/sun/star/linguistic2/XPossibleHyphens.idl +++ b/offapi/com/sun/star/linguistic2/XPossibleHyphens.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPossibleHyphens.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,8 +86,7 @@ module com { module sun { module star { module linguistic2 { the at position 9 you will get a additional "f" before the hyphen character.</P> - @see XPossibleHyphensSupplier - @see XInterface + @see com::sun::star::linguistic2::XHyphenator */ [ uik(4BD5A95E-5D68-11d4-9F090050-04D8BBC5), ident( "XPossibleHyphens", 1.0 ) ] interface XPossibleHyphens : com::sun::star::uno::XInterface @@ -95,36 +94,36 @@ interface XPossibleHyphens : com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** @returns - the word for which the information of possible hyphenation - points was obtained for. + the word for which the information of possible hyphenation + points was obtained for. */ string getWord(); //------------------------------------------------------------------------- /** @returns - the language of the hyphenated word. + the language of the hyphenated word. - @see Locale + @see com::sun::star::lang::Locale */ com::sun::star::lang::Locale getLocale(); //------------------------------------------------------------------------- /** @returns - a string depicting the word with all hyphen positions - which are represented by '=' characters. - If there are any alternative spellings the word will be altered - accordingly. + a string depicting the word with all hyphen positions + which are represented by '=' characters. + If there are any alternative spellings the word will be altered + accordingly. */ string getPossibleHyphens(); //------------------------------------------------------------------------- /** @returns - an ascending sequence of numbers where each number is a offset - within the original word which denotes a hyphenation - position corresponding to one of the hyphens in the - 'getPossibleHyphens' string. + an ascending sequence of numbers where each number is a offset + within the original word which denotes a hyphenation + position corresponding to one of the hyphens in the + 'getPossibleHyphens' string. @see getWord @see getPossibleHyphens diff --git a/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl b/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl index 1430cacb74a8..3037689768cc 100644 --- a/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl +++ b/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSearchableDictionaryList.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,13 +80,39 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** +/** allows searching for an entry in all dictionaries of the dictionary-list. + + <P> Only active dictionaries of a suitable language will be searched + for the entry. + The language is suitable if it is the same as the dictionaries language or + the dictionary may hold entries of all langauges. + <P> + + @see com::sun::star::linguistic2::XDíctionaryList */ [ uik(4BD5A960-5D68-11d4-9F090050-04D8BBC5), ident( "XSearchableDictionaryList", 1.0 ) ] interface XSearchableDictionaryList : com::sun::star::linguistic2::XDictionaryList { //------------------------------------------------------------------------- - /** + /** looks for an entry for a given word in the list of dictionaries. + + @returns + the dictionary entry that was found, </NULL> otherwise. + + @param aWord + the word (entry) to be looked for. + + @param aLocale + the language of the word to be looked for. + + @param bSearchPosDic + </TRUE> if only postive dictionaries should be searched. + </FALSE> of only negative dictionaries should be searched. + + @param bSpellEntry + </TRUE> if entries for purposes of spellchecking are required. + </FALSE> if only entries for hyphenation purposes are required. + */ com::sun::star::linguistic2::XDictionaryEntry queryDictionaryEntry( [in] string aWord , diff --git a/offapi/com/sun/star/linguistic2/XSpellAlternatives.idl b/offapi/com/sun/star/linguistic2/XSpellAlternatives.idl index b1bcb44e1355..afb08eadacc8 100644 --- a/offapi/com/sun/star/linguistic2/XSpellAlternatives.idl +++ b/offapi/com/sun/star/linguistic2/XSpellAlternatives.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSpellAlternatives.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,8 +77,14 @@ module com { module sun { module star { module linguistic2 { /** Gives access to the results of failed spellchecking attempts and may provide spelling alternatives. - @see XSpellChecker - @see XInterface + <P>This is used by the + <member scope="com::sun::star::linguistic2">XSpellChecker::spell</member> + function when the words was not found to be correct. + Suggestions for other words to be used may be provided also along with + a failure-type that may specifiy why the word was not correct. + </P> + + @see com::sun::star::linguistic2::SpellFailure */ [ uik(4BD5A961-5D68-11d4-9F090050-04D8BBC5), ident( "XSpellAlternatives", 1.0 ) ] interface XSpellAlternatives : com::sun::star::uno::XInterface @@ -86,41 +92,37 @@ interface XSpellAlternatives : com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** @returns - the word that was spelled. + the word that was spelled. */ string getWord(); //------------------------------------------------------------------------- - /** @returns - the Locale which specifies the language of the spelled word. + /** + @returns + the Locale which specifies the language of the spelled word. */ com::sun::star::lang::Locale getLocale(); //------------------------------------------------------------------------- /** @returns - the type (reason) for spellchecking to have failed verification. + the type (reason) for spellchecking to have failed verification. - @see SpellFailure + @see com::sun::star::linguistic2::SpellFailure */ short getFailureType(); //------------------------------------------------------------------------- /** @returns - the number of alternatives available. - - @see getAlternatives + the number of suggested spelling alternatives available. */ short getAlternativesCount(); //------------------------------------------------------------------------- /** @returns - the sequence of suggested spelling alternatives. - - @see getAlternativesCount - @see getAlternativesLocale + the sequence of suggested spelling alternatives. */ sequence<string> getAlternatives(); diff --git a/offapi/com/sun/star/linguistic2/XSpellChecker.idl b/offapi/com/sun/star/linguistic2/XSpellChecker.idl index 8342339b58b7..347798fbd58a 100644 --- a/offapi/com/sun/star/linguistic2/XSpellChecker.idl +++ b/offapi/com/sun/star/linguistic2/XSpellChecker.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSpellChecker.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,7 +89,11 @@ module com { module sun { module star { module linguistic2 { //============================================================================= /** This interface allows for spellchecking. - @see XSupportedLocales + <P>It is possible to simply check if a word in a specified language + is correct or additionally, if it was misspelled, some proposals + how it might be written.</P> + + @see com::sun::star::linguistic2::XSupportedLocales */ [ uik(4BD5A962-5D68-11d4-9F090050-04D8BBC5), ident( "XSpellChecker", 1.0 ) ] interface XSpellChecker : com::sun::star::linguistic2::XSupportedLocales @@ -98,20 +102,27 @@ interface XSpellChecker : com::sun::star::linguistic2::XSupportedLocales /** checks if a word is spelled correct in a given language. @returns - <TRUE/> if <var>aWord<var/> is spelled correct using - <var>aLocale</var>, <FALSE/> otherwise. + <TRUE/> if the word is spelled correct using + the specified language, <FALSE/> otherwise. @param aWord - the word to be checked. + the word to be checked. @param aLocale - the Locale to be used. - If <var>aLocale</var> is empty the word is spelled correct by - definition! If <var>aLocale</var> is not supported an - IllegalArgumentException exception is raised. + the Locale (language) to be used. + If the Local is empty the word is spelled correct by + definition! + + <P>If <var>aLocale</var> is not supported an + IllegalArgumentException exception is raised.</P> - @see XSupportedLocales - @see Locale + @param aProperties + provides property values to be used for this function call only. + It is usually empty in order to use the default values supplied with + the property set. + + @see com::sun::star::linguistic2::XSupportedLocales + @see com::sun::star::lang::Locale */ boolean isValid( [in] string aWord, @@ -124,23 +135,28 @@ interface XSpellChecker : com::sun::star::linguistic2::XSupportedLocales language. @returns - <NULL/> if <var>aWord</var> is spelled correct using - <var>aLocale</var>. Otherwise an XSpellAlternatives - object with information about the reason of failure and (maybe) - proposals for spelling alternatives will be returned. + <NULL/> if <var>aWord</var> is spelled correct using + <var>aLocale</var>. Otherwise an XSpellAlternatives + object with information about the reason of failure and (maybe) + proposals for spelling alternatives will be returned. @param aWord - the word to be checked. + the word to be checked. @param aLocale - the language to be used. + the language to be used. + + <P>If the language is not supported an IllegalArgumentException - <P>If the language is not supported an IllegalArgumentException + @param aProperties + provides property values to be used for this function call only. + It is usually empty in order to use the default values supplied with + the property set. exception is raised.</P> - @see XSupportedLocales - @see XSpellAlternatives - @see Locale + @see com::sun::star::linguistic2::XSupportedLocales + @see com::sun::star::linguistic2::XSpellAlternatives + @see com::sun::star::lang::Locale */ com::sun::star::linguistic2::XSpellAlternatives spell( [in] string aWord, diff --git a/offapi/com/sun/star/linguistic2/XSpellChecker1.idl b/offapi/com/sun/star/linguistic2/XSpellChecker1.idl index 1931a9411874..1da19bac3a43 100644 --- a/offapi/com/sun/star/linguistic2/XSpellChecker1.idl +++ b/offapi/com/sun/star/linguistic2/XSpellChecker1.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSpellChecker1.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/linguistic2/XSupportedLanguages.idl b/offapi/com/sun/star/linguistic2/XSupportedLanguages.idl index df7fa172682f..75e52371965c 100644 --- a/offapi/com/sun/star/linguistic2/XSupportedLanguages.idl +++ b/offapi/com/sun/star/linguistic2/XSupportedLanguages.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSupportedLanguages.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,6 +76,9 @@ module com { module sun { module star { module linguistic2 { //============================================================================= /** @deprecated + + <P>Deprecated interface not guaranteed to be supported. Don't use this + for new implementations!</P> */ [ uik(4BD5A964-5D68-11d4-9F090050-04D8BBC5), ident( "XSupportedLanguages", 1.0 ) ] interface XSupportedLanguages : com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/linguistic2/XSupportedLocales.idl b/offapi/com/sun/star/linguistic2/XSupportedLocales.idl index 5a127d01907a..72913a71d0c2 100644 --- a/offapi/com/sun/star/linguistic2/XSupportedLocales.idl +++ b/offapi/com/sun/star/linguistic2/XSupportedLocales.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSupportedLocales.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,11 +78,18 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** - Offers information about which languages are supported by the object. +/** Offers information about which languages are supported by the object. - @see Locale - @see XInterface + <P>This interface has to be implemented by + <type scope="com::sun::star::linguistic2">SpellChecker</type>, + <type scope="com::sun::star::linguistic2">Hyphenator</type> and + <type scope="com::sun::star::linguistic2">Thesaurus</type> + implementations in order to get queried for what languages they + can be used. + </P> + + @see com::sun::star::lang::Locale + @see com::sun::star::uno::XInterface */ [ uik(4BD5A965-5D68-11d4-9F090050-04D8BBC5), ident( "XSupportedLocales", 1.0 ) ] interface XSupportedLocales : com::sun::star::uno::XInterface @@ -90,22 +97,22 @@ interface XSupportedLocales : com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** @returns - the sequence of all supported languages. + the sequence of all supported languages. - @see Locale + @see com::sun::star::lang::Locale */ sequence<com::sun::star::lang::Locale> getLocales(); //------------------------------------------------------------------------- /** @param aLocale - specifies the language to be checked for support - by the object. + specifies the language to be checked for support + by the object. @returns - <TRUE/> if the language is supported otherwise <FALSE/>. + <TRUE/> if the language is supported otherwise <FALSE/>. - @see Locale + @see com::sun::star::lang::Locale */ boolean hasLocale( [in] com::sun::star::lang::Locale aLocale ); }; diff --git a/offapi/com/sun/star/linguistic2/XThesaurus.idl b/offapi/com/sun/star/linguistic2/XThesaurus.idl index 17d7cec577ca..435f6c1b1ad5 100644 --- a/offapi/com/sun/star/linguistic2/XThesaurus.idl +++ b/offapi/com/sun/star/linguistic2/XThesaurus.idl @@ -2,9 +2,9 @@ * * $RCSfile: XThesaurus.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $ + * last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,35 +82,42 @@ module com { module sun { module star { module linguistic2 { //============================================================================= -/** - It allows fo the retrieval of possible meanings for a given - word and language. +/** allows fo the retrieval of possible meanings for a given word and language + + <P> The meaning of a word is in essence a descriptive text for that word. Each meaning may have several synonmys where a synonym usually is a word (or small text) with the same or similar meaning. + </P> - @see XSupportedLocales + @see com::sun::star::linguistic2::XSupportedLocales */ [ uik(4BD5A966-5D68-11d4-9F090050-04D8BBC5), ident( "XThesaurus", 1.0 ) ] interface XThesaurus : com::sun::star::linguistic2::XSupportedLocales { //------------------------------------------------------------------------- /** + @returns + a lsit of meanings for the given word and language. + @param aTerm - the word to query for its meanings. + the word to query for its meanings. @param aLocale - specifies the language of the word. + specifies the language of the word. - <P>If the language is not supported an - <type scope="com::sun::star::lang">IllegalArgumentException</type> - exception is raised.</P> + <P>If the language is not supported an + <type scope="com::sun::star::lang">IllegalArgumentException</type> + exception is raised.</P> - @returns - the sequence of possible meanings for the given word and language. + @param aProperties + provides property values to be used for this function call only. + It is usually empty in order to use the default values supplied with + the property set. + the sequence of possible meanings for the given word and language. - @see Locale - @see XMeaning + @see com::sun::star::lang::Locale + @see com::sun::star::linguistic2::XMeaning */ sequence< com::sun::star::linguistic2::XMeaning > queryMeanings( [in] string aTerm, |