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