udkapi/com/sun/star/reflection/XMethodParameter.idl

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