udkapi/com/sun/star/script/XDefaultProperty.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_script_XDefaultProperty_idl__
  29 #define __com_sun_star_script_XDefaultProperty_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 module com { module sun { module star { module script {
  36 //==============================================================================
  37 /**
  38     An object supporting this interface indicates to interested
  39     parties or clients the name of the default propery for
  40     this object.
  41     <p>For example where ExampleObject is an instance of an Object that
  42     supports this interface which returns the default property name
  43     "Value".A scripting engine could use this information to support
  44     syntax like <p>ExampleObject = "foo"</p>
  45     which would be equivalent to writing
  46     <p>ExampleObject.Value = "foo"</p>
  47     or
  48     <p>bar = ExampleObject</p>
  49     which would be equivalent to writing
  50     <p>bar = ExampleObject.Value</p>
  51 */
  52 interface XDefaultProperty : ::com::sun::star::uno::XInterface
  53 {
  54   //-----------------------------------------------------------------------
  55   /**
  56     Returns the name of the default property
  57
  58     @return
  59      The <atom>string</atom> name of default property
  60   */
  61   string getDefaultPropertyName();
  62
  63 };
  64
  65 };  };  };  };
  66 #endif