udkapi/com/sun/star/beans/XExactName.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_beans_XExactName_idl__
  20 #define __com_sun_star_beans_XExactName_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25
  26 module com {  module sun {  module star {  module beans {
  27
  28
  29 /** provides a method of changing names for converting
  30     an approximate name to an existing name.
  31
  32     <p> One field of application is the conversion of case-insensitive
  33     names to the existing names.  </p>
  34
  35     <p>Example: A basic interpreter ignores the case of the names. So
  36     it must query the XExactName interface and then call
  37     the method. </p>
  38
  39     @see com::sun::star::beans::XPropertySet
  40     @see com::sun::star::beans::XIntrospectionAccess
  41     @see com::sun::star::container::XNameAccess
  42  */
  43 published interface XExactName: com::sun::star::uno::XInterface
  44 {
  45
  46     /** @returns
  47             the exact name for a given aprroximate name.
  48
  49         <p>For example "getExactName" could be returned for "GETEXACTNAME"
  50         when "GETEXACTNAME" was used by a case insesitive scripting language. </p>
  51      */
  52     string getExactName( [in] string aApproximateName );
  53
  54 };
  55
  56
  57 }; }; }; };
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */