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