1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
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.
14 *
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).
20 *
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.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_script_XStarBasicAccess_idl__
28#define __com_sun_star_script_XStarBasicAccess_idl__
29
30#ifndef __com_sun_star_container_XNameContainer_idl__
31#include <com/sun/star/container/XNameContainer.idl>
32#endif
33
34//=============================================================================
35
36 module com {  module sun {  module star {  module script {
37
38//=============================================================================
39
40/** Interface representing a library and provides access to its modules
41
42	@deprecated
43 */
44published interface XStarBasicAccess: com::sun::star::uno::XInterface
45{
46	//-------------------------------------------------------------------------
47	/** returns
48		the library container giving access to the libraries stored in a document
49		or basic library file.
50	 */
51	com::sun::star::container::XNameContainer getLibraryContainer();
52
53	//-------------------------------------------------------------------------
54	/**
55		Creates an empty library. This method can be called alternatively to
56		accessing directly the NameContainer returned by getLibraryContainer.
57		By using this method together with addModule and addStarBasicDialog
58		the caller does not have to implement XStarBasicLibraryInfo, XModuleInfo,
59		and XStarBasicDialogInfo
60	 */
61	void createLibrary( [in] string LibName, [in] string Password,
62						[in] string ExternalSourceURL, [in] string LinkTargetURL )
63		raises( com::sun::star::container::ElementExistException );
64
65	//-------------------------------------------------------------------------
66	/**
67		Adds a module to an existing (e.g., created by createLibrary) library.
68		By using this method together with createLibrary the caller does not have
69		to implement XStarBasicLibraryInfo and XModuleInfo.
70
71		@throws  NoSuchElementException
72		if the library doesn't exist.
73	 */
74	void addModule( [in] string LibraryName, [in] string ModuleName,
75					[in] string Language, [in] string Source )
76		raises( com::sun::star::container::NoSuchElementException );
77
78	//-------------------------------------------------------------------------
79	/**
80		Adds an old style basic dialog (SI controls) to an existing (e.g., created
81		by createLibrary) library.
82		By using this method together with createLibrary the caller does not have
83		to implement XStarBasicLibraryInfo and XStarBasicDialogInfo
84
85		@throws  NoSuchElementException
86		if the library doesn't exist.
87	 */
88	void addDialog( [in] string LibraryName, [in] string DialogName,
89					[in] sequence< byte > Data )
90		raises( com::sun::star::container::NoSuchElementException );
91
92};
93
94//=============================================================================
95
96}; }; }; };
97
98#endif
99