summaryrefslogtreecommitdiffstats
path: root/udkapi/com/sun/star/script/XStarBasicAccess.idl
blob: 7f9581dc893c316481a4091e798f621c479c8e91 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */


 module com {  module sun {  module star {  module script {


/** Interface representing a library and provides access to its modules

    @deprecated
 */
published interface XStarBasicAccess: com::sun::star::uno::XInterface
{
    /** returns
        the library container giving access to the libraries stored in a document
        or basic library file.
     */
    com::sun::star::container::XNameContainer getLibraryContainer();

    /**
        Creates an empty library. This method can be called alternatively to
        accessing directly the NameContainer returned by getLibraryContainer.
        By using this method together with addModule and addStarBasicDialog
        the caller does not have to implement XStarBasicLibraryInfo, XModuleInfo,
        and XStarBasicDialogInfo
     */
    void createLibrary( [in] string LibName, [in] string Password,
                        [in] string ExternalSourceURL, [in] string LinkTargetURL )
        raises( com::sun::star::container::ElementExistException );

    /**
        Adds a module to an existing (e.g., created by createLibrary) library.
        By using this method together with createLibrary the caller does not have
        to implement XStarBasicLibraryInfo and XModuleInfo.

        @throws  NoSuchElementException
        if the library doesn't exist.
     */
    void addModule( [in] string LibraryName, [in] string ModuleName,
                    [in] string Language, [in] string Source )
        raises( com::sun::star::container::NoSuchElementException );

    /**
        Adds an old style basic dialog (SI controls) to an existing (e.g., created
        by createLibrary) library.
        By using this method together with createLibrary the caller does not have
        to implement XStarBasicLibraryInfo and XStarBasicDialogInfo

        @throws  NoSuchElementException
        if the library doesn't exist.
     */
    void addDialog( [in] string LibraryName, [in] string DialogName,
                    [in] sequence< byte > Data )
        raises( com::sun::star::container::NoSuchElementException );

};


}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */