offapi/com/sun/star/embed/ElementModes.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: ElementModes.idl,v $
  10  * $Revision: 1.5 $
  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_embed_ElementModes_idl__
  31 #define __com_sun_star_embed_ElementModes_idl__
  32
  33
  34 //============================================================================
  35
  36 module com { module sun { module star { module embed {
  37
  38 //============================================================================
  39 /** The constant set contains possible modes to open an element.
  40
  41     <p>
  42     The modes can be combined by 'or' operation.
  43     <const>ElementModes::READ</const> and <const>ElementModes::WRITE</const>
  44     are base modes. A result mode must include one of base modes.
  45     </p>
  46
  47     @see <type>XStorage</type>
  48 */
  49 constants ElementModes
  50 {
  51     //------------------------------------------------------------------------
  52     /** specifies opening of an element for reading.
  53      */
  54     const long READ = 1;
  55
  56     //------------------------------------------------------------------------
  57     /** specifies opening of a seekable element.
  58
  59         <p>
  60         This mode is ignored for <type>Storage</type> elements.
  61         This flag makes sence only in combination with
  62         <const>ElementModes::READ</const> and/or
  63         <const>ElementModes::WRITE</const>.
  64         </p>
  65      */
  66     const long SEEKABLE = 2;
  67
  68     //------------------------------------------------------------------------
  69     /** specifies opening of a seekable element for reading.
  70
  71         <p>
  72         This is just a combination of the previous two values. For storages
  73         it is the same as <const>ElementModes::READ</const>.
  74         </p>
  75      */
  76     const long SEEKABLEREAD = 3;
  77
  78     //------------------------------------------------------------------------
  79     /** specifies opening of an element for writing.
  80      */
  81     const long WRITE = 4;
  82
  83     //------------------------------------------------------------------------
  84     /** specifies opening of an element for reading and writing.
  85
  86         <p>
  87         For a stream element is also specifies that it must be seekable.
  88         </p>
  89      */
  90     const long READWRITE = 7;
  91
  92     //------------------------------------------------------------------------
  93     /** lets the document be truncated immediatelly after opening.
  94
  95         <p>
  96         This flag makes sence only in combination with
  97         <const>ElementModes::WRITE</const>.
  98         </p>
  99      */
 100     const long TRUNCATE = 8;
 101
 102     //------------------------------------------------------------------------
 103     /** restricts creation of a new element on opening in case a requested one
 104         does not exist.
 105
 106         <p>
 107         This flag makes sence only in combination with
 108         <const>ElementModes::WRITE</const>.
 109         </p>
 110      */
 111     const long NOCREATE = 16;
 112 };
 113
 114 //============================================================================
 115
 116 }; }; }; };
 117
 118 #endif
 119