xref: /trunk/main/udkapi/com/sun/star/beans/XExactName.idl (revision a5f4f399)
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_beans_XExactName_idl__
24#define __com_sun_star_beans_XExactName_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30
31//=============================================================================
32
33module com {  module sun {  module star {  module beans {
34
35//=============================================================================
36
37/** provides a method of changing names for converting
38	an approximate name to an existing name.
39
40	<p> One field of application is the conversion of case-insensitive
41		names to the existing names.</p>
42
43	<p> Example: A basic interpreter ignores the case of the names. So
44		it must query the <type>XExactName</type> interface and then call
45		the method.</p>
46
47	@see com::sun::star::beans::XPropertySet
48	@see com::sun::star::beans::XIntrospectionAccess
49	@see com::sun::star::container::XNameAccess
50 */
51published interface XExactName: com::sun::star::uno::XInterface
52{
53	//-------------------------------------------------------------------------
54
55	/** @returns
56			the exact name for a given approximate name.
57
58		<p> For example "getExactName" could be returned for "GETEXACTNAME"
59			when "GETEXACTNAME" was used by a case insensitive scripting language.</p>
60	 */
61	string getExactName( [in] string aApproximateName );
62
63	//-------------------------------------------------------------------------
64
65};
66
67//=============================================================================
68
69}; }; }; };
70
71#endif
72