xref: /aoo41x/main/offapi/com/sun/star/ucb/ContentInfo.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_ContentInfo_idl__
24#define __com_sun_star_ucb_ContentInfo_idl__
25
26#ifndef __com_sun_star_beans_Property_idl__
27#include <com/sun/star/beans/Property.idl>
28#endif
29
30//=============================================================================
31
32module com { module sun { module star { module ucb {
33
34//=============================================================================
35/** A structure for information about contents.
36
37	@see XContentCreator
38	@see XCommandProcessor
39*/
40published struct ContentInfo
41{
42	//-------------------------------------------------------------------------
43	/** A type identifier string for a content.
44
45	    <p>This is an implementation specific string characterizing the
46		kind of a content (e.g. "application/vnd.sun.star.hierarchy-link").
47		The value of this member should match the value returned by
48		<member>XContent::getContentType</member> of an appropriate content.
49	*/
50	string Type;
51
52	//-------------------------------------------------------------------------
53	/** Additional attributes.
54
55	    <p>These flags contain extra information on the content, like its kind
56		(KIND_FOLDER, KIND_DOCUMENT, KIND_LINK).
57
58		<p>It is highly recommended to fill these flags very accurately, as
59		they are very important when transferring contents between different
60		<type>ContentProvider</type>s.
61
62		<p>The value can be one of the <type>ContentInfoAttribute</type>
63		   constants.
64	*/
65	long Attributes;
66
67	//-------------------------------------------------------------------------
68	/** This field contains a list with the properties which must be set at
69	    a content that was just created using
70		<member>XContentCreator::createNewContent</member> before it can be
71		committed (by executing the command "insert" at the new content).
72
73		<p>If one of the properties is missing, the insert command will fail.
74
75		<p>In example, a new file system folder content will need a title. The
76		Properties member of the ContentInfo provided for this kind of
77		content must include the property "Title".
78
79		<p><b>Important:</b> The required properties must have one of the
80		following basic data types (in order to make it possible to implement
81		client applications with a small set of generic input methods for the
82		values):
83
84		<p>
85		<ul>
86		<li>boolean
87		<li>char
88		<li>byte
89		<li>string
90		<li>short
91		<li>long
92		<li>hyper
93		<li>float
94		<li>double
95		</ul>
96	*/
97	sequence< com::sun::star::beans::Property > Properties;
98};
99
100//=============================================================================
101
102}; }; }; };
103
104#endif
105