udkapi/com/sun/star/script/XStarBasicLibraryInfo.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  module com {  module sun {  module star {  module script {
  22
  23
  24 /** Interface representing a library and provides access to its modules
  25
  26     @deprecated
  27  */
  28 published interface XStarBasicLibraryInfo: com::sun::star::uno::XInterface
  29 {
  30     /** returns the library's name
  31      */
  32     string getName();
  33
  34     /** returns
  35         the module container giving access to the modules stored in the library.
  36         The container has to be returned in any case, no matter if the library is
  37         stored embedded, external, or linked.
  38
  39         @see getExternalSourceURL
  40         @see getLinkTargetURL
  41      */
  42     com::sun::star::container::XNameContainer getModuleContainer();
  43
  44     /** returns
  45         the dialog container giving access to the dialogs stored in the library.
  46         The container has to be returned in any case, no matter if the library is
  47         stored embedded, external, or linked.
  48
  49         @see getExternalSourceURL
  50         @see getLinkTargetURL
  51      */
  52     com::sun::star::container::XNameContainer getDialogContainer();
  53
  54     /** returns
  55         the password, if the library is protected with one,
  56         an empty string otherwise.
  57      */
  58     string getPassword();
  59
  60     /** returns an
  61         URL describing the location where the library is stored if the library
  62         is stored separately (for example not in the main XML file but in a
  63         special library format file), an empty string otherwise.
  64         This information can be useful to optimize the access to the library,
  65         e.g., for loading on demand.
  66      */
  67     string getExternalSourceURL();
  68
  69     /** returns an
  70         URL describing the location of the library linked to.
  71
  72         <p>HINT: This method can be removed when there is a generic interface
  73         for linking. Then the implementation will simply support this
  74         "XLinked" interface and it can be checked by queryInterface().</p>
  75      */
  76     string getLinkTargetURL();
  77
  78 };
  79
  80
  81 }; }; }; };
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */