1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_lang_XServiceDisplayName_idl__ 28#define __com_sun_star_lang_XServiceDisplayName_idl__ 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34#ifndef __com_sun_star_lang_Locale_idl__ 35#include <com/sun/star/lang/Locale.idl> 36#endif 37 38//============================================================================= 39 40module com { module sun { module star { module lang { 41 42//============================================================================= 43/** provides a name for the service to be used in displays. 44 45 <p>This name can be used in displays (dialogs, menus, etc.) to provide 46 a more memorable / meaningful name than the service name or its 47 implementation name. It should not be used to identify / select a 48 specific service / implementation.</p> 49 */ 50published interface XServiceDisplayName : ::com::sun::star::uno::XInterface 51{ 52 //------------------------------------------------------------------------- 53 /** returns the display name of the service for a given language. 54 55 <p>The caller may specify a 56 <type scope="com::sun::star::lang">Locale</type> for the preferred 57 language of the resulting string. 58 However, if that locale is not supported the resulting string may 59 be given in a different language. Usually this should be English.</p> 60 61 @param aLocale 62 the preferred language for the resulting display name. 63 64 @returns 65 the string to be used for the service in displays. 66 */ 67 string getServiceDisplayName( 68 [in] ::com::sun::star::lang::Locale aLocale ); 69}; 70 71//============================================================================= 72 73}; }; }; }; 74 75#endif 76 77