udkapi/com/sun/star/lang/XServiceDisplayName.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 lang {
  22
  23 /** provides a name for the service to be used in displays.
  24
  25      <p>This name can be used in displays (dialogs, menus, etc.) to provide
  26      a more memorable / meaningful name than the service name or its
  27      implementation name. It should not be used to identify / select a
  28      specific service / implementation.</p>
  29  */
  30 published interface XServiceDisplayName : ::com::sun::star::uno::XInterface
  31 {
  32     /** returns the display name of the service for a given language.
  33
  34          <p>The caller may specify a
  35          com::sun::star::lang::Locale for the preferred
  36          language of the resulting string.
  37          However, if that locale is not supported the resulting string may
  38          be given in a different language. Usually this should be English.</p>
  39
  40          @param aLocale
  41              the preferred language for the resulting display name.
  42
  43          @returns
  44              the string to be used for the service in displays.
  45      */
  46     string  getServiceDisplayName(
  47             [in] ::com::sun::star::lang::Locale aLocale );
  48 };
  49
  50
  51 }; }; }; };
  52
  53 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */