offapi/com/sun/star/ucb/TransientDocumentsRootContent.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_TransientDocumentsRootContent_idl__
  20 #define __com_sun_star_ucb_TransientDocumentsRootContent_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 Root Folder is the root container for all other TDCP contents.
  36
  37     <p>There is at most one instance of a TDCP Root at a time. All other TDCP
  38     contents are children of this folder. The TDCP Root Folder can contain
  39     only TDCP Documents. It has the fixed URL "vnd.sun.star.tdoc:/".
  40
  41     @see TransientDocumentsContentProvider
  42     @see TransientDocumentsDocumentContent
  43     @see TransientDocumentsFolderContent
  44     @see TransientDocumentsStreamContent
  45
  46     @since OOo 2.0
  47 */
  48 service TransientDocumentsRootContent
  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         </ul>
  83
  84         <b>Supported Properties</b>
  85         <ul>
  86         <li>
  87         string ContentType ( read-only, always "application/vnd.sun.star.tdoc-root" )
  88         </li>
  89         <li>
  90         boolean IsDocument ( read-only, always false )
  91         </li>
  92         <li>
  93         boolean IsFolder ( read-only, always true )
  94         </li>
  95         <li>
  96         string Title ( read-only, always an empty string )
  97         </li>
  98         </ul>
  99
 100         </p>
 101      */
 102     interface com::sun::star::ucb::XCommandProcessor;
 103
 104     /** is an enhanced version of XCommandProcessor that has an
 105         additional method for releasing command identifiers obtained via
 106         XCommandProcessor::createCommandIdentifier() to avoid
 107         resource leaks. For a detailed description of the problem refer to
 108         XCommandProcessor2::releaseCommandIdentifier().
 109
 110         <p>Where many existing Content implementations do not
 111         (yet), every new implementation should support this interface.
 112      */
 113     [optional] interface com::sun::star::ucb::XCommandProcessor2;
 114
 115     /** This interface is implemented according to the specification of
 116         service Content.
 117      */
 118     interface com::sun::star::beans::XPropertiesChangeNotifier;
 119
 120     /** This interface is implemented according to the specification of
 121         service Content.
 122      */
 123     interface com::sun::star::beans::XPropertyContainer;
 124
 125     /** This interface is implemented according to the specification of
 126         service Content.
 127      */
 128     interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
 129
 130     /** This interface is implemented according to the specification of
 131         service Content.
 132      */
 133     interface com::sun::star::ucb::XCommandInfoChangeNotifier;
 134
 135     /** This interface is implemented according to the specification of
 136         service Content.
 137      */
 138     interface com::sun::star::container::XChild;
 139 };
 140
 141
 142 }; }; }; };
 143
 144 #endif
 145
 146 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */