INTEGRATION: CWS fwkbugfix02 (1.2.148); FILE MERGED

2004/03/25 09:06:19 mav 1.2.148.2: #116056# interfaces review
2004/03/22 10:14:24 mav 1.2.148.1: #115011# review idl files

1 files changed, 62 insertions, 32 deletions

diff --git a/offapi/com/sun/star/embed/ElementModes.idl b/offapi/com/sun/star/embed/ElementModes.idl
index 59b000e0bee1..216aa85a7328 100644
--- a/offapi/com/sun/star/embed/ElementModes.idl
+++ b/offapi/com/sun/star/embed/ElementModes.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: ElementModes.idl,v $
  *
- *  $Revision: 1.2 $
+ *  $Revision: 1.3 $
  *
- *  last change: $Author: kz $ $Date: 2003-09-11 10:22:10 $
+ *  last change: $Author: hr $ $Date: 2004-05-10 17:59:25 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -62,59 +62,89 @@
 #define __com_sun_star_embed_ElementModes_idl__
 
 
-//=============================================================================
+//============================================================================
 
 module com { module sun { module star { module embed {
 
-//=============================================================================
-/** There are possible modes to open element.
+//============================================================================
+/** The constant set contains possible modes to open an element.
+
+    <p>
     The modes can be combined by 'or' operation.
-    ELEMENT_READ and ELEMENT_WRITE are kind of base modes.
-    A result mode must include one of base modes.
+    <const>ElementModes::READ</const> and <const>ElementModes::WRITE</const>
+    are base modes. A result mode must include one of base modes.
+    </p>
+
+    @see <type>XStorage</type>
 */
 constants ElementModes
 {
-    //-------------------------------------------------------------------------
-    /** Open element for reading.
+    //------------------------------------------------------------------------
+    /** specifies opening of an element for reading.
      */
-    const long ELEMENT_READ = 1;
+    const long READ = 1;
 
-    //-------------------------------------------------------------------------
-    /** Open seekable element. Ignored for storages.
+    //------------------------------------------------------------------------
+    /** specifies opening of a seekable element.
+
+        <p>
+        This mode is ignored for <type>Storage</type> elements.
+        This flag makes sence only in combination with
+        <const>ElementModes::READ</const> and/or
+        <const>ElementModes::WRITE</const>.
+        </p>
      */
-    const long ELEMENT_SEEKABLE = 2;
+    const long SEEKABLE = 2;
+
+    //------------------------------------------------------------------------
+    /** specifies opening of a seekable element for reading.
 
-    //-------------------------------------------------------------------------
-    /** Open seekable element for reading. This is just a combination of the previous two values.
-    For storages it's the same as ELEMENT_READ.
+        <p>
+        This is just a combination of the previous two values. For storages
+        it is the same as <const>ElementModes::READ</const>.
+        </p>
      */
-    const long ELEMENT_SEEKABLEREAD = 3;
+    const long SEEKABLEREAD = 3;
 
-    //-------------------------------------------------------------------------
-    /** Open element in write mode.
+    //------------------------------------------------------------------------
+    /** specifies opening of an element for writing.
      */
-    const long ELEMENT_WRITE = 4;
+    const long WRITE = 4;
 
-    //-------------------------------------------------------------------------
-    /** Open element in readwrite mode. A stream must be opened also in seekable mode.
+    //------------------------------------------------------------------------
+    /** specifies opening of an element for reading and writing.
+
+        <p>
+        For a stream element is also specifies that it must be seekable.
+        </p>
      */
-    const long ELEMENT_READWRITE = 7;
+    const long READWRITE = 7;
+
+    //------------------------------------------------------------------------
+    /** lets the document be truncated immediatelly after opening.
 
-    //-------------------------------------------------------------------------
-    /** Truncate opened for writing element.
-    flag.
+        <p>
+        This flag makes sence only in combination with
+        <const>ElementModes::WRITE</const>.
+        </p>
      */
-    const long ELEMENT_TRUNCATE = 8;
+    const long TRUNCATE = 8;
 
-    //-------------------------------------------------------------------------
-    /** Do not create a new element in case a requested one does not exist.
-    Applicable only for elements opened for writing.
+    //------------------------------------------------------------------------
+    /** restricts creation of a new element on opening in case a requested one
+        does not exist.
+
+        <p>
+        This flag makes sence only in combination with
+        <const>ElementModes::WRITE</const>.
+        </p>
      */
-    const long ELEMENT_NOCREATE = 16;
+    const long NOCREATE = 16;
 };
 
-//=============================================================================
+//============================================================================
 
 }; }; }; };
 
 #endif
+