udkapi/com/sun/star/script/XLibraryAccess.idl

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