merged tag ooo/OOO330_m14
[LibreOffice.git] / udkapi / com / sun / star / script / XStarBasicLibraryInfo.idl
blob4b7337a0b33cf000d3b7e2c5cd3ddb58e866fdfc
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * This file is part of OpenOffice.org.
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org. If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
26 ************************************************************************/
27 #ifndef __com_sun_star_script_XStarBasicLibraryInfo_idl__
28 #define __com_sun_star_script_XStarBasicLibraryInfo_idl__
30 #ifndef __com_sun_star_container_XNameContainer_idl__
31 #include <com/sun/star/container/XNameContainer.idl>
32 #endif
34 //=============================================================================
36 module com { module sun { module star { module script {
38 //=============================================================================
40 /** Interface representing a library and provides access to its modules
42 @deprecated
44 published interface XStarBasicLibraryInfo: com::sun::star::uno::XInterface
46 //-------------------------------------------------------------------------
47 /** returns the library's name
49 string getName();
51 //-------------------------------------------------------------------------
52 /** returns
53 the module container giving access to the modules stored in the library.
54 The container has to be returned in any case, no matter if the library is
55 stored embedded, external, or linked.
57 @see getExternalSourceURL
58 @see getLinkTargetURL
60 com::sun::star::container::XNameContainer getModuleContainer();
62 //-------------------------------------------------------------------------
63 /** returns
64 the dialog container giving access to the dialogs stored in the library.
65 The container has to be returned in any case, no matter if the library is
66 stored embedded, external, or linked.
68 @see getExternalSourceURL
69 @see getLinkTargetURL
71 com::sun::star::container::XNameContainer getDialogContainer();
73 //-------------------------------------------------------------------------
74 /** returns
75 the password, if the library is protected with one,
76 an empty string otherwise.
78 string getPassword();
80 //-------------------------------------------------------------------------
81 /** returns an
82 URL describing the location where the library is stored if the library
83 is stored seperately (for example not in the main XML file but in a
84 special library format file), an empty string otherwise.
85 This information can be useful to optimize the access to the library,
86 e.g., for loading on demand.
88 string getExternalSourceURL();
90 //-------------------------------------------------------------------------
91 /** returns an
92 URL describing the location of the library linked to.
94 <p>HINT: This method can be removed when there is a generic interface
95 for linking. Then the implementation will simply support this
96 "XLinked" interface and it can be checked by queryInterface().</p>
98 string getLinkTargetURL();
102 //=============================================================================
104 }; }; }; };
106 #endif