offapi/com/sun/star/linguistic2/XAvailableLocales.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_XAvailableLocales_idl__
  20 #define __com_sun_star_linguistic2_XAvailableLocales_idl__
  21
  22
  23 #include <com/sun/star/lang/Locale.idl>
  24
  25
  26
  27 module com { module sun { module star { module linguistic2 {
  28
  29 /** retrieves the list of available languages.
  30 */
  31 published interface XAvailableLocales : com::sun::star::uno::XInterface
  32 {
  33     /** retrieve the list of supported languages (Locales).
  34
  35         @see    com::sun::star::linguistic2::XSupportedLocales
  36
  37         @param aServiceName
  38             the name of the service to get the list of available Locales for.
  39         @return
  40             the list of locales supported by the whole of all registered
  41             implementations of that service. The sequence will be empty
  42             if there is no such language or the service is not known.
  43     */
  44     sequence< com::sun::star::lang::Locale > getAvailableLocales(
  45         [in] string                         aServiceName );
  46 };
  47
  48
  49 }; }; }; };
  50
  51 #endif
  52
  53 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */