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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: TransientDocumentsRootContent.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_TransientDocumentsRootContent_idl__
  31 #define __com_sun_star_ucb_TransientDocumentsRootContent_idl__
  32
  33 #ifndef __com_sun_star_lang_XComponent_idl__
  34 #include <com/sun/star/lang/XComponent.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_XContent_idl__
  38 #include <com/sun/star/ucb/XContent.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_ucb_XCommandProcessor_idl__
  42 #include <com/sun/star/ucb/XCommandProcessor.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_ucb_XCommandProcessor2_idl__
  46 #include <com/sun/star/ucb/XCommandProcessor2.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__
  50 #include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_beans_XPropertyContainer_idl__
  54 #include <com/sun/star/beans/XPropertyContainer.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__
  58 #include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__
  62 #include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_container_XChild_idl__
  66 #include <com/sun/star/container/XChild.idl>
  67 #endif
  68
  69 //=============================================================================
  70
  71 module com { module sun { module star { module ucb {
  72
  73 //=============================================================================
  74 /** A TDCP Root Folder is the root container for all other DTCP contents.
  75
  76     <p>There is at most one instance of a TDCP Root at a time. All other TDCP
  77     contents are children of this folder. The TDCP Root Folder can contain
  78     only TDCP Documents. It has the fixed URL "vnd.sun.star.tdoc:/".
  79
  80     @see TransientDocumentsContentProvider
  81     @see TransientDocumentsDocumentContent
  82     @see TransientDocumentsFolderContent
  83     @see TransientDocumentsStreamContent
  84
  85     @since OOo 2.0.0
  86 */
  87 service TransientDocumentsRootContent
  88 {
  89     //-------------------------------------------------------------------------
  90     /** This interface is implemented according to the specification of
  91         service <type>Content</type>.
  92      */
  93     interface com::sun::star::lang::XComponent;
  94
  95     //-------------------------------------------------------------------------
  96     /** This interface is implemented according to the specification of
  97         service <type>Content</type>.
  98      */
  99     interface com::sun::star::ucb::XContent;
 100
 101     //-------------------------------------------------------------------------
 102     /** This interface is implemented according to the specification of
 103         service <type>Content</type>.
 104
 105         <p>
 106
 107         <b>Supported Commands</b>
 108         <ul>
 109         <li>
 110         getCommandInfo
 111         </li>
 112         <li>
 113         getPropertySetInfo
 114         </li>
 115         <li>
 116         getPropertyValues
 117         </li>
 118         <li>
 119         setPropertyValues
 120         </li>
 121         <li>
 122         open
 123         </li>
 124         </ul>
 125
 126         <b>Supported Properties</b>
 127         <ul>
 128         <li>
 129         string ContentType ( read-only, always "application/vnd.sun.star.tdoc-root" )
 130         </li>
 131         <li>
 132         boolean IsDocument ( read-only, always false )
 133         </li>
 134         <li>
 135         boolean IsFolder ( read-only, always true )
 136         </li>
 137         <li>
 138         string Title ( read-only, always an empty string )
 139         </li>
 140         </ul>
 141
 142         </p>
 143      */
 144     interface com::sun::star::ucb::XCommandProcessor;
 145
 146     //-------------------------------------------------------------------------
 147     /** is an enhanced version of <type>XCommandProcessor</type> that has an
 148         additional method for releasing command identifiers obtained via
 149         <member>XCommandProcessor::createCommandIdentifier</member> to avoid
 150         resource leaks. For a detailed description of the problem refer to
 151         <member>XCommandProcessor2::releaseCommandIdentifier</member>.
 152
 153         <p>Where many existing <type>Content</type> implementations do not
 154         (yet), every new implementation should support this interface.
 155      */
 156     [optional] interface com::sun::star::ucb::XCommandProcessor2;
 157
 158     //-------------------------------------------------------------------------
 159     /** This interface is implemented according to the specification of
 160         service <type>Content</type>.
 161      */
 162     interface com::sun::star::beans::XPropertiesChangeNotifier;
 163
 164     //-------------------------------------------------------------------------
 165     /** This interface is implemented according to the specification of
 166         service <type>Content</type>.
 167      */
 168     interface com::sun::star::beans::XPropertyContainer;
 169
 170     //-------------------------------------------------------------------------
 171     /** This interface is implemented according to the specification of
 172         service <type>Content</type>.
 173      */
 174     interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
 175
 176     //-------------------------------------------------------------------------
 177     /** This interface is implemented according to the specification of
 178         service <type>Content</type>.
 179      */
 180     interface com::sun::star::ucb::XCommandInfoChangeNotifier;
 181
 182     //-------------------------------------------------------------------------
 183     /** This interface is implemented according to the specification of
 184         service <type>Content</type>.
 185      */
 186     interface com::sun::star::container::XChild;
 187 };
 188
 189 //=============================================================================
 190
 191 }; }; }; };
 192
 193 #endif