udkapi/com/sun/star/reflection/XMethodParameter.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 #ifndef __com_sun_star_reflection_XMethodParameter_idl__
  20 #define __com_sun_star_reflection_XMethodParameter_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/reflection/XTypeDescription.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module reflection {
  29
  30
  31 /** Reflects a method parameter.
  32
  33     <p>This type is superseded by XParameter, which supports
  34     parameters of service constructors as well as parameters of interface
  35     methods.</p>
  36
  37     @see XInterfaceMethodTypeDescription
  38 */
  39 published interface XMethodParameter: com::sun::star::uno::XInterface
  40 {
  41     /** Returns the name of the parameter
  42
  43         @return
  44                 name of parameter
  45     */
  46     string getName();
  47
  48     /** Returns the type of the parameter.
  49
  50         @return
  51                 type of parameter
  52     */
  53     com::sun::star::reflection::XTypeDescription getType();
  54
  55     /** Returns true, if the parameter is declared as [in] or [inout] in IDL.
  56
  57         @return
  58                 true, if declared [in] or [inout] parameter
  59     */
  60     boolean isIn();
  61
  62     /** Returns true, if the parameter is declared as [out] or [inout] in IDL.
  63
  64         @return
  65                 true, if declared [out] or [inout] parameter
  66     */
  67     boolean isOut();
  68
  69     /** Returns the position of the parameter regarding the IDL method declaration.
  70
  71         @return
  72                 position of the parameter
  73     */
  74     long getPosition();
  75 };
  76
  77
  78 }; }; }; };
  79
  80 #endif
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */