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

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