1408a4873SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3408a4873SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4408a4873SAndrew Rist * or more contributor license agreements. See the NOTICE file 5408a4873SAndrew Rist * distributed with this work for additional information 6408a4873SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7408a4873SAndrew Rist * to you under the Apache License, Version 2.0 (the 8408a4873SAndrew Rist * "License"); you may not use this file except in compliance 9408a4873SAndrew Rist * with the License. You may obtain a copy of the License at 10cdf0e10cSrcweir * 11408a4873SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12cdf0e10cSrcweir * 13408a4873SAndrew Rist * Unless required by applicable law or agreed to in writing, 14408a4873SAndrew Rist * software distributed under the License is distributed on an 15408a4873SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16408a4873SAndrew Rist * KIND, either express or implied. See the License for the 17408a4873SAndrew Rist * specific language governing permissions and limitations 18408a4873SAndrew Rist * under the License. 19cdf0e10cSrcweir * 20408a4873SAndrew Rist *************************************************************/ 21408a4873SAndrew Rist 22408a4873SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_script_XDefaultProperty_idl__ 25cdf0e10cSrcweir#define __com_sun_star_script_XDefaultProperty_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweirmodule com { module sun { module star { module script { 32cdf0e10cSrcweir//============================================================================== 33cdf0e10cSrcweir/** 34cdf0e10cSrcweir An object supporting this interface indicates to interested 35*19285428SJohn Bampton parties or clients the name of the default property for 36cdf0e10cSrcweir this object. 37cdf0e10cSrcweir <p>For example where ExampleObject is an instance of an Object that 38cdf0e10cSrcweir supports this interface which returns the default property name 39cdf0e10cSrcweir "Value".A scripting engine could use this information to support 40cdf0e10cSrcweir syntax like <p>ExampleObject = "foo"</p> 41cdf0e10cSrcweir which would be equivalent to writing 42cdf0e10cSrcweir <p>ExampleObject.Value = "foo"</p> 43cdf0e10cSrcweir or 44cdf0e10cSrcweir <p>bar = ExampleObject</p> 45cdf0e10cSrcweir which would be equivalent to writing 46cdf0e10cSrcweir <p>bar = ExampleObject.Value</p> 47cdf0e10cSrcweir*/ 48cdf0e10cSrcweirinterface XDefaultProperty : ::com::sun::star::uno::XInterface 49cdf0e10cSrcweir{ 50cdf0e10cSrcweir //----------------------------------------------------------------------- 51cdf0e10cSrcweir /** 52cdf0e10cSrcweir Returns the name of the default property 53cdf0e10cSrcweir 54cdf0e10cSrcweir @return 55cdf0e10cSrcweir The <atom>string</atom> name of default property 56cdf0e10cSrcweir */ 57cdf0e10cSrcweir string getDefaultPropertyName(); 58cdf0e10cSrcweir 59cdf0e10cSrcweir}; 60cdf0e10cSrcweir 61cdf0e10cSrcweir}; }; }; }; 62cdf0e10cSrcweir#endif 63