1*d1766043SAndrew Rist/************************************************************** 2*d1766043SAndrew Rist * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_script_vba_XVBAEventProcessor_idl__ 25cdf0e10cSrcweir#define __com_sun_star_script_vba_XVBAEventProcessor_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 29cdf0e10cSrcweir#include <com/sun/star/util/VetoException.idl> 30cdf0e10cSrcweir 31cdf0e10cSrcweir//============================================================================= 32cdf0e10cSrcweir 33cdf0e10cSrcweirmodule com { module sun { module star { module script { module vba { 34cdf0e10cSrcweir 35cdf0e10cSrcweir//============================================================================= 36cdf0e10cSrcweir 37cdf0e10cSrcweir/** Executes VBA event handlers. 38cdf0e10cSrcweir */ 39cdf0e10cSrcweirinterface XVBAEventProcessor 40cdf0e10cSrcweir{ 41cdf0e10cSrcweir //------------------------------------------------------------------------- 42cdf0e10cSrcweir 43cdf0e10cSrcweir /** Returns whether a VBA event handler exists. 44cdf0e10cSrcweir 45cdf0e10cSrcweir @param nEventId 46cdf0e10cSrcweir The identifier of the event. Must be a constant from <type>VBAEventId</type>. 47cdf0e10cSrcweir 48cdf0e10cSrcweir @param aArgs 49cdf0e10cSrcweir Additional arguments needed to identify some event handlers, e.g. a 50cdf0e10cSrcweir sheet index for spreadsheet events. 51cdf0e10cSrcweir 52cdf0e10cSrcweir @return 53cdf0e10cSrcweir <TRUE/>, if the VBA event handler exists. 54cdf0e10cSrcweir 55cdf0e10cSrcweir @throws <type scope="::com::sun::star::lang">IllegalArgumentException</type> 56cdf0e10cSrcweir if the passed event identifier is not supported, or if the passed 57cdf0e10cSrcweir specifier is required but invalid. 58cdf0e10cSrcweir **/ 59cdf0e10cSrcweir boolean hasVbaEventHandler( [in] long nEventId, [in] sequence< any > aArgs ) 60cdf0e10cSrcweir raises (::com::sun::star::lang::IllegalArgumentException); 61cdf0e10cSrcweir 62cdf0e10cSrcweir //------------------------------------------------------------------------- 63cdf0e10cSrcweir 64cdf0e10cSrcweir /** Executes a VBA event handler. 65cdf0e10cSrcweir 66cdf0e10cSrcweir @param nEventId 67cdf0e10cSrcweir The identifier of the event. Must be a constant from <type>VBAEventId</type>. 68cdf0e10cSrcweir 69cdf0e10cSrcweir @param aArgs 70cdf0e10cSrcweir The input arguments needed to create the argument list of the VBA 71cdf0e10cSrcweir event handler. 72cdf0e10cSrcweir 73cdf0e10cSrcweir @return 74cdf0e10cSrcweir <TRUE/>, if event handing is enabled, and the event handler macro 75cdf0e10cSrcweir exists and has been invoked. 76cdf0e10cSrcweir 77cdf0e10cSrcweir @throws <type scope="::com::sun::star::lang">IllegalArgumentException</type> 78cdf0e10cSrcweir if the passed event identifier is not supported, or if the passed 79cdf0e10cSrcweir arguments do not conform to the arguments expected by the specified 80cdf0e10cSrcweir event. 81cdf0e10cSrcweir 82cdf0e10cSrcweir @throws <type scope="::com::sun::star::util">VetoException</type> 83cdf0e10cSrcweir if the VBA event handler has indicated to veto the event. 84cdf0e10cSrcweir **/ 85cdf0e10cSrcweir boolean processVbaEvent( [in] long nEventId, [in] sequence< any > aArgs ) 86cdf0e10cSrcweir raises (::com::sun::star::lang::IllegalArgumentException, 87cdf0e10cSrcweir ::com::sun::star::util::VetoException); 88cdf0e10cSrcweir 89cdf0e10cSrcweir //------------------------------------------------------------------------- 90cdf0e10cSrcweir}; 91cdf0e10cSrcweir 92cdf0e10cSrcweir//============================================================================= 93cdf0e10cSrcweir 94cdf0e10cSrcweir}; }; }; }; }; 95cdf0e10cSrcweir 96cdf0e10cSrcweir//============================================================================= 97cdf0e10cSrcweir 98cdf0e10cSrcweir#endif 99