summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/script/XDefaultMethod.idl
blob: a51fe76c181efaaed9092cae3e1d9b5a3b2c184b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XDefaultMethod.idl,v $
 * $Revision: 1.4 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_script_XDefaultMethod_idl__
#define __com_sun_star_script_XDefaultMethod_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

module com { module sun { module star { module script {
//==============================================================================
/**
    An object supporting this interface indicates to interested
    parties or clients the name of the default method for
    this object.
    <p>For example where ExampleObject is an instance of an Object that
    supports this interface which returns the default method name
    "defaultMethod".A scripting engine could use this information to support
    syntax like <p>"ExampleObject( Param1 .... ParamN )"</p>
    which would be equivalent to writing
    <p>"ExampleObject.defaultMethod( Param1 ... ParamN )"</p>
*/
interface XDefaultMethod : ::com::sun::star::uno::XInterface
{
  //-----------------------------------------------------------------------
  /**
    Returns the name of the default method

    @return
     The <atom>string</atom> name of default method
  */
  string getDefaultMethodName();

};

};  };  };  };
#endif