xref: /trunk/main/udkapi/com/sun/star/script/XInvocation2.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_script_XInvocation2_idl__
28#define __com_sun_star_script_XInvocation2_idl__
29
30#ifndef __com_sun_star_script_XInvocation_idl__
31#include <com/sun/star/script/XInvocation.idl>
32#endif
33
34#ifndef __com_sun_star_script_InvocationInfo_idl__
35#include <com/sun/star/script/InvocationInfo.idl>
36#endif
37
38//=============================================================================
39
40 module com {  module sun {  module star {  module script {
41
42//=============================================================================
43
44/**
45    Extension of XInvocation to provide additional information
46    about the methods and properties that are accessable via
47    XInvocation.
48    </p>
49 */
50published interface XInvocation2: com::sun::star::script::XInvocation
51{
52    /** returns the names of all methods and properties accessable via XInvocation.
53     */
54    sequence< string > getMemberNames();
55
56    /** returns information items for all methods and properties accessable via XInvocation.
57
58        @see com::sun::star::script::Invocation
59     */
60    sequence< InvocationInfo > getInfo();
61
62    /** returns information item for the method or property defined by aName
63
64        @param aName
65            specifies the name of the method or property
66
67        @param bExact
68            specifies the name of the method or property
69
70        @throws IllegalArgumentException
71            if aName is not the name of a supported method or property
72
73        @see com::sun::star::script::Invocation
74     */
75    InvocationInfo getInfoForName( [in] string aName, [in] boolean bExact )
76        raises( com::sun::star::lang::IllegalArgumentException );
77
78};
79
80//=============================================================================
81
82}; }; }; };
83
84#endif
85