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