/************************************************************************* * * $RCSfile: XLibraryAccess.idl,v $ * * $Revision: 1.5 $ * * last change: $Author: mi $ $Date: 2000-12-19 13:49:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (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.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef __com_sun_star_script_XLibraryAccess_idl__ #define __com_sun_star_script_XLibraryAccess_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include #endif //============================================================================= module com { module sun { module star { module script { //============================================================================= // DocMerge from xml: interface com::sun::star::script::XLibraryAccess /** provides access to additional scripting code.

This code is organized in modules and these modules contain the functions. It is possible to get just the code from a function, but you can also get the whole code of a module with all functions in it.

*/ [ uik(E227A3C4-33D6-11D1-AABE00A0-249D5590), ident( "XLibraryAccess", 1.0 ) ] interface XLibraryAccess: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- // DocMerge from idl: method com::sun::star::script::XLibraryAccess::isFunction /** @returns , if the function is accessible through this library; otherwise it returns . @param aFunctionName the full qualified name of a funtion. (e.g.: "UtilLibrary.ModuleDate.FunctionCurrentDate") */ boolean isFunction( [in] string aFunctionName ); //------------------------------------------------------------------------- // DocMerge from idl: method com::sun::star::script::XLibraryAccess::isValidPath /** @returns if a full qualified function name begins with this name. @param aPathName a part of a function name (e.g.: "UtilLibrary"). */ boolean isValidPath( [in] string aPathName ); //------------------------------------------------------------------------- // DOCUMENTATION CHANGED FOR XLibraryAccess::getModuleNames // DocMerge from idl: method com::sun::star::script::XLibraryAccess::getModuleNames /** * Return all module names which contain code. * e.g.: { "UtilLibrary.ModuleDate", "UtilLibrary.Output", ... } */ sequence getModuleNames(); //------------------------------------------------------------------------- // DOCUMENTATION CHANGED FOR XLibraryAccess::getModuleSource // DocMerge from xml: method com::sun::star::script::XLibraryAccess::getModuleSource /** get the source code of a module. */ string getModuleSource( [in] string aModulName ); //------------------------------------------------------------------------- // DOCUMENTATION CHANGED FOR XLibraryAccess::getModuleCode // DocMerge from idl: method com::sun::star::script::XLibraryAccess::getModuleCode /** * Get the hole compiled code of a module. * * @param ModuleName the full qualified name of a module. * (e.g.: "UtilLibrary.ModuleDate") * @return an empty sequence, if this module is not found or the * code is not compiled. */ sequence getModuleCode( [in] string aModuleName ); //------------------------------------------------------------------------- // DOCUMENTATION CHANGED FOR XLibraryAccess::getFunctionSource // DocMerge from xml: method com::sun::star::script::XLibraryAccess::getFunctionSource /** get the source code of a function. */ string getFunctionSource( [in] string aFunctionName ); //------------------------------------------------------------------------- // DOCUMENTATION CHANGED FOR XLibraryAccess::getFunctionCode // DocMerge from idl: method com::sun::star::script::XLibraryAccess::getFunctionCode /** * Get the compiled code of a function. * * @param FunctionName the full qualified name of a function. * (e.g.: "UtilLibrary.ModuleDate.Function.CurrentDate") * @return an empty sequence, if this function is not found. */ sequence getFunctionCode( [in] string FunctionName ); }; //============================================================================= }; }; }; }; /*============================================================================= $Log: not supported by cvs2svn $ Revision 1.4 2000/11/08 12:28:52 mi moved from api Revision 1.1.1.1 2000/09/18 23:35:36 hjs initial import Revision 1.6 2000/09/11 11:52:39 mi documentation merged from XML Revision 1.4 2000/04/20 14:14:36 mm #74031# better documentation Revision 1.3 2000/02/23 11:41:17 mi results from proofreading in layouted version Revision 1.2 2000/02/07 11:24:51 mi zu #70728# missing documentation marked Revision 1.1.1.1 1999/11/11 09:48:45 jsc new =============================================================================*/ #endif