summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/ucb/OpenMode.idl
blob: 708eacd55b62742905257de5c9c8b4187b828be9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */



module com { module sun { module star { module ucb {

/** These are the possible values for OpenCommandArgument::Mode.
*/
published constants OpenMode
{
    /** open a folder, include all children in result set (documents and
        folders).
    */
    const short ALL = 0;

    /** open a folder, include only children, that are folders, in result set.
    */
    const short FOLDERS = 1;

    /** open a folder, include only children, that are documents, in result set.
    */
    const short DOCUMENTS = 3;

    /** open a document. There are no special requirements for data access
        sharing.

        <p>Note: There must be a data sink supplied in the
        OpenCommandArgument struct, if this value is set. This
        sink will be used by the content implementation to supply the document
        data.
    */
    const short DOCUMENT = 2;

    /** open a document. Allow shared read and write access.

        <p>Note: There must be a data sink supplied in the
        OpenCommandArgument struct, if this value is set. This
        sink will be used by the content implementation to supply the document
        data.
    */
    const short DOCUMENT_SHARE_DENY_NONE = 4;

    /** open a document. Deny shared write access.

        <p>Note: There must be a data sink supplied in the
        OpenCommandArgument struct, if this value is set. This
        sink will be used by the content implementation to supply the document
        data.
    */
    const short DOCUMENT_SHARE_DENY_WRITE = 5;

//  const short DOCUMENT_SHARE_DENY_READ = 6;
};


}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */