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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_script_XLibraryAccess_idl__
  20 #define __com_sun_star_script_XLibraryAccess_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25
  26  module com {  module sun {  module star {  module script {
  27
  28 /** provides access to additional scripting code.
  29
  30     <p>This code is organized in modules and these modules contain
  31     the functions. It is possible to get just the code from a function,
  32     but you can also get the whole code of a module with all functions in it.</p>
  33     @deprecated
  34  */
  35 published interface XLibraryAccess: com::sun::star::uno::XInterface
  36 {
  37     /** returns `TRUE`, if the function is accessible through this library;
  38         otherwise it returns `FALSE`.
  39
  40                 @param aFunctionName
  41                 the fully qualified name of a function.
  42                 (e.g., "UtilLibrary.ModuleDate.FunctionCurrentDate")
  43      */
  44     boolean isFunction( [in] string aFunctionName );
  45
  46     /** returns `TRUE` if a fully qualified function name begins with this name.
  47
  48                 @param aPathName
  49                 a part of a function name (e.g., "UtilLibrary").
  50      */
  51     boolean isValidPath( [in] string aPathName );
  52
  53     /** Return all module names which contain code.
  54          e.g., { "UtilLibrary.ModuleDate", "UtilLibrary.Output", ... }
  55      */
  56     sequence<string> getModuleNames();
  57
  58     /** get the source code of a module.
  59      */
  60     string getModuleSource( [in] string aModulName );
  61
  62     /** Get the hole compiled code of a module.
  63
  64         @param aModuleName the full qualified name of a module.
  65                             (e.g., "UtilLibrary.ModuleDate")
  66         @return         an empty sequence, if this module is not found or the
  67                             code is not compiled.
  68      */
  69     sequence<byte> getModuleCode( [in] string aModuleName );
  70
  71     /** get the source code of a function.
  72      */
  73     string getFunctionSource( [in] string aFunctionName );
  74
  75     /** Get the compiled code of a function.
  76
  77         @param FunctionName the full qualified name of a function.
  78                             (e.g., "UtilLibrary.ModuleDate.Function.CurrentDate")
  79         @return         an empty sequence, if this function is not found.
  80      */
  81     sequence<byte> getFunctionCode( [in] string FunctionName );
  82
  83 };
  84
  85
  86 }; }; }; };
  87
  88 #endif
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */