blob: 26701df2ef79aa45a2a74f332a16d9f468091abd (
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
|
/*************************************************************************
*
* 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: ContentInfo.idl,v $
* $Revision: 1.11 $
*
* 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_ContentInfo_idl__
#define __com_sun_star_ucb_ContentInfo_idl__
#ifndef __com_sun_star_beans_Property_idl__
#include <com/sun/star/beans/Property.idl>
#endif
//=============================================================================
module com { module sun { module star { module ucb {
//=============================================================================
/** A structure for information about contents.
@see XContentCreator
@see XCommandProcessor
*/
published struct ContentInfo
{
//-------------------------------------------------------------------------
/** A type identifier string for a content.
<p>This is an implementation specific string characterizing the
kind of a content (e.g. "application/vnd.sun.star.hierarchy-link").
The value of this member should match the value returned by
<member>XContent::getContentType</member> of an appropriate content.
*/
string Type;
//-------------------------------------------------------------------------
/** Additional attributes.
<p>These flags contain extra information on the content, like its kind
(KIND_FOLDER, KIND_DOCUMENT, KIND_LINK).
<p>It is highly recommended to fill these flags very accurately, as
they are very important when transferring contents between different
<type>ContentProvider</type>s.
<p>The value can be one of the <type>ContentInfoAttribute</type>
constants.
*/
long Attributes;
//-------------------------------------------------------------------------
/** This field contains a list with the properties which must be set at
a content that was just created using
<member>XContentCreator::createNewContent</member> before it can be
committed (by executing the command "insert" at the new content).
<p>If one of the properties is missing, the insert command will fail.
<p>In example, a new file system folder content will need a title. The
Properties member of the ContentInfo provided for this kind of
content must include the property "Title".
<p><b>Important:</b> The required properties must have one of the
following basic data types (in order to make it possible to implement
client applications with a small set of generic input methods for the
values):
<p>
<ul>
<li>boolean
<li>char
<li>byte
<li>string
<li>short
<li>long
<li>hyper
<li>float
<li>double
</ul>
*/
sequence< com::sun::star::beans::Property > Properties;
};
//=============================================================================
}; }; }; };
#endif
|
