xref: /aoo4110/main/udkapi/com/sun/star/io/XTempFile.idl (revision b1cdbd2c)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_io_XTempFile_idl__
24#define __com_sun_star_io_XTempFile_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_io_XStream_idl__
31#include <com/sun/star/io/XStream.idl>
32#endif
33
34#ifndef __com_sun_star_io_XSeekable_idl__
35#include <com/sun/star/io/XSeekable.idl>
36#endif
37
38
39//========================================================================
40module com { module sun { module star { module io {
41
42//========================================================================
43/** This interface offers access to temp files.
44 */
45published interface XTempFile
46{
47    // INTERFACES
48    //
49    // -------------------------------------------------------------------
50    /** interface <type>XStream</type> offers read and write access to
51        the same stream.
52    */
53    interface XStream;
54
55    // --------------------------------------------------------------------
56    /** interface <type>XSeekable</type> makes it possible to seek to a
57        certain position within a stream.
58    */
59    interface XSeekable;
60
61    // ATTRIBUTES
62    //
63    // --------------------------------------------------------------------
64    /** This attribute controls whether the file will be automatically
65        removed on object destruction.
66    */
67    [attribute] boolean RemoveFile;
68
69    // --------------------------------------------------------------------
70    /** This attribute specifies the URL of the temp file.
71    */
72    [readonly,attribute] string Uri;
73
74    // --------------------------------------------------------------------
75    /** This attribute specifies the temp file name.
76    */
77    [readonly,attribute] string ResourceName;
78
79};
80
81//=========================================================================
82
83}; }; }; };
84
85#endif
86