blob: 8a26b4044bdff3804c8e51fa1084ccbf66155f2e (
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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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_ucb_PackageContentProvider_idl__
#define __com_sun_star_ucb_PackageContentProvider_idl__
#ifndef __com_sun_star_ucb_XContentProvider_idl__
#include <com/sun/star/ucb/XContentProvider.idl>
#endif
//=============================================================================
module com { module sun { module star { module ucb {
//=============================================================================
/** The Package Content Provider (PCP) implements a <type>ContentProvider</type>
for the <type>UniversalContentBroker</type> (UCB).
<p>It provides access to packages ( zip / jar archive files ) containing
folders and streams.
@see com::sun::star::ucb::Content
*/
published service PackageContentProvider
{
//-------------------------------------------------------------------------
/** provides two types of contents: Stream and Folder.
<p>
<b>PCP Contents</b>
<ol>
<li>
A PCP Stream (<type>PackageStreamContent</type>) is a content which
represents a file inside a package. It is always contained in a PCP
Folder. A PCP Stream has no children.
</li>
<li>
A PCP Folder (<type>PackageFolderContent</type>) is a container for
other PCP Folders and PCP Streams.
</li>
</ol>
<p><b>URL Scheme for PCP Contents</b>
<p>Each HCP content has an identifier corresponding to the following
scheme:
<ul>
<li>
package-URL = "vnd.sun.star.pkg://" orig-URL [ abs-path ]
</li>
<li>
abs-path = "/" path-segments
</li>
<li>
path-segements = segment *( "/" segment )
</li>
<li>
segment = pchar
</li>
<li>
pchar = unreserved | escaped | ":" | "@" | "&" | "="
| "+" | "$" | ","
</li>
<li>
unreserved = alphanum | mark
</li>
<li>
mark = "-" | "_" | "." | "!" | "~" | "*" | "'" | "(" | ")"
</li>
<li>
escaped = "%" hex hex
</li>
<li>
orig-URL = 1 *( unreserved | escaped | "$" | "," | ";"
| ":" | "@" | "&" | "&" | "=" | "+"
</li>
</ul>
<p>Examples:
<ul>
<li>
vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/
( The root folder of the package located at file:///e:/my.xsw )
</li>
<li>
vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/Content
( The folder/stream named "Content" that is contained in the root
folder of the located at file:///e:/my.xsw )
</li>
<li>
vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/Content%20A
( The folder/stream named "Content A" that is contained in the root
folder of the located at file:///e:/my.xsw )
</li>
</ul>
</p>
*/
interface com::sun::star::ucb::XContentProvider;
};
//=============================================================================
}; }; }; };
#endif
|
