offapi/com/sun/star/linguistic2/XSupportedLocales.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 #ifndef __com_sun_star_linguistic2_XSupportedLocales_idl__
  20 #define __com_sun_star_linguistic2_XSupportedLocales_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/lang/Locale.idl>
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25
  26
  27 module com { module sun { module star { module linguistic2 {
  28
  29 /** Offers information about which languages are supported by the object.
  30
  31     <P>This interface has to be implemented by
  32     com::sun::star::linguistic2::SpellChecker,
  33     com::sun::star::linguistic2::Hyphenator and
  34     com::sun::star::linguistic2::Thesaurus
  35     implementations in order to be queried for the languages they
  36     can use.
  37     </P>
  38
  39     @see    com::sun::star::lang::Locale
  40     @see    com::sun::star::uno::XInterface
  41 */
  42 published interface XSupportedLocales : com::sun::star::uno::XInterface
  43 {
  44     /**
  45          @returns
  46              the sequence of all supported languages.
  47     */
  48     sequence<com::sun::star::lang::Locale> getLocales();
  49
  50     /**
  51         @param  aLocale
  52             specifies the language being checked for support
  53              by the object.
  54
  55          @returns
  56              `TRUE` if the language is supported, otherwise `FALSE`.
  57     */
  58     boolean hasLocale( [in] com::sun::star::lang::Locale aLocale );
  59 };
  60
  61
  62 }; }; }; };
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */