offapi/com/sun/star/ucb/ContentInfo.idl

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