xref: /aoo41x/main/udkapi/com/sun/star/beans/XExactName.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_beans_XExactName_idl__
#define __com_sun_star_beans_XExactName_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif


//=============================================================================

module com {  module sun {  module star {  module beans {

//=============================================================================

/** provides a method of changing names for converting
	an approximate name to an existing name.

	<p> One field of application is the conversion of case-insensitive
	names to the existing names.  </p>

	<p>Example: A basic interpreter ignores the case of the names. So
	it must query the <type>XExactName</type> interface and then call
	the method. </p>

	@see com::sun::star::beans::XPropertySet
	@see com::sun::star::beans::XIntrospectionAccess
	@see com::sun::star::container::XNameAccess
 */
published interface XExactName: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** @returns
			the exact name for a given aprroximate name.

		<p>For example "getExactName" could be returned for "GETEXACTNAME"
		when "GETEXACTNAME" was used by a case insesitive scripting language. </p>
	 */
	string getExactName( [in] string aApproximateName );

};

//=============================================================================

}; }; }; };

#endif