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_XVBAMacroResolver_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_script_vba_XVBAMacroResolver_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski//============================================================================= 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module script { module vba { 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski//============================================================================= 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski/** Converts VBA macro names to script URLs and vice versa. 36*b1cdbd2cSJim Jagielski */ 37*b1cdbd2cSJim Jagielskiinterface XVBAMacroResolver 38*b1cdbd2cSJim Jagielski{ 39*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski /** Returns the script URL representing the passed VBA macro name. 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski @param aVBAMacroName 44*b1cdbd2cSJim Jagielski The VBA macro name to be resolved to a script URL. The macro name 45*b1cdbd2cSJim Jagielski may consist of up to three parts, divided by periods. The first two 46*b1cdbd2cSJim Jagielski parts are optional. The first part represents the VBA project name. 47*b1cdbd2cSJim Jagielski The second part represents the module name. The third part 48*b1cdbd2cSJim Jagielski represents the procedure name. Example: All the VBA macro names 49*b1cdbd2cSJim Jagielski "VBAProject.Module1.TestMacro", "Module1.TestMacro", 50*b1cdbd2cSJim Jagielski "VBAProject.TestMacro", and "TestMacro" may refer to the same VBA 51*b1cdbd2cSJim Jagielski procedure located in "Module" of the project "VBAProject". If the 52*b1cdbd2cSJim Jagielski module name is missing, then all modules are searched for a macro 53*b1cdbd2cSJim Jagielski with the specified name. 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski @return 56*b1cdbd2cSJim Jagielski The script URL referring to the passed VBA macro. 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski @throws <type scope="::com::sun::star::lang">IllegalArgumentException</type> 59*b1cdbd2cSJim Jagielski if a macro with the passed name does not exist. 60*b1cdbd2cSJim Jagielski **/ 61*b1cdbd2cSJim Jagielski string resolveVBAMacroToScriptURL( [in] string aVBAMacroName ) 62*b1cdbd2cSJim Jagielski raises (::com::sun::star::lang::IllegalArgumentException); 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski /** Returns the VBA macro name for a macro with the passed script URL. 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski @param aScriptURL 69*b1cdbd2cSJim Jagielski The script URL to be resolved to a VBA macro name. Must be a 70*b1cdbd2cSJim Jagielski document-local script. 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski @return 73*b1cdbd2cSJim Jagielski The VBA macro name referring to a macro with the passed script URL. 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski @throws <type scope="::com::sun::star::lang">IllegalArgumentException</type> 76*b1cdbd2cSJim Jagielski if a macro with the passed name does not exist. 77*b1cdbd2cSJim Jagielski **/ 78*b1cdbd2cSJim Jagielski string resolveScriptURLtoVBAMacro( [in] string aScriptURL ) 79*b1cdbd2cSJim Jagielski raises (::com::sun::star::lang::IllegalArgumentException); 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 82*b1cdbd2cSJim Jagielski}; 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski//============================================================================= 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski}; }; }; }; }; 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski//============================================================================= 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski#endif 91