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
  20
  21
  22  module com {  module sun {  module star {  module script {
  23
  24 /** provides access to additional scripting code.
  25
  26     <p>This code is organized in modules and these modules contain
  27     the functions. It is possible to get just the code from a function,
  28     but you can also get the whole code of a module with all functions in it.</p>
  29     @deprecated
  30  */
  31 published interface XLibraryAccess: com::sun::star::uno::XInterface
  32 {
  33     /** returns `TRUE`, if the function is accessible through this library;
  34         otherwise it returns `FALSE`.
  35
  36                 @param aFunctionName
  37                 the fully qualified name of a function.
  38                 (e.g., "UtilLibrary.ModuleDate.FunctionCurrentDate")
  39      */
  40     boolean isFunction( [in] string aFunctionName );
  41
  42     /** returns `TRUE` if a fully qualified function name begins with this name.
  43
  44                 @param aPathName
  45                 a part of a function name (e.g., "UtilLibrary").
  46      */
  47     boolean isValidPath( [in] string aPathName );
  48
  49     /** Return all module names which contain code.
  50          e.g., { "UtilLibrary.ModuleDate", "UtilLibrary.Output", ... }
  51      */
  52     sequence<string> getModuleNames();
  53
  54     /** get the source code of a module.
  55      */
  56     string getModuleSource( [in] string aModulName );
  57
  58     /** Get the whole compiled code of a module.
  59
  60         @param aModuleName the full qualified name of a module.
  61                             (e.g., "UtilLibrary.ModuleDate")
  62         @return         an empty sequence, if this module is not found or the
  63                             code is not compiled.
  64      */
  65     sequence<byte> getModuleCode( [in] string aModuleName );
  66
  67     /** get the source code of a function.
  68      */
  69     string getFunctionSource( [in] string aFunctionName );
  70
  71     /** Get the compiled code of a function.
  72
  73         @param FunctionName the full qualified name of a function.
  74                             (e.g., "UtilLibrary.ModuleDate.Function.CurrentDate")
  75         @return         an empty sequence, if this function is not found.
  76      */
  77     sequence<byte> getFunctionCode( [in] string FunctionName );
  78
  79 };
  80
  81
  82 }; }; }; };
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */