udkapi/com/sun/star/script/XStarBasicLibraryInfo.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: XStarBasicLibraryInfo.idl,v $
  10  * $Revision: 1.7 $
  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_XStarBasicLibraryInfo_idl__
  31 #define __com_sun_star_script_XStarBasicLibraryInfo_idl__
  32
  33 #ifndef __com_sun_star_container_XNameContainer_idl__
  34 #include <com/sun/star/container/XNameContainer.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module script {
  40
  41 //=============================================================================
  42
  43 /** Interface representing a library and provides access to its modules
  44
  45     @deprecated
  46  */
  47 published interface XStarBasicLibraryInfo: com::sun::star::uno::XInterface
  48 {
  49     //-------------------------------------------------------------------------
  50     /** returns the library's name
  51      */
  52     string getName();
  53
  54     //-------------------------------------------------------------------------
  55     /** returns
  56         the module container giving access to the modules stored in the library.
  57         The container has to be returned in any case, no matter if the library is
  58         stored embedded, external, or linked.
  59
  60         @see getExternalSourceURL
  61         @see getLinkTargetURL
  62      */
  63     com::sun::star::container::XNameContainer getModuleContainer();
  64
  65     //-------------------------------------------------------------------------
  66     /** returns
  67         the dialog container giving access to the dialogs stored in the library.
  68         The container has to be returned in any case, no matter if the library is
  69         stored embedded, external, or linked.
  70
  71         @see getExternalSourceURL
  72         @see getLinkTargetURL
  73      */
  74     com::sun::star::container::XNameContainer getDialogContainer();
  75
  76     //-------------------------------------------------------------------------
  77     /** returns
  78         the password, if the library is protected with one,
  79         an empty string otherwise.
  80      */
  81     string getPassword();
  82
  83     //-------------------------------------------------------------------------
  84     /** returns an
  85         URL describing the location where the library is stored if the library
  86         is stored seperately (for example not in the main XML file but in a
  87         special library format file), an empty string otherwise.
  88         This information can be useful to optimize the access to the library,
  89         e.g., for loading on demand.
  90      */
  91     string getExternalSourceURL();
  92
  93     //-------------------------------------------------------------------------
  94     /** returns an
  95         URL describing the location of the library linked to.
  96
  97         <p>HINT: This method can be removed when there is a generic interface
  98         for linking. Then the implementation will simply support this
  99         "XLinked" interface and it can be checked by queryInterface().</p>
 100      */
 101     string getLinkTargetURL();
 102
 103 };
 104
 105 //=============================================================================
 106
 107 }; }; }; };
 108
 109 #endif