xref: /trunk/main/udkapi/com/sun/star/reflection/XMethodParameter.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_reflection_XMethodParameter_idl__
#define __com_sun_star_reflection_XMethodParameter_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_reflection_XTypeDescription_idl__
#include <com/sun/star/reflection/XTypeDescription.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module reflection {

//=============================================================================

/** Reflects a method parameter.

    <p>This type is superseded by <type>XParameter</type>, which supports
    parameters of service constructors as well as parameters of interface
    methods.</p>

    @see XInterfaceMethodTypeDescription
*/
published interface XMethodParameter: com::sun::star::uno::XInterface
{
	/** Returns the name of the parameter

        @return
                name of parameter
    */
	string getName();

	/** Returns the type of the parameter.

        @return
                type of parameter
    */
	com::sun::star::reflection::XTypeDescription getType();

	/** Returns true, if the parameter is declared as [in] or [inout] in IDL.

        @return
                true, if declared [in] or [inout] parameter
    */
	boolean isIn();

	/** Returns true, if the parameter is declared as [out] or [inout] in IDL.

        @return
                true, if declared [out] or [inout] parameter
    */
	boolean isOut();

	/** Returns the position of the parameter regarding the IDL method declaration.

        @return
                position of the parameter
    */
	long getPosition();
};

//=============================================================================

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif