udkapi/com/sun/star/script/InvocationInfo.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: InvocationInfo.idl,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_script_InvocationInfo_idl__
  31 #define __com_sun_star_script_InvocationInfo_idl__
  32
  33 #ifndef __com_sun_star_script_MemberType_idl__
  34 #include <com/sun/star/script/MemberType.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_reflection_ParamMode_idl__
  38 #include <com/sun/star/reflection/ParamMode.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module script {
  44
  45 //=============================================================================
  46
  47 /**
  48     This struct is used to specify information about object members
  49     (methods or properties) accessed via XInvocation, such as names,
  50     types, or parameters.
  51     </p>
  52  */
  53 published struct InvocationInfo
  54 {
  55
  56     /** Name of the method or property.
  57      */
  58     string aName;
  59
  60     /** Kind of the member (method or property).
  61      */
  62     MemberType eMemberType;
  63
  64     /** Only for property members:
  65         This field may contain zero or more constants of the
  66         <type scope="com::sun::star::beans">PropertyAttribute</type>
  67         constants group. It is not guaranteed that all necessary
  68         constants are set to describe the property completely,
  69         but a flag will only be set, if the corresponding charac-
  70         teristic really exists. Example: If the READONLY flag
  71         is set, the property is readonly. If it isn't set, the
  72         property nevertheless can be readonly.
  73
  74         For methods this field is irrelevant and is set to 0.
  75      */
  76      short PropertyAttribute;
  77
  78     /** Type of the member, for methods the return type
  79      */
  80     type aType;
  81
  82     /** Types method parameters, for properties this sequence is empty
  83      */
  84     sequence< type > aParamTypes;
  85
  86     /** Mode of method parameters (IN, OUT, INOUT),
  87         for properties this sequence is empty.
  88      */
  89     sequence< com::sun::star::reflection::ParamMode > aParamModes;
  90 };
  91
  92 //=============================================================================
  93
  94 }; }; }; };
  95
  96 #endif