offapi/com/sun/star/ucb/OpenMode.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: OpenMode.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_OpenMode_idl__
  31 #define __com_sun_star_ucb_OpenMode_idl__
  32
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module ucb {
  37
  38 //=============================================================================
  39 /** These are the possible values for <member>OpenCommandArgument::Mode</member>.
  40 */
  41 published constants OpenMode
  42 {
  43     //-------------------------------------------------------------------------
  44     /** open a folder, include all children in result set (documents and
  45         folders).
  46     */
  47     const short ALL = 0;
  48
  49     //-------------------------------------------------------------------------
  50     /** open a folder, include only children, that are folders, in result set.
  51     */
  52     const short FOLDERS = 1;
  53
  54     //-------------------------------------------------------------------------
  55     /** open a folder, include only children, that are documents, in result set.
  56     */
  57     const short DOCUMENTS = 3;
  58
  59     //-------------------------------------------------------------------------
  60     /** open a document. There are no special requirements for data access
  61         sharing.
  62
  63         <p>Note: There must be a data sink supplied in the
  64         <type>OpenCommandArgument</type> struct, if this value is set. This
  65         sink will be used by the content implementation to supply the document
  66         data.
  67     */
  68     const short DOCUMENT = 2;
  69
  70     //-------------------------------------------------------------------------
  71     /** open a document. Allow shared read and write access.
  72
  73         <p>Note: There must be a data sink supplied in the
  74         <type>OpenCommandArgument</type> struct, if this value is set. This
  75         sink will be used by the content implementation to supply the document
  76         data.
  77     */
  78     const short DOCUMENT_SHARE_DENY_NONE = 4;
  79
  80     //-------------------------------------------------------------------------
  81     /** open a document. Deny shared write access.
  82
  83         <p>Note: There must be a data sink supplied in the
  84         <type>OpenCommandArgument</type> struct, if this value is set. This
  85         sink will be used by the content implementation to supply the document
  86         data.
  87     */
  88     const short DOCUMENT_SHARE_DENY_WRITE = 5;
  89
  90 //      const short DOCUMENT_SHARE_DENY_READ = 6;
  91 };
  92
  93 //=============================================================================
  94
  95 }; }; }; };
  96
  97 #endif