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
  20
  21 module com { module sun { module star { module ucb {
  22
  23 /** A TDCP Root Folder is the root container for all other TDCP contents.
  24
  25     <p>There is at most one instance of a TDCP Root at a time. All other TDCP
  26     contents are children of this folder. The TDCP Root Folder can contain
  27     only TDCP Documents. It has the fixed URL "vnd.sun.star.tdoc:/".
  28
  29     @see TransientDocumentsContentProvider
  30     @see TransientDocumentsDocumentContent
  31     @see TransientDocumentsFolderContent
  32     @see TransientDocumentsStreamContent
  33
  34     @since OOo 2.0
  35 */
  36 service TransientDocumentsRootContent
  37 {
  38     /** This interface is implemented according to the specification of
  39         service Content.
  40      */
  41     interface com::sun::star::lang::XComponent;
  42
  43     /** This interface is implemented according to the specification of
  44         service Content.
  45      */
  46     interface com::sun::star::ucb::XContent;
  47
  48     /** This interface is implemented according to the specification of
  49         service Content.
  50
  51         <p>
  52
  53         <b>Supported Commands</b>
  54         <ul>
  55         <li>
  56         getCommandInfo
  57         </li>
  58         <li>
  59         getPropertySetInfo
  60         </li>
  61         <li>
  62         getPropertyValues
  63         </li>
  64         <li>
  65         setPropertyValues
  66         </li>
  67         <li>
  68         open
  69         </li>
  70         </ul>
  71
  72         <b>Supported Properties</b>
  73         <ul>
  74         <li>
  75         string ContentType ( read-only, always "application/vnd.sun.star.tdoc-root" )
  76         </li>
  77         <li>
  78         boolean IsDocument ( read-only, always false )
  79         </li>
  80         <li>
  81         boolean IsFolder ( read-only, always true )
  82         </li>
  83         <li>
  84         string Title ( read-only, always an empty string )
  85         </li>
  86         </ul>
  87
  88         </p>
  89      */
  90     interface com::sun::star::ucb::XCommandProcessor;
  91
  92     /** is an enhanced version of XCommandProcessor that has an
  93         additional method for releasing command identifiers obtained via
  94         XCommandProcessor::createCommandIdentifier() to avoid
  95         resource leaks. For a detailed description of the problem refer to
  96         XCommandProcessor2::releaseCommandIdentifier().
  97
  98         <p>Where many existing Content implementations do not
  99         (yet), every new implementation should support this interface.
 100      */
 101     [optional] interface com::sun::star::ucb::XCommandProcessor2;
 102
 103     /** This interface is implemented according to the specification of
 104         service Content.
 105      */
 106     interface com::sun::star::beans::XPropertiesChangeNotifier;
 107
 108     /** This interface is implemented according to the specification of
 109         service Content.
 110      */
 111     interface com::sun::star::beans::XPropertyContainer;
 112
 113     /** This interface is implemented according to the specification of
 114         service Content.
 115      */
 116     interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
 117
 118     /** This interface is implemented according to the specification of
 119         service Content.
 120      */
 121     interface com::sun::star::ucb::XCommandInfoChangeNotifier;
 122
 123     /** This interface is implemented according to the specification of
 124         service Content.
 125      */
 126     interface com::sun::star::container::XChild;
 127 };
 128
 129
 130 }; }; }; };
 131
 132 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */