offapi/com/sun/star/linguistic2/XSpellChecker.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module linguistic2 {
  22
  23 /** This interface allows for spell checking.
  24
  25     <P>It is possible to simply check if a word, in a specified language,
  26     is correct or additionally, if it was misspelled, some proposals
  27     how it might be correctly written.</P>
  28
  29     @see    com::sun::star::linguistic2::XSupportedLocales
  30 */
  31 published interface XSpellChecker : com::sun::star::linguistic2::XSupportedLocales
  32 {
  33     /** checks if a word is spelled correctly in a given language.
  34
  35         @returns
  36             `TRUE` if the word is spelled correctly using
  37              the specified language, `FALSE` otherwise.
  38
  39         @param  aWord
  40             the word to be checked.
  41
  42         @param aLocale
  43             the Locale (language) to be used.
  44             If the Locale is empty, the word is spelled correctly by
  45             definition.
  46
  47             <P>If <var>aLocale</var> is not supported an
  48             IllegalArgumentException exception is raised.</P>
  49
  50         @param aProperties
  51             provides property values to be used for this function call only.
  52             It is usually empty in order to use the default values supplied with
  53             the property set.
  54
  55         @see    com::sun::star::lang::Locale
  56     */
  57     boolean isValid(
  58             [in] string aWord,
  59             [in] com::sun::star::lang::Locale aLocale,
  60             [in] com::sun::star::beans::PropertyValues aProperties )
  61         raises( com::sun::star::lang::IllegalArgumentException );
  62
  63     /** This method checks if a word is spelled correctly in a given
  64         language.
  65
  66         @returns
  67             `NULL` if <var>aWord</var> is spelled correctly using
  68              <var>aLocale</var>. Otherwise, an XSpellAlternatives
  69              object with information about the reason of failure and, if available,
  70              proposals for spelling alternatives will be returned.
  71
  72         @param  aWord
  73             the word to be checked.
  74
  75         @param aLocale
  76             the language to be used.
  77
  78             <P>If the language is not supported an IllegalArgumentException exception is raised.
  79
  80         @param aProperties
  81             provides property values to be used for this function call only.
  82             It is usually empty in order to use the default values supplied with
  83             the property set.
  84         exception is raised.</P>
  85
  86         @see    com::sun::star::linguistic2::XSpellAlternatives
  87         @see    com::sun::star::lang::Locale
  88     */
  89     com::sun::star::linguistic2::XSpellAlternatives spell(
  90             [in] string aWord,
  91             [in] com::sun::star::lang::Locale aLocale,
  92             [in] com::sun::star::beans::PropertyValues aProperties )
  93         raises( com::sun::star::lang::IllegalArgumentException );
  94
  95 };
  96
  97
  98 }; }; }; };
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */