1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_lang_XServiceDisplayName_idl__
24#define __com_sun_star_lang_XServiceDisplayName_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_lang_Locale_idl__
31#include <com/sun/star/lang/Locale.idl>
32#endif
33
34//=============================================================================
35
36module com {  module sun {  module star {  module lang {
37
38//=============================================================================
39/** provides a name for the service to be used in displays.
40
41 	<p>This name can be used in displays (dialogs, menus, etc.) to provide
42 	a more memorable / meaningful name than the service name or its
43 	implementation name. It should not be used to identify / select a
44 	specific service / implementation.</p>
45 */
46published interface XServiceDisplayName : ::com::sun::star::uno::XInterface
47{
48	//-------------------------------------------------------------------------
49	/** returns the display name of the service for a given language.
50
51	 	<p>The caller may specify a
52	 	<type scope="com::sun::star::lang">Locale</type> for the preferred
53	 	language of the resulting string.
54	 	However, if that locale is not supported the resulting string may
55	 	be given in a different language. Usually this should be English.</p>
56
57	 	@param aLocale
58	 		the preferred language for the resulting display name.
59
60	 	@returns
61	 		the string to be used for the service in displays.
62	 */
63	string	getServiceDisplayName(
64			[in] ::com::sun::star::lang::Locale aLocale );
65};
66
67//=============================================================================
68
69}; }; }; };
70
71#endif
72
73