1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_script_XStarBasicLibraryInfo_idl__
24#define __com_sun_star_script_XStarBasicLibraryInfo_idl__
25
26#ifndef __com_sun_star_container_XNameContainer_idl__
27#include <com/sun/star/container/XNameContainer.idl>
28#endif
29
30//=============================================================================
31
32 module com {  module sun {  module star {  module script {
33
34//=============================================================================
35
36/** Interface representing a library and provides access to its modules
37
38	@deprecated
39 */
40published interface XStarBasicLibraryInfo: com::sun::star::uno::XInterface
41{
42	//-------------------------------------------------------------------------
43	/** returns the library's name
44	 */
45	string getName();
46
47	//-------------------------------------------------------------------------
48	/** returns
49		the module container giving access to the modules stored in the library.
50		The container has to be returned in any case, no matter if the library is
51		stored embedded, external, or linked.
52
53		@see getExternalSourceURL
54		@see getLinkTargetURL
55	 */
56	com::sun::star::container::XNameContainer getModuleContainer();
57
58	//-------------------------------------------------------------------------
59	/** returns
60		the dialog container giving access to the dialogs stored in the library.
61		The container has to be returned in any case, no matter if the library is
62		stored embedded, external, or linked.
63
64		@see getExternalSourceURL
65		@see getLinkTargetURL
66	 */
67	com::sun::star::container::XNameContainer getDialogContainer();
68
69	//-------------------------------------------------------------------------
70	/** returns
71		the password, if the library is protected with one,
72		an empty string otherwise.
73	 */
74	string getPassword();
75
76	//-------------------------------------------------------------------------
77	/** returns an
78		URL describing the location where the library is stored if the library
79		is stored seperately (for example not in the main XML file but in a
80		special library format file), an empty string otherwise.
81		This information can be useful to optimize the access to the library,
82		e.g., for loading on demand.
83	 */
84	string getExternalSourceURL();
85
86	//-------------------------------------------------------------------------
87	/** returns an
88		URL describing the location of the library linked to.
89
90		<p>HINT: This method can be removed when there is a generic interface
91		for linking. Then the implementation will simply support this
92		"XLinked" interface and it can be checked by queryInterface().</p>
93	 */
94	string getLinkTargetURL();
95
96};
97
98//=============================================================================
99
100}; }; }; };
101
102#endif
103