1*408a4873SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*408a4873SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*408a4873SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*408a4873SAndrew Rist * distributed with this work for additional information
6*408a4873SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*408a4873SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*408a4873SAndrew Rist * "License"); you may not use this file except in compliance
9*408a4873SAndrew Rist * with the License.  You may obtain a copy of the License at
10*408a4873SAndrew Rist *
11*408a4873SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*408a4873SAndrew Rist *
13*408a4873SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*408a4873SAndrew Rist * software distributed under the License is distributed on an
15*408a4873SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*408a4873SAndrew Rist * KIND, either express or implied.  See the License for the
17*408a4873SAndrew Rist * specific language governing permissions and limitations
18*408a4873SAndrew Rist * under the License.
19*408a4873SAndrew Rist *
20*408a4873SAndrew Rist *************************************************************/
21*408a4873SAndrew Rist
22*408a4873SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_io_XMarkableStream_idl__
24cdf0e10cSrcweir#define __com_sun_star_io_XMarkableStream_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_io_IOException_idl__
31cdf0e10cSrcweir#include <com/sun/star/io/IOException.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
35cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir
41cdf0e10cSrcweirmodule com {  module sun {  module star {  module io {
42cdf0e10cSrcweir
43cdf0e10cSrcweir//=============================================================================
44cdf0e10cSrcweir
45cdf0e10cSrcweir// DocMerge from xml: interface com::sun::star::io::XMarkableStream
46cdf0e10cSrcweir/** makes it possible to set and remove seekable marks to a stream.
47cdf0e10cSrcweir */
48cdf0e10cSrcweirpublished interface XMarkableStream: com::sun::star::uno::XInterface
49cdf0e10cSrcweir{
50cdf0e10cSrcweir	//-------------------------------------------------------------------------
51cdf0e10cSrcweir
52cdf0e10cSrcweir	// DocMerge from xml: method com::sun::star::io::XMarkableStream::createMark
53cdf0e10cSrcweir	/** creates a mark of the current postion and returns an identifier to it.
54cdf0e10cSrcweir	 */
55cdf0e10cSrcweir	long createMark()
56cdf0e10cSrcweir			raises( com::sun::star::io::IOException );
57cdf0e10cSrcweir
58cdf0e10cSrcweir	//-------------------------------------------------------------------------
59cdf0e10cSrcweir
60cdf0e10cSrcweir	// DocMerge from xml: method com::sun::star::io::XMarkableStream::deleteMark
61cdf0e10cSrcweir	/** deletes the mark that you previously created with
62cdf0e10cSrcweir		<member>XMarkableStream::createMark</member>.
63cdf0e10cSrcweir
64cdf0e10cSrcweir		<p>It is an error to delete a mark if other marks after this
65cdf0e10cSrcweir		exist.  In this case, for reasons of robustness, the
66cdf0e10cSrcweir		implementation must delete this mark and all others after
67cdf0e10cSrcweir		this mark.  </p>
68cdf0e10cSrcweir	 */
69cdf0e10cSrcweir	void deleteMark( [in] long Mark )
70cdf0e10cSrcweir			raises( com::sun::star::io::IOException,
71cdf0e10cSrcweir					com::sun::star::lang::IllegalArgumentException );
72cdf0e10cSrcweir
73cdf0e10cSrcweir	//-------------------------------------------------------------------------
74cdf0e10cSrcweir
75cdf0e10cSrcweir	// DocMerge from xml: method com::sun::star::io::XMarkableStream::jumpToMark
76cdf0e10cSrcweir	/** jumps to a previously created mark.
77cdf0e10cSrcweir	 */
78cdf0e10cSrcweir	void jumpToMark( [in] long nMark )
79cdf0e10cSrcweir			raises( com::sun::star::io::IOException,
80cdf0e10cSrcweir					com::sun::star::lang::IllegalArgumentException );
81cdf0e10cSrcweir
82cdf0e10cSrcweir	//-------------------------------------------------------------------------
83cdf0e10cSrcweir
84cdf0e10cSrcweir	/** jumps to the furthest position of the stream.
85cdf0e10cSrcweir		<p> In the inputstream case, a subsequent read call returns
86cdf0e10cSrcweir		data, that was never read or skipped over before. In the
87cdf0e10cSrcweir		outputstream case, a subsequent write call will add
88cdf0e10cSrcweir		new data at the end of the stream without overwriting existing data.
89cdf0e10cSrcweir	 */
90cdf0e10cSrcweir	void jumpToFurthest()
91cdf0e10cSrcweir			raises( com::sun::star::io::IOException );
92cdf0e10cSrcweir
93cdf0e10cSrcweir	//-------------------------------------------------------------------------
94cdf0e10cSrcweir
95cdf0e10cSrcweir	// DocMerge from idl: method com::sun::star::io::XMarkableStream::offsetToMark
96cdf0e10cSrcweir	/** @returns
97cdf0e10cSrcweir			the offset from the current stream position to the
98cdf0e10cSrcweir			mark ("current position" - "mark position").
99cdf0e10cSrcweir
100cdf0e10cSrcweir		@param nMark
101cdf0e10cSrcweir			identifies the mark which is used as a base
102cdf0e10cSrcweir			to calculate the offset of the current position.
103cdf0e10cSrcweir
104cdf0e10cSrcweir		@throws IllegalArgumentException
105cdf0e10cSrcweir			if the mark does not exist or is deleted.
106cdf0e10cSrcweir
107cdf0e10cSrcweir		@throws IOException
108cdf0e10cSrcweir			if an I/O error has occurred.
109cdf0e10cSrcweir	 */
110cdf0e10cSrcweir	long offsetToMark( [in] long nMark )
111cdf0e10cSrcweir			raises( com::sun::star::io::IOException,
112cdf0e10cSrcweir					com::sun::star::lang::IllegalArgumentException );
113cdf0e10cSrcweir
114cdf0e10cSrcweir};
115cdf0e10cSrcweir
116cdf0e10cSrcweir//=============================================================================
117cdf0e10cSrcweir
118cdf0e10cSrcweir}; }; }; };
119cdf0e10cSrcweir
120cdf0e10cSrcweir/*=============================================================================
121cdf0e10cSrcweir
122cdf0e10cSrcweir=============================================================================*/
123cdf0e10cSrcweir#endif
124