offapi/com/sun/star/ucb/TransientDocumentsStreamContent.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_TransientDocumentsStreamContent_idl__
  20 #define __com_sun_star_ucb_TransientDocumentsStreamContent_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
  32
  33 module com { module sun { module star { module ucb {
  34
  35 /** A TDCP Stream is a content which represents a data stream of an Office
  36     document.
  37
  38     <p>It is  contained in a TDCP Folder or TDCP Document. A TDCP Stream has no
  39     children.
  40
  41     @see TransientDocumentsContentProvider
  42     @see TransientDocumentsRootContent
  43     @see TransientDocumentsDocumentContent
  44     @see TransientDocumentsFolderContent
  45
  46     @since OOo 2.0
  47 */
  48 service TransientDocumentsStreamContent
  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         insert
  84         </li>
  85         <li>
  86         delete
  87         </li>
  88         </ul>
  89
  90         <b>Supported Properties</b>
  91         <ul>
  92         <li>
  93         string ContentType ( read-only, always "application/vnd.sun.star.tdoc-stream" )
  94         </li>
  95         <li>
  96         boolean IsDocument ( read-only, always true )
  97         </li>
  98         <li>
  99         boolean IsFolder ( read-only, always false )
 100         </li>
 101         <li>
 102         string Title
 103         </li>
 104         </ul>
 105
 106         </p>
 107      */
 108     interface com::sun::star::ucb::XCommandProcessor;
 109
 110     /** is an enhanced version of XCommandProcessor that has an
 111         additional method for releasing command identifiers obtained via
 112         XCommandProcessor::createCommandIdentifier() to avoid
 113         resource leaks. For a detailed description of the problem refer to
 114         XCommandProcessor2::releaseCommandIdentifier().
 115
 116         <p>Where many existing Content implementations do not
 117         (yet), every new implementation should support this interface.
 118      */
 119     [optional] interface com::sun::star::ucb::XCommandProcessor2;
 120
 121     /** This interface is implemented according to the specification of
 122         service Content.
 123      */
 124     interface com::sun::star::beans::XPropertiesChangeNotifier;
 125
 126     /** This interface is implemented according to the specification of
 127         service Content.
 128      */
 129     interface com::sun::star::beans::XPropertyContainer;
 130
 131     /** This interface is implemented according to the specification of
 132         service Content.
 133      */
 134     interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
 135
 136     /** This interface is implemented according to the specification of
 137         service Content.
 138      */
 139     interface com::sun::star::ucb::XCommandInfoChangeNotifier;
 140
 141     /** This interface is implemented according to the specification of
 142         service Content.
 143      */
 144     interface com::sun::star::container::XChild;
 145
 146 };
 147
 148
 149 }; }; }; };
 150
 151 #endif
 152
 153 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */