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

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