1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_embed_ElementModes_idl__
24cdf0e10cSrcweir#define __com_sun_star_embed_ElementModes_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir
27cdf0e10cSrcweir//============================================================================
28cdf0e10cSrcweir
29cdf0e10cSrcweirmodule com { module sun { module star { module embed {
30cdf0e10cSrcweir
31cdf0e10cSrcweir//============================================================================
32cdf0e10cSrcweir/** The constant set contains possible modes to open an element.
33cdf0e10cSrcweir
34cdf0e10cSrcweir	<p>
35cdf0e10cSrcweir	The modes can be combined by 'or' operation.
36cdf0e10cSrcweir	<const>ElementModes::READ</const> and <const>ElementModes::WRITE</const>
37cdf0e10cSrcweir	are base modes. A result mode must include one of base modes.
38cdf0e10cSrcweir	</p>
39cdf0e10cSrcweir
40cdf0e10cSrcweir	@see <type>XStorage</type>
41cdf0e10cSrcweir*/
42cdf0e10cSrcweirpublished constants ElementModes
43cdf0e10cSrcweir{
44cdf0e10cSrcweir	//------------------------------------------------------------------------
45cdf0e10cSrcweir	/** specifies opening of an element for reading.
46cdf0e10cSrcweir	 */
47cdf0e10cSrcweir	const long READ = 1;
48cdf0e10cSrcweir
49cdf0e10cSrcweir	//------------------------------------------------------------------------
50cdf0e10cSrcweir	/** specifies opening of a seekable element.
51cdf0e10cSrcweir
52cdf0e10cSrcweir		<p>
53cdf0e10cSrcweir		This mode is ignored for <type>Storage</type> elements.
54cdf0e10cSrcweir		This flag makes sence only in combination with
55cdf0e10cSrcweir		<const>ElementModes::READ</const> and/or
56cdf0e10cSrcweir		<const>ElementModes::WRITE</const>.
57cdf0e10cSrcweir		</p>
58cdf0e10cSrcweir	 */
59cdf0e10cSrcweir	const long SEEKABLE = 2;
60cdf0e10cSrcweir
61cdf0e10cSrcweir	//------------------------------------------------------------------------
62cdf0e10cSrcweir	/** specifies opening of a seekable element for reading.
63cdf0e10cSrcweir
64cdf0e10cSrcweir		<p>
65cdf0e10cSrcweir		This is just a combination of the previous two values. For storages
66cdf0e10cSrcweir		it is the same as <const>ElementModes::READ</const>.
67cdf0e10cSrcweir		</p>
68cdf0e10cSrcweir	 */
69cdf0e10cSrcweir	const long SEEKABLEREAD = 3;
70cdf0e10cSrcweir
71cdf0e10cSrcweir	//------------------------------------------------------------------------
72cdf0e10cSrcweir	/** specifies opening of an element for writing.
73cdf0e10cSrcweir	 */
74cdf0e10cSrcweir	const long WRITE = 4;
75cdf0e10cSrcweir
76cdf0e10cSrcweir	//------------------------------------------------------------------------
77cdf0e10cSrcweir	/** specifies opening of an element for reading and writing.
78cdf0e10cSrcweir
79cdf0e10cSrcweir		<p>
80cdf0e10cSrcweir		For a stream element is also specifies that it must be seekable.
81cdf0e10cSrcweir		</p>
82cdf0e10cSrcweir	 */
83cdf0e10cSrcweir	const long READWRITE = 7;
84cdf0e10cSrcweir
85cdf0e10cSrcweir	//------------------------------------------------------------------------
86cdf0e10cSrcweir	/** lets the document be truncated immediatelly after opening.
87cdf0e10cSrcweir
88cdf0e10cSrcweir		<p>
89cdf0e10cSrcweir		This flag makes sence only in combination with
90cdf0e10cSrcweir		<const>ElementModes::WRITE</const>.
91cdf0e10cSrcweir		</p>
92cdf0e10cSrcweir	 */
93cdf0e10cSrcweir	const long TRUNCATE = 8;
94cdf0e10cSrcweir
95cdf0e10cSrcweir	//------------------------------------------------------------------------
96cdf0e10cSrcweir	/** restricts creation of a new element on opening in case a requested one
97cdf0e10cSrcweir		does not exist.
98cdf0e10cSrcweir
99cdf0e10cSrcweir		<p>
100cdf0e10cSrcweir		This flag makes sence only in combination with
101cdf0e10cSrcweir		<const>ElementModes::WRITE</const>.
102cdf0e10cSrcweir		</p>
103cdf0e10cSrcweir	 */
104cdf0e10cSrcweir	const long NOCREATE = 16;
105cdf0e10cSrcweir};
106cdf0e10cSrcweir
107cdf0e10cSrcweir//============================================================================
108cdf0e10cSrcweir
109cdf0e10cSrcweir}; }; }; };
110cdf0e10cSrcweir
111cdf0e10cSrcweir#endif
112cdf0e10cSrcweir
113