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