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