| /************************************************************** |
| * |
| * 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 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef __com_sun_star_script_vba_XVBAMacroResolver_idl__ |
| #define __com_sun_star_script_vba_XVBAMacroResolver_idl__ |
| |
| #include <com/sun/star/lang/IllegalArgumentException.idl> |
| |
| //============================================================================= |
| |
| module com { module sun { module star { module script { module vba { |
| |
| //============================================================================= |
| |
| /** Converts VBA macro names to script URLs and vice versa. |
| */ |
| interface XVBAMacroResolver |
| { |
| //------------------------------------------------------------------------- |
| |
| /** Returns the script URL representing the passed VBA macro name. |
| |
| @param aVBAMacroName |
| The VBA macro name to be resolved to a script URL. The macro name |
| may consist of up to three parts, divided by periods. The first two |
| parts are optional. The first part represents the VBA project name. |
| The second part represents the module name. The third part |
| represents the procedure name. Example: All the VBA macro names |
| "VBAProject.Module1.TestMacro", "Module1.TestMacro", |
| "VBAProject.TestMacro", and "TestMacro" may refer to the same VBA |
| procedure located in "Module" of the project "VBAProject". If the |
| module name is missing, then all modules are searched for a macro |
| with the specified name. |
| |
| @return |
| The script URL referring to the passed VBA macro. |
| |
| @throws <type scope="::com::sun::star::lang">IllegalArgumentException</type> |
| if a macro with the passed name does not exist. |
| **/ |
| string resolveVBAMacroToScriptURL( [in] string aVBAMacroName ) |
| raises (::com::sun::star::lang::IllegalArgumentException); |
| |
| //------------------------------------------------------------------------- |
| |
| /** Returns the VBA macro name for a macro with the passed script URL. |
| |
| @param aScriptURL |
| The script URL to be resolved to a VBA macro name. Must be a |
| document-local script. |
| |
| @return |
| The VBA macro name referring to a macro with the passed script URL. |
| |
| @throws <type scope="::com::sun::star::lang">IllegalArgumentException</type> |
| if a macro with the passed name does not exist. |
| **/ |
| string resolveScriptURLtoVBAMacro( [in] string aScriptURL ) |
| raises (::com::sun::star::lang::IllegalArgumentException); |
| |
| //------------------------------------------------------------------------- |
| }; |
| |
| //============================================================================= |
| |
| }; }; }; }; }; |
| |
| //============================================================================= |
| |
| #endif |