offapi/com/sun/star/ucb/TransientDocumentsFolderContent.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_TransientDocumentsFolderContent_idl__
  20 #define __com_sun_star_ucb_TransientDocumentsFolderContent_idl__
  21
  22 #include <com/sun/star/lang/XComponent.idl>
  23 #include <com/sun/star/ucb/XContent.idl>
  24 #include <com/sun/star/ucb/XCommandProcessor.idl>
  25 #include <com/sun/star/ucb/XCommandProcessor2.idl>
  26 #include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
  27 #include <com/sun/star/beans/XPropertyContainer.idl>
  28 #include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
  29 #include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
  30 #include <com/sun/star/container/XChild.idl>
  31 #include <com/sun/star/ucb/XContentCreator.idl>
  32
  33
  34 module com { module sun { module star { module ucb {
  35
  36 /** A TDCP Folder is a container for other TDCP Folders and TDCP Streams.
  37
  38     <p>It may be contained in another TDCP Folder or in a TDCP Document.
  39
  40     @see TransientDocumentsContentProvider
  41     @see TransientDocumentsRootContent
  42     @see TransientDocumentsDocumentContent
  43     @see TransientDocumentsStreamContent
  44
  45     @since OOo 2.0
  46 */
  47 service TransientDocumentsFolderContent
  48 {
  49     /** This interface is implemented according to the specification of
  50         service Content.
  51      */
  52     interface com::sun::star::lang::XComponent;
  53
  54     /** This interface is implemented according to the specification of
  55         service Content.
  56      */
  57     interface com::sun::star::ucb::XContent;
  58
  59     /** This interface is implemented according to the specification of
  60         service Content.
  61
  62         <p>
  63
  64         <b>Supported Commands</b>
  65         <ul>
  66         <li>
  67         getCommandInfo
  68         </li>
  69         <li>
  70         getPropertySetInfo
  71         </li>
  72         <li>
  73         getPropertyValues
  74         </li>
  75         <li>
  76         setPropertyValues
  77         </li>
  78         <li>
  79         open
  80         </li>
  81         <li>
  82         insert
  83         </li>
  84         <li>
  85         delete
  86         </li>
  87         <li>
  88         transfer (only transfers TDCP documents, TDCP folders and TDCP streams.
  89         It does not handle contents with a URL scheme other than the TDOC URL
  90         scheme)
  91         </li>
  92         </ul>
  93
  94         <b>Supported Properties</b>
  95         <ul>
  96         <li>
  97         string ContentType ( read-only, always "application/vnd.sun.star.tdoc-folder" )
  98         </li>
  99         <li>
 100         boolean IsDocument ( read-only, always false )
 101         </li>
 102         <li>
 103         boolean IsFolder ( read-only, always true )
 104         </li>
 105         <li>
 106         string Title
 107         </li>
 108         <li>
 109         com::sun::star::embed::XStorage Storage ( read-only,
 110         always a reference to a storage opened in read-only mode. No write
 111         operations are possible. TDCP contents must be used for writing.)
 112         </li>
 113         </ul>
 114
 115         </p>
 116      */
 117     interface com::sun::star::ucb::XCommandProcessor;
 118
 119     /** is an enhanced version of XCommandProcessor that has an
 120         additional method for releasing command identifiers obtained via
 121         XCommandProcessor::createCommandIdentifier() to avoid
 122         resource leaks. For a detailed description of the problem refer to
 123         XCommandProcessor2::releaseCommandIdentifier().
 124
 125         <p>Where many existing Content implementations do not
 126         (yet), every new implementation should support this interface.
 127      */
 128     [optional] interface com::sun::star::ucb::XCommandProcessor2;
 129
 130     /** This interface is implemented according to the specification of
 131         service Content.
 132      */
 133     interface com::sun::star::beans::XPropertiesChangeNotifier;
 134
 135     /** This interface is implemented according to the specification of
 136         service Content.
 137      */
 138     interface com::sun::star::beans::XPropertyContainer;
 139
 140     /** This interface is implemented according to the specification of
 141         service Content.
 142      */
 143     interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
 144
 145     /** This interface is implemented according to the specification of
 146         service Content.
 147      */
 148     interface com::sun::star::ucb::XCommandInfoChangeNotifier;
 149
 150     /** This interface is implemented according to the specification of
 151         service Content.
 152      */
 153     interface com::sun::star::container::XChild;
 154
 155     /** This interface is implemented according to the specification of
 156         service Content.
 157
 158         <p>To create a new child of a TDCP Folder:
 159
 160         <ol>
 161         <li>
 162         Let the parent folder create a new content by calling
 163         XContentCreator::createNewContent() on it. The content
 164         type to use for new folders is "application/vnd.sun.star.tdoc-folder".
 165         To create a new stream, use the type string
 166         "application/vnd.sun.star.tdoc-stream".
 167         </li>
 168         <li>
 169         Set a title for the new folder/stream. (Let the new child execute the
 170         command "setPropertyValues"; pass a non-empty value for the property
 171         "Title").
 172         </li>
 173         <li>
 174         Let the new child ( not the parent! ) execute the command "insert".
 175         This will commit the creation process. For streams, you need to supply
 176         the implementation of an
 177         com::sun::star::io::XInputStream with the command's
 178         parameters, that provides access to the stream data.
 179         </li>
 180         </ol>
 181
 182         </p>
 183      */
 184     interface com::sun::star::ucb::XContentCreator;
 185 };
 186
 187
 188 }; }; }; };
 189
 190 #endif
 191
 192 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */