1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_script_XLibraryAccess_idl__ 28#define __com_sun_star_script_XLibraryAccess_idl__ 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34 35//============================================================================= 36 37 module com { module sun { module star { module script { 38 39//============================================================================= 40/** provides access to additional scripting code. 41 42 <p>This code is organized in modules and these modules contain 43 the functions. It is possible to get just the code from a function, 44 but you can also get the whole code of a module with all functions in it.</p> 45 @deprecated 46 */ 47published interface XLibraryAccess: com::sun::star::uno::XInterface 48{ 49 //------------------------------------------------------------------------- 50 /** returns <TRUE/>, if the function is accessible through this library; 51 otherwise it returns <FALSE/>. 52 53 @param aFunctionName 54 the fully qualified name of a funtion. 55 (e.g., "UtilLibrary.ModuleDate.FunctionCurrentDate") 56 */ 57 boolean isFunction( [in] string aFunctionName ); 58 59 //------------------------------------------------------------------------- 60 /** returns <TRUE/> if a fully qualified function name begins with this name. 61 62 @param aPathName 63 a part of a function name (e.g., "UtilLibrary"). 64 */ 65 boolean isValidPath( [in] string aPathName ); 66 67 //------------------------------------------------------------------------- 68 /** Return all module names which contain code. 69 e.g., { "UtilLibrary.ModuleDate", "UtilLibrary.Output", ... } 70 */ 71 sequence<string> getModuleNames(); 72 73 //------------------------------------------------------------------------- 74 /** get the source code of a module. 75 */ 76 string getModuleSource( [in] string aModulName ); 77 78 //------------------------------------------------------------------------- 79 /** Get the hole compiled code of a module. 80 81 @param ModuleName the full qualified name of a module. 82 (e.g., "UtilLibrary.ModuleDate") 83 @return an empty sequence, if this module is not found or the 84 code is not compiled. 85 */ 86 sequence<byte> getModuleCode( [in] string aModuleName ); 87 88 //------------------------------------------------------------------------- 89 /** get the source code of a function. 90 */ 91 string getFunctionSource( [in] string aFunctionName ); 92 93 //------------------------------------------------------------------------- 94 /** Get the compiled code of a function. 95 96 @param FunctionName the full qualified name of a function. 97 (e.g., "UtilLibrary.ModuleDate.Function.CurrentDate") 98 @return an empty sequence, if this function is not found. 99 */ 100 sequence<byte> getFunctionCode( [in] string FunctionName ); 101 102}; 103 104//============================================================================= 105 106}; }; }; }; 107 108#endif 109