xref: /AOO41X/main/offapi/com/sun/star/ucb/OpenMode.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_OpenMode_idl__
24#define __com_sun_star_ucb_OpenMode_idl__
25
26
27//=============================================================================
28
29module com { module sun { module star { module ucb {
30
31//=============================================================================
32/** These are the possible values for <member>OpenCommandArgument::Mode</member>.
33*/
34published constants OpenMode
35{
36    //-------------------------------------------------------------------------
37    /** open a folder, include all children in result set (documents and
38        folders).
39    */
40    const short ALL = 0;
41
42    //-------------------------------------------------------------------------
43    /** open a folder, include only children, that are folders, in result set.
44    */
45    const short FOLDERS = 1;
46
47    //-------------------------------------------------------------------------
48    /** open a folder, include only children, that are documents, in result set.
49    */
50    const short DOCUMENTS = 3;
51
52    //-------------------------------------------------------------------------
53    /** open a document. There are no special requirements for data access
54        sharing.
55
56        <p>Note: There must be a data sink supplied in the
57        <type>OpenCommandArgument</type> struct, if this value is set. This
58        sink will be used by the content implementation to supply the document
59        data.
60    */
61    const short DOCUMENT = 2;
62
63    //-------------------------------------------------------------------------
64    /** open a document. Allow shared read and write access.
65
66        <p>Note: There must be a data sink supplied in the
67        <type>OpenCommandArgument</type> struct, if this value is set. This
68        sink will be used by the content implementation to supply the document
69        data.
70    */
71    const short DOCUMENT_SHARE_DENY_NONE = 4;
72
73    //-------------------------------------------------------------------------
74    /** open a document. Deny shared write access.
75
76        <p>Note: There must be a data sink supplied in the
77        <type>OpenCommandArgument</type> struct, if this value is set. This
78        sink will be used by the content implementation to supply the document
79        data.
80    */
81    const short DOCUMENT_SHARE_DENY_WRITE = 5;
82
83//  const short DOCUMENT_SHARE_DENY_READ = 6;
84};
85
86//=============================================================================
87
88}; }; }; };
89
90#endif
91