summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/linguistic2/XSpellAlternatives.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/linguistic2/XSpellAlternatives.idl')
-rw-r--r--offapi/com/sun/star/linguistic2/XSpellAlternatives.idl133
1 files changed, 133 insertions, 0 deletions
diff --git a/offapi/com/sun/star/linguistic2/XSpellAlternatives.idl b/offapi/com/sun/star/linguistic2/XSpellAlternatives.idl
new file mode 100644
index 000000000000..2742fea4451c
--- /dev/null
+++ b/offapi/com/sun/star/linguistic2/XSpellAlternatives.idl
@@ -0,0 +1,133 @@
+/*************************************************************************
+ *
+ * $RCSfile: XSpellAlternatives.idl,v $
+ *
+ * $Revision: 1.1 $
+ *
+ * last change: $Author: mi $ $Date: 2000-11-06 09:21:49 $
+ *
+ * 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_XSpellAlternatives_idl__
+#define __com_sun_star_linguistic2_XSpellAlternatives_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.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 {
+
+//=============================================================================
+/** Gives access to the results of failed
+ spellchecking attempts and may provide spelling alternatives.
+
+ @see XSpellChecker
+ @see XInterface
+*/
+[ uik(4BD5A961-5D68-11d4-9F090050-04D8BBC5), ident( "XSpellAlternatives", 1.0 ) ]
+interface XSpellAlternatives : com::sun::star::uno::XInterface
+{
+ //-------------------------------------------------------------------------
+ /**
+ @returns
+ the word that was spelled.
+ */
+ string getWord();
+
+ //-------------------------------------------------------------------------
+ /** @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.
+
+ @see SpellFailure
+ */
+ short getFailureType();
+
+ //-------------------------------------------------------------------------
+ /**
+ @returns
+ the number of alternatives available.
+
+ @see getAlternatives
+ */
+ short getAlternativesCount();
+
+ //-------------------------------------------------------------------------
+ /**
+ @returns
+ the sequence of suggested spelling alternatives.
+
+ @see getAlternativesCount
+ @see getAlternativesLocale
+ */
+ sequence<string> getAlternatives();
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif