summaryrefslogtreecommitdiffstats
path: root/udkapi/com/sun/star/script/XDefaultMethod.idl
blob: b61efd4d71646619ed651bf00b0c8c9f799b29f5 (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
66
67
68
69
70
/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XDefaultMethod.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: rt $ $Date: 2006-05-05 10:14:57 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#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 getName();

};

};  };  };  };
#endif