1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_ucb_ContentInfo_idl__ 28#define __com_sun_star_ucb_ContentInfo_idl__ 29 30#ifndef __com_sun_star_beans_Property_idl__ 31#include <com/sun/star/beans/Property.idl> 32#endif 33 34//============================================================================= 35 36module com { module sun { module star { module ucb { 37 38//============================================================================= 39/** A structure for information about contents. 40 41 @see XContentCreator 42 @see XCommandProcessor 43*/ 44published struct ContentInfo 45{ 46 //------------------------------------------------------------------------- 47 /** A type identifier string for a content. 48 49 <p>This is an implementation specific string characterizing the 50 kind of a content (e.g. "application/vnd.sun.star.hierarchy-link"). 51 The value of this member should match the value returned by 52 <member>XContent::getContentType</member> of an appropriate content. 53 */ 54 string Type; 55 56 //------------------------------------------------------------------------- 57 /** Additional attributes. 58 59 <p>These flags contain extra information on the content, like its kind 60 (KIND_FOLDER, KIND_DOCUMENT, KIND_LINK). 61 62 <p>It is highly recommended to fill these flags very accurately, as 63 they are very important when transferring contents between different 64 <type>ContentProvider</type>s. 65 66 <p>The value can be one of the <type>ContentInfoAttribute</type> 67 constants. 68 */ 69 long Attributes; 70 71 //------------------------------------------------------------------------- 72 /** This field contains a list with the properties which must be set at 73 a content that was just created using 74 <member>XContentCreator::createNewContent</member> before it can be 75 committed (by executing the command "insert" at the new content). 76 77 <p>If one of the properties is missing, the insert command will fail. 78 79 <p>In example, a new file system folder content will need a title. The 80 Properties member of the ContentInfo provided for this kind of 81 content must include the property "Title". 82 83 <p><b>Important:</b> The required properties must have one of the 84 following basic data types (in order to make it possible to implement 85 client applications with a small set of generic input methods for the 86 values): 87 88 <p> 89 <ul> 90 <li>boolean 91 <li>char 92 <li>byte 93 <li>string 94 <li>short 95 <li>long 96 <li>hyper 97 <li>float 98 <li>double 99 </ul> 100 */ 101 sequence< com::sun::star::beans::Property > Properties; 102}; 103 104//============================================================================= 105 106}; }; }; }; 107 108#endif 109