1*408a4873SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*408a4873SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*408a4873SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*408a4873SAndrew Rist * distributed with this work for additional information 6*408a4873SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*408a4873SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*408a4873SAndrew Rist * "License"); you may not use this file except in compliance 9*408a4873SAndrew Rist * with the License. You may obtain a copy of the License at 10*408a4873SAndrew Rist * 11*408a4873SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*408a4873SAndrew Rist * 13*408a4873SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*408a4873SAndrew Rist * software distributed under the License is distributed on an 15*408a4873SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*408a4873SAndrew Rist * KIND, either express or implied. See the License for the 17*408a4873SAndrew Rist * specific language governing permissions and limitations 18*408a4873SAndrew Rist * under the License. 19*408a4873SAndrew Rist * 20*408a4873SAndrew Rist *************************************************************/ 21*408a4873SAndrew Rist 22*408a4873SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_script_XInvocation_idl__ 24cdf0e10cSrcweir#define __com_sun_star_script_XInvocation_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_beans_XIntrospectionAccess_idl__ 31cdf0e10cSrcweir#include <com/sun/star/beans/XIntrospectionAccess.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 35cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_script_CannotConvertException_idl__ 39cdf0e10cSrcweir#include <com/sun/star/script/CannotConvertException.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef __com_sun_star_reflection_InvocationTargetException_idl__ 43cdf0e10cSrcweir#include <com/sun/star/reflection/InvocationTargetException.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir#ifndef __com_sun_star_beans_UnknownPropertyException_idl__ 47cdf0e10cSrcweir#include <com/sun/star/beans/UnknownPropertyException.idl> 48cdf0e10cSrcweir#endif 49cdf0e10cSrcweir 50cdf0e10cSrcweir 51cdf0e10cSrcweir//============================================================================= 52cdf0e10cSrcweir 53cdf0e10cSrcweir module com { module sun { module star { module script { 54cdf0e10cSrcweir 55cdf0e10cSrcweir//============================================================================= 56cdf0e10cSrcweir/** gives access to an object's methods and properties. 57cdf0e10cSrcweir Container access is available through 58cdf0e10cSrcweir <type scope="com::sun::star::container">XIndexContainer</type>, 59cdf0e10cSrcweir <type scope="com::sun::star::container">XNameContainer</type> and 60cdf0e10cSrcweir <type scope="com::sun::star::container">XEnumerationAccess</type>. 61cdf0e10cSrcweir </p> 62cdf0e10cSrcweir */ 63cdf0e10cSrcweirpublished interface XInvocation: com::sun::star::uno::XInterface 64cdf0e10cSrcweir{ 65cdf0e10cSrcweir //------------------------------------------------------------------------- 66cdf0e10cSrcweir /** returns the introspection from this object or <NULL/> 67cdf0e10cSrcweir if the object does not provide this information. 68cdf0e10cSrcweir */ 69cdf0e10cSrcweir com::sun::star::beans::XIntrospectionAccess getIntrospection(); 70cdf0e10cSrcweir 71cdf0e10cSrcweir //------------------------------------------------------------------------- 72cdf0e10cSrcweir /** provides access to methods exposed by an object. 73cdf0e10cSrcweir 74cdf0e10cSrcweir @param aParams all parameters; pure out params are undefined in sequence, 75cdf0e10cSrcweir the value has to be ignored by the callee 76cdf0e10cSrcweir @param aOutParamIndex This sequence contains the indices of all parameters 77cdf0e10cSrcweir that are specified as out or inout. 78cdf0e10cSrcweir @param aOutParam This sequence contains the values of all parameters that 79cdf0e10cSrcweir are specified as out or inout and corresponds with the 80cdf0e10cSrcweir indices provided by the aOutParamIndex sequence. 81cdf0e10cSrcweir 82cdf0e10cSrcweir Example: aOutParamIndex == { 1, 4 } means that 83cdf0e10cSrcweir aOutParam[0] contains the out value of the aParams[1] 84cdf0e10cSrcweir parameter and aOutParam[1] contains the out value of 85cdf0e10cSrcweir the aParams[4] parameter. 86cdf0e10cSrcweir */ 87cdf0e10cSrcweir any invoke( [in] string aFunctionName, 88cdf0e10cSrcweir [in] sequence<any> aParams, 89cdf0e10cSrcweir [out] sequence<short> aOutParamIndex, 90cdf0e10cSrcweir [out] sequence<any> aOutParam ) 91cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException, 92cdf0e10cSrcweir com::sun::star::script::CannotConvertException, 93cdf0e10cSrcweir com::sun::star::reflection::InvocationTargetException ); 94cdf0e10cSrcweir 95cdf0e10cSrcweir //------------------------------------------------------------------------- 96cdf0e10cSrcweir /** sets a value to the property with the specified name. 97cdf0e10cSrcweir 98cdf0e10cSrcweir <p> If the underlying object implements an 99cdf0e10cSrcweir <type scope="com::sun::star::container">XNameContainer</type>, 100cdf0e10cSrcweir then this method will insert the value if there is no such 101cdf0e10cSrcweir <var>aPropertyName</var>. 102cdf0e10cSrcweir 103cdf0e10cSrcweir </p> 104cdf0e10cSrcweir */ 105cdf0e10cSrcweir void setValue( [in] string aPropertyName, 106cdf0e10cSrcweir [in] any aValue ) 107cdf0e10cSrcweir raises( com::sun::star::beans::UnknownPropertyException, 108cdf0e10cSrcweir com::sun::star::script::CannotConvertException, 109cdf0e10cSrcweir com::sun::star::reflection::InvocationTargetException ); 110cdf0e10cSrcweir 111cdf0e10cSrcweir //------------------------------------------------------------------------- 112cdf0e10cSrcweir /** returns the value of the property with the specified name. 113cdf0e10cSrcweir 114cdf0e10cSrcweir @param aPropertyName 115cdf0e10cSrcweir specifies the name of the property. 116cdf0e10cSrcweir */ 117cdf0e10cSrcweir any getValue( [in] string aPropertyName ) 118cdf0e10cSrcweir raises( com::sun::star::beans::UnknownPropertyException ); 119cdf0e10cSrcweir 120cdf0e10cSrcweir //------------------------------------------------------------------------- 121cdf0e10cSrcweir /** returns <TRUE/> if the method with the specified name exists, else <FALSE/>. 122cdf0e10cSrcweir 123cdf0e10cSrcweir <p>This optimizes the calling sequence 124cdf0e10cSrcweir ( <member>XInvocation::hasMethod</member>, 125cdf0e10cSrcweir <member>XInvocation::invoke</member> )!</p> 126cdf0e10cSrcweir 127cdf0e10cSrcweir @param aName 128cdf0e10cSrcweir specifies the name of the method. 129cdf0e10cSrcweir */ 130cdf0e10cSrcweir boolean hasMethod( [in] string aName ); 131cdf0e10cSrcweir 132cdf0e10cSrcweir //------------------------------------------------------------------------- 133cdf0e10cSrcweir /** returns <TRUE/> if the property with the specified name exists, else <FALSE/>. 134cdf0e10cSrcweir 135cdf0e10cSrcweir <p>This optimizes the calling sequence 136cdf0e10cSrcweir ( <member>XInvocation::hasProperty</member>, 137cdf0e10cSrcweir <member>XInvocation::getValue</member> ) or 138cdf0e10cSrcweir 139cdf0e10cSrcweir ( <member>XInvocation::hasProperty</member>, 140cdf0e10cSrcweir <member>XInvocation::setValue</member> )! 141cdf0e10cSrcweir 142cdf0e10cSrcweir @param aName 143cdf0e10cSrcweir specifies the name of the property. 144cdf0e10cSrcweir */ 145cdf0e10cSrcweir boolean hasProperty( [in] string aName ); 146cdf0e10cSrcweir 147cdf0e10cSrcweir}; 148cdf0e10cSrcweir 149cdf0e10cSrcweir//============================================================================= 150cdf0e10cSrcweir 151cdf0e10cSrcweir}; }; }; }; 152cdf0e10cSrcweir 153cdf0e10cSrcweir#endif 154