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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XPersistentLibraryContainer.idl,v $
* $Revision: 1.5 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_script_XPersistentLibraryContainer_idl__
#define __com_sun_star_script_XPersistentLibraryContainer_idl__
#ifndef __com_sun_star_util_XModifiable_idl__
#include <com/sun/star/util/XModifiable.idl>
#endif
#ifndef __com_sun_star_script_XLibraryContainer2_idl__
#include <com/sun/star/script/XLibraryContainer2.idl>
#endif
#ifndef __com_sun_star_lang_WrappedTargetException_idl__
#include <com/sun/star/lang/WrappedTargetException.idl>
#endif
//=============================================================================
module com { module sun { module star { module script {
//=============================================================================
/** describes a container of script libraries which is persistent.
<p>The type of persistence of the container elements is not defined here,
but in derived interfaces or services using
<code>XPersistentLibraryContainer</code>.</p>
<p>The actual libraries are stored in some object - a sub folder, or a sub storage,
for example - below the root location.</p>
@since OOo 2.3
*/
interface XPersistentLibraryContainer
{
interface ::com::sun::star::util::XModifiable;
interface XLibraryContainer2;
/** denotes the root location associated with the container.
<p>The type of this location - it might be a folder in a file system,
a storage, or anything else - is not specified here, but in derived interfaces
or services implementing <code>XPersistentLibraryContainer</code>.</p>
<p>All operations of the library container take place in a location below
the root location, the so-called container location, whose
name is exposed as <member>ContainerLocationName</member>.</p>
@see ContainerLocationName
*/
[attribute, readonly] any RootLocation;
/** denotes the name of the sub location where the container elements are
actually stored.
@see RootLocation
*/
[attribute, readonly] string ContainerLocationName;
/** stores the libraries to the current location.
@throws ::com::sun::star::lang::WrappedTargetException
if an error occurs during storing.
@see RootLocation
@see ContainerLocationName
*/
void storeLibraries()
raises ( ::com::sun::star::lang::WrappedTargetException );
};
//=============================================================================
}; }; }; };
//=============================================================================
#endif
|
