xref: /aoo42x/main/udkapi/com/sun/star/beans/XExactName.idl (revision a5f4f399)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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 approximate name.

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

	//-------------------------------------------------------------------------

};

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

}; }; }; };

#endif