xref: /trunk/main/udkapi/com/sun/star/script/InvocationInfo.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * 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_script_InvocationInfo_idl__
#define __com_sun_star_script_InvocationInfo_idl__

#ifndef __com_sun_star_script_MemberType_idl__
#include <com/sun/star/script/MemberType.idl>
#endif

#ifndef __com_sun_star_reflection_ParamMode_idl__
#include <com/sun/star/reflection/ParamMode.idl>
#endif

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

 module com {  module sun {  module star {  module script {

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

/**
    This struct is used to specify information about object members
    (methods or properties) accessed via XInvocation, such as names,
    types, or parameters.
    </p>
 */
published struct InvocationInfo
{

    /** Name of the method or property.
     */
    string aName;

    /** Kind of the member (method or property).
     */
    MemberType eMemberType;

    /** Only for property members:
        This field may contain zero or more constants of the
        <type scope="com::sun::star::beans">PropertyAttribute</type>
        constants group. It is not guaranteed that all necessary
        constants are set to describe the property completely,
        but a flag will only be set, if the corresponding charac-
        teristic really exists. Example: If the READONLY flag
        is set, the property is readonly. If it isn't set, the
        property nevertheless can be readonly.

        For methods this field is irrelevant and is set to 0.
     */
    short PropertyAttribute;

    /** Type of the member, for methods the return type
     */
    type aType;

    /** Types method parameters, for properties this sequence is empty
     */
    sequence< type > aParamTypes;

    /** Mode of method parameters (IN, OUT, INOUT),
        for properties this sequence is empty.
     */
    sequence< com::sun::star::reflection::ParamMode > aParamModes;
};

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

}; }; }; };

#endif