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