xref: /trunk/main/udkapi/com/sun/star/script/InvocationInfo.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1*408a4873SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*408a4873SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*408a4873SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*408a4873SAndrew Rist * distributed with this work for additional information
6*408a4873SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*408a4873SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*408a4873SAndrew Rist * "License"); you may not use this file except in compliance
9*408a4873SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11*408a4873SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13*408a4873SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*408a4873SAndrew Rist * software distributed under the License is distributed on an
15*408a4873SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*408a4873SAndrew Rist * KIND, either express or implied.  See the License for the
17*408a4873SAndrew Rist * specific language governing permissions and limitations
18*408a4873SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20*408a4873SAndrew Rist *************************************************************/
21*408a4873SAndrew Rist
22*408a4873SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_script_InvocationInfo_idl__
24cdf0e10cSrcweir#define __com_sun_star_script_InvocationInfo_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_script_MemberType_idl__
27cdf0e10cSrcweir#include <com/sun/star/script/MemberType.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_reflection_ParamMode_idl__
31cdf0e10cSrcweir#include <com/sun/star/reflection/ParamMode.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir//=============================================================================
35cdf0e10cSrcweir
36cdf0e10cSrcweir module com {  module sun {  module star {  module script {
37cdf0e10cSrcweir
38cdf0e10cSrcweir//=============================================================================
39cdf0e10cSrcweir
40cdf0e10cSrcweir/**
41cdf0e10cSrcweir    This struct is used to specify information about object members
42cdf0e10cSrcweir    (methods or properties) accessed via XInvocation, such as names,
43cdf0e10cSrcweir    types, or parameters.
44cdf0e10cSrcweir    </p>
45cdf0e10cSrcweir */
46cdf0e10cSrcweirpublished struct InvocationInfo
47cdf0e10cSrcweir{
48cdf0e10cSrcweir
49cdf0e10cSrcweir    /** Name of the method or property.
50cdf0e10cSrcweir     */
51cdf0e10cSrcweir    string aName;
52cdf0e10cSrcweir
53cdf0e10cSrcweir    /** Kind of the member (method or property).
54cdf0e10cSrcweir     */
55cdf0e10cSrcweir    MemberType eMemberType;
56cdf0e10cSrcweir
57cdf0e10cSrcweir    /** Only for property members:
58cdf0e10cSrcweir        This field may contain zero or more constants of the
59cdf0e10cSrcweir        <type scope="com::sun::star::beans">PropertyAttribute</type>
60cdf0e10cSrcweir        constants group. It is not guaranteed that all necessary
61cdf0e10cSrcweir        constants are set to describe the property completely,
62cdf0e10cSrcweir        but a flag will only be set, if the corresponding charac-
63cdf0e10cSrcweir        teristic really exists. Example: If the READONLY flag
64cdf0e10cSrcweir        is set, the property is readonly. If it isn't set, the
65cdf0e10cSrcweir        property nevertheless can be readonly.
66cdf0e10cSrcweir
67cdf0e10cSrcweir        For methods this field is irrelevant and is set to 0.
68cdf0e10cSrcweir     */
69cdf0e10cSrcweir    short PropertyAttribute;
70cdf0e10cSrcweir
71cdf0e10cSrcweir    /** Type of the member, for methods the return type
72cdf0e10cSrcweir     */
73cdf0e10cSrcweir    type aType;
74cdf0e10cSrcweir
75cdf0e10cSrcweir    /** Types method parameters, for properties this sequence is empty
76cdf0e10cSrcweir     */
77cdf0e10cSrcweir    sequence< type > aParamTypes;
78cdf0e10cSrcweir
79cdf0e10cSrcweir    /** Mode of method parameters (IN, OUT, INOUT),
80cdf0e10cSrcweir        for properties this sequence is empty.
81cdf0e10cSrcweir     */
82cdf0e10cSrcweir    sequence< com::sun::star::reflection::ParamMode > aParamModes;
83cdf0e10cSrcweir};
84cdf0e10cSrcweir
85cdf0e10cSrcweir//=============================================================================
86cdf0e10cSrcweir
87cdf0e10cSrcweir}; }; }; };
88cdf0e10cSrcweir
89cdf0e10cSrcweir#endif
90