udkapi/com/sun/star/io/XTempFile.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XTempFile.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_io_XTempFile_idl__
  31 #define __com_sun_star_io_XTempFile_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_io_XStream_idl__
  38 #include <com/sun/star/io/XStream.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_io_XSeekable_idl__
  42 #include <com/sun/star/io/XSeekable.idl>
  43 #endif
  44
  45
  46 //========================================================================
  47 module com { module sun { module star { module io {
  48
  49 //========================================================================
  50 /** This interface offers access to temp files.
  51  */
  52 interface XTempFile
  53 {
  54     // INTERFACES
  55     //
  56     // -------------------------------------------------------------------
  57     /** interface <type>XStream</type> offers read and write access to
  58         the same stream.
  59     */
  60     interface XStream;
  61
  62     // --------------------------------------------------------------------
  63     /** interface <type>XSeekable</type> makes it possible to seek to a
  64         certain position within a stream.
  65     */
  66     interface XSeekable;
  67
  68     // ATTRIBUTES
  69     //
  70     // --------------------------------------------------------------------
  71     /** This attribute controls whether the file will be automatically
  72         removed on object destruction.
  73     */
  74     [attribute] boolean RemoveFile;
  75
  76     // --------------------------------------------------------------------
  77     /** This attribute specifies the URL of the temp file.
  78     */
  79     [readonly,attribute] string Uri;
  80
  81     // --------------------------------------------------------------------
  82     /** This attribute specifies the temp file name.
  83     */
  84     [readonly,attribute] string ResourceName;
  85
  86 };
  87
  88 //=========================================================================
  89
  90 }; }; }; };
  91
  92 #endif