udkapi/com/sun/star/script/XDefaultProperty.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
  20 #ifndef __com_sun_star_script_XDefaultProperty_idl__
  21 #define __com_sun_star_script_XDefaultProperty_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25 module com { module sun { module star { module script {
  26 /**
  27     An object supporting this interface indicates to interested
  28     parties or clients the name of the default propery for
  29     this object.
  30     <p>For example where ExampleObject is an instance of an Object that
  31     supports this interface which returns the default property name
  32     "Value".A scripting engine could use this information to support
  33     syntax like <p>ExampleObject = "foo"</p>
  34     which would be equivalent to writing
  35     <p>ExampleObject.Value = "foo"</p>
  36     or
  37     <p>bar = ExampleObject</p>
  38     which would be equivalent to writing
  39     <p>bar = ExampleObject.Value</p>
  40 */
  41 interface XDefaultProperty : ::com::sun::star::uno::XInterface
  42 {
  43   /**
  44     Returns the name of the default property
  45
  46     @return
  47      The `string` name of default property
  48   */
  49   string getDefaultPropertyName();
  50
  51 };
  52
  53 };  };  };  };
  54 #endif
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */