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_XStarBasicAccess_idl__
24#define __com_sun_star_script_XStarBasicAccess_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 XStarBasicAccess: com::sun::star::uno::XInterface
41{
42	//-------------------------------------------------------------------------
43	/** returns
44		the library container giving access to the libraries stored in a document
45		or basic library file.
46	 */
47	com::sun::star::container::XNameContainer getLibraryContainer();
48
49	//-------------------------------------------------------------------------
50	/**
51		Creates an empty library. This method can be called alternatively to
52		accessing directly the NameContainer returned by getLibraryContainer.
53		By using this method together with addModule and addStarBasicDialog
54		the caller does not have to implement XStarBasicLibraryInfo, XModuleInfo,
55		and XStarBasicDialogInfo
56	 */
57	void createLibrary( [in] string LibName, [in] string Password,
58						[in] string ExternalSourceURL, [in] string LinkTargetURL )
59		raises( com::sun::star::container::ElementExistException );
60
61	//-------------------------------------------------------------------------
62	/**
63		Adds a module to an existing (e.g., created by createLibrary) library.
64		By using this method together with createLibrary the caller does not have
65		to implement XStarBasicLibraryInfo and XModuleInfo.
66
67		@throws  NoSuchElementException
68		if the library doesn't exist.
69	 */
70	void addModule( [in] string LibraryName, [in] string ModuleName,
71					[in] string Language, [in] string Source )
72		raises( com::sun::star::container::NoSuchElementException );
73
74	//-------------------------------------------------------------------------
75	/**
76		Adds an old style basic dialog (SI controls) to an existing (e.g., created
77		by createLibrary) library.
78		By using this method together with createLibrary the caller does not have
79		to implement XStarBasicLibraryInfo and XStarBasicDialogInfo
80
81		@throws  NoSuchElementException
82		if the library doesn't exist.
83	 */
84	void addDialog( [in] string LibraryName, [in] string DialogName,
85					[in] sequence< byte > Data )
86		raises( com::sun::star::container::NoSuchElementException );
87
88};
89
90//=============================================================================
91
92}; }; }; };
93
94#endif
95