offapi/com/sun/star/embed/ElementModes.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_embed_ElementModes_idl__
  20 #define __com_sun_star_embed_ElementModes_idl__
  21
  22
  23
  24 module com { module sun { module star { module embed {
  25
  26 /** The constant set contains possible modes to open an element.
  27
  28     <p>
  29     The modes can be combined by "or" operation.
  30     ElementModes::READ and ElementModes::WRITE
  31     are base modes. A result mode must include one of base modes.
  32     </p>
  33
  34     @see XStorage
  35 */
  36 published constants ElementModes
  37 {
  38     /** specifies opening of an element for reading.
  39      */
  40     const long READ = 1;
  41
  42     /** specifies opening of a seekable element.
  43
  44         <p>
  45         This mode is ignored for Storage elements.
  46         This flag makes sense only in combination with
  47         ElementModes::READ and/or
  48         ElementModes::WRITE.
  49         </p>
  50      */
  51     const long SEEKABLE = 2;
  52
  53     /** specifies opening of a seekable element for reading.
  54
  55         <p>
  56         This is just a combination of the previous two values. For storages
  57         it is the same as ElementModes::READ.
  58         </p>
  59      */
  60     const long SEEKABLEREAD = 3;
  61
  62     /** specifies opening of an element for writing.
  63      */
  64     const long WRITE = 4;
  65
  66     /** specifies opening of an element for reading and writing.
  67
  68         <p>
  69         For a stream element is also specifies that it must be seekable.
  70         </p>
  71      */
  72     const long READWRITE = 7;
  73
  74     /** lets the document be truncated immediately after opening.
  75
  76         <p>
  77         This flag makes sense only in combination with
  78         ElementModes::WRITE.
  79         </p>
  80      */
  81     const long TRUNCATE = 8;
  82
  83     /** restricts creation of a new element on opening in case a requested one
  84         does not exist.
  85
  86         <p>
  87         This flag makes sense only in combination with
  88         ElementModes::WRITE.
  89         </p>
  90      */
  91     const long NOCREATE = 16;
  92 };
  93
  94
  95 }; }; }; };
  96
  97 #endif
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */