xref: /AOO41X/main/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl (revision 34c958ab2597dc3f66146be0dc1758f0ba5d93f5)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_TransientDocumentsRootContent_idl__
24#define __com_sun_star_ucb_TransientDocumentsRootContent_idl__
25
26#ifndef __com_sun_star_lang_XComponent_idl__
27#include <com/sun/star/lang/XComponent.idl>
28#endif
29
30#ifndef __com_sun_star_ucb_XContent_idl__
31#include <com/sun/star/ucb/XContent.idl>
32#endif
33
34#ifndef __com_sun_star_ucb_XCommandProcessor_idl__
35#include <com/sun/star/ucb/XCommandProcessor.idl>
36#endif
37
38#ifndef __com_sun_star_ucb_XCommandProcessor2_idl__
39#include <com/sun/star/ucb/XCommandProcessor2.idl>
40#endif
41
42#ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__
43#include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
44#endif
45
46#ifndef __com_sun_star_beans_XPropertyContainer_idl__
47#include <com/sun/star/beans/XPropertyContainer.idl>
48#endif
49
50#ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__
51#include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
52#endif
53
54#ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__
55#include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
56#endif
57
58#ifndef __com_sun_star_container_XChild_idl__
59#include <com/sun/star/container/XChild.idl>
60#endif
61
62//=============================================================================
63
64module com { module sun { module star { module ucb {
65
66//=============================================================================
67/** A TDCP Root Folder is the root container for all other DTCP contents.
68
69    <p>There is at most one instance of a TDCP Root at a time. All other TDCP
70    contents are children of this folder. The TDCP Root Folder can contain
71    only TDCP Documents. It has the fixed URL "vnd.sun.star.tdoc:/".
72
73    @see TransientDocumentsContentProvider
74    @see TransientDocumentsDocumentContent
75    @see TransientDocumentsFolderContent
76    @see TransientDocumentsStreamContent
77
78    @since OpenOffice 2.0
79*/
80service TransientDocumentsRootContent
81{
82    //-------------------------------------------------------------------------
83    /** This interface is implemented according to the specification of
84        service <type>Content</type>.
85     */
86    interface com::sun::star::lang::XComponent;
87
88    //-------------------------------------------------------------------------
89    /** This interface is implemented according to the specification of
90        service <type>Content</type>.
91     */
92    interface com::sun::star::ucb::XContent;
93
94    //-------------------------------------------------------------------------
95    /** This interface is implemented according to the specification of
96        service <type>Content</type>.
97
98        <p>
99
100        <b>Supported Commands</b>
101        <ul>
102        <li>
103        getCommandInfo
104        </li>
105        <li>
106        getPropertySetInfo
107        </li>
108        <li>
109        getPropertyValues
110        </li>
111        <li>
112        setPropertyValues
113        </li>
114        <li>
115        open
116        </li>
117        </ul>
118
119        <b>Supported Properties</b>
120        <ul>
121        <li>
122        string ContentType ( read-only, always "application/vnd.sun.star.tdoc-root" )
123        </li>
124        <li>
125        boolean IsDocument ( read-only, always false )
126        </li>
127        <li>
128        boolean IsFolder ( read-only, always true )
129        </li>
130        <li>
131        string Title ( read-only, always an empty string )
132        </li>
133        </ul>
134
135        </p>
136     */
137    interface com::sun::star::ucb::XCommandProcessor;
138
139    //-------------------------------------------------------------------------
140    /** is an enhanced version of <type>XCommandProcessor</type> that has an
141        additional method for releasing command identifiers obtained via
142        <member>XCommandProcessor::createCommandIdentifier</member> to avoid
143        resource leaks. For a detailed description of the problem refer to
144        <member>XCommandProcessor2::releaseCommandIdentifier</member>.
145
146        <p>Where many existing <type>Content</type> implementations do not
147        (yet), every new implementation should support this interface.
148     */
149    [optional] interface com::sun::star::ucb::XCommandProcessor2;
150
151    //-------------------------------------------------------------------------
152    /** This interface is implemented according to the specification of
153        service <type>Content</type>.
154     */
155    interface com::sun::star::beans::XPropertiesChangeNotifier;
156
157    //-------------------------------------------------------------------------
158    /** This interface is implemented according to the specification of
159        service <type>Content</type>.
160     */
161    interface com::sun::star::beans::XPropertyContainer;
162
163    //-------------------------------------------------------------------------
164    /** This interface is implemented according to the specification of
165        service <type>Content</type>.
166     */
167    interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
168
169    //-------------------------------------------------------------------------
170    /** This interface is implemented according to the specification of
171        service <type>Content</type>.
172     */
173    interface com::sun::star::ucb::XCommandInfoChangeNotifier;
174
175    //-------------------------------------------------------------------------
176    /** This interface is implemented according to the specification of
177        service <type>Content</type>.
178     */
179    interface com::sun::star::container::XChild;
180};
181
182//=============================================================================
183
184}; }; }; };
185
186#endif
187