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