/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed * with this work for additional information regarding copyright * ownership. The ASF licenses this file to you under the Apache * License, Version 2.0 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . */ #ifndef __com_sun_star_script_vba_XVBAEventProcessor_idl__ #define __com_sun_star_script_vba_XVBAEventProcessor_idl__ #include #include #include module com { module sun { module star { module script { module vba { /** Executes VBA event handlers. */ interface XVBAEventProcessor { /** Returns whether a VBA event handler exists. @param nEventId The identifier of the event. Must be a constant from VBAEventId. @param aArgs Additional arguments needed to identify some event handlers, e.g. a sheet index for spreadsheet events. @return `TRUE`, if the VBA event handler exists. `FALSE`, for all other cases. **/ boolean hasVbaEventHandler( [in] long nEventId, [in] sequence< any > aArgs ) raises (::com::sun::star::lang::IllegalArgumentException); /** Executes a VBA event handler. @param nEventId The identifier of the event. Must be a constant from VBAEventId. @param aArgs The input arguments needed to create the argument list of the VBA event handler. @return `TRUE`, if event handing is enabled, and the event handler macro exists and has been invoked. @throws ::com::sun::star::lang::IllegalArgumentException if the passed event identifier is not supported, or if the passed arguments do not conform to the arguments expected by the specified event. @throws ::com::sun::star::util::VetoException if the VBA event handler has indicated to veto the event. **/ boolean processVbaEvent( [in] long nEventId, [in] sequence< any > aArgs ) raises (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::util::VetoException); }; }; }; }; }; }; #endif /* vim:set shiftwidth=4 softtabstop=4 expandtab: */