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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21  module com {  module sun {  module star {  module script {
  22
  23
  24 /**
  25     This struct is used to specify information about object members
  26     (methods or properties) accessed via XInvocation, such as names,
  27     types, or parameters.
  28     </p>
  29  */
  30 published struct InvocationInfo
  31 {
  32
  33     /** Name of the method or property.
  34      */
  35     string aName;
  36
  37     /** Kind of the member (method or property).
  38      */
  39     MemberType eMemberType;
  40
  41     /** Only for property members:
  42         This field may contain zero or more constants of the
  43         com::sun::star::beans::PropertyAttribute
  44         constants group. It is not guaranteed that all necessary
  45         constants are set to describe the property completely,
  46         but a flag will only be set, if the corresponding charac-
  47         teristic really exists. Example: If the READONLY flag
  48         is set, the property is readonly. If it isn't set, the
  49         property nevertheless can be readonly.
  50
  51         For methods this field is irrelevant and is set to 0.
  52      */
  53      short PropertyAttribute;
  54
  55     /** Type of the member, for methods the return type
  56      */
  57     type aType;
  58
  59     /** Types method parameters, for properties this sequence is empty
  60      */
  61     sequence< type > aParamTypes;
  62
  63     /** Mode of method parameters (IN, OUT, INOUT),
  64         for properties this sequence is empty.
  65      */
  66     sequence< com::sun::star::reflection::ParamMode > aParamModes;
  67 };
  68
  69
  70 }; }; }; };
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */