summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/script/XStarBasicLibraryInfo.idl
blob: c1630d6f4785d98d6b3da5d1ec3ef8ed130fa9d4 (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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
/*************************************************************************
 *
 *  $RCSfile: XStarBasicLibraryInfo.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_script_XStarBasicLibraryInfo_idl__
#define __com_sun_star_script_XStarBasicLibraryInfo_idl__

#ifndef __com_sun_star_container_XNameContainer_idl__
#include <com/sun/star/container/XNameContainer.idl>
#endif


//=============================================================================

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

//=============================================================================

/** Interface representing a library and provides access to its modules
 */
interface XStarBasicLibraryInfo: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** @returns
        The library's name
     */
    string getName();

    //-------------------------------------------------------------------------
    /** @returns
        The module container giving access to the modules stored in the library.
        The container has to be returned in any case, no matter if the library is
        stored embedded, external, or linked.

        @see getExternalSourceURL
        @see getLinkTargetURL
     */
    com::sun::star::container::XNameContainer getModuleContainer();

    //-------------------------------------------------------------------------
    /** @returns
        The dialog container giving access to the dialogs stored in the library.
        The container has to be returned in any case, no matter if the library is
        stored embedded, external, or linked.

        @see getExternalSourceURL
        @see getLinkTargetURL
     */
    com::sun::star::container::XNameContainer getDialogContainer();

    //-------------------------------------------------------------------------
    /** @returns
        The password, if the library is protected with one,
        an empty string otherwise.
     */
    string getPassword();

    //-------------------------------------------------------------------------
    /** @returns
        URL describing the location where the library is stored if the library
        is stored seperately (for example not in the main XML file but in a
        special library format file), an empty string otherwise.
        This information can be useful to optimize the access to the library,
        e.g., for loading on demand.
     */
    string getExternalSourceURL();

    //-------------------------------------------------------------------------
    /** @returns
        URL describing the location of the library linked to.

        HINT: This method can be removed when there is a generic interface
        for linking. Then the implementation will simply support this
        "XLinked" interface and it can be checked by queryInterface().
     */
    string getLinkTargetURL();

};

//=============================================================================

}; }; }; };

#endif