offapi/com/sun/star/ucb/XSimpleFileAccess3.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: XSimpleFileAccess3.idl,v $
  10  * $Revision: 1.7 $
  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
  31 #ifndef __com_sun_star_ucb_XSimpleFileAccess3_idl__
  32 #define __com_sun_star_ucb_XSimpleFileAccess3_idl__
  33
  34 #ifndef __com_sun_star_ucb_XSimpleFileAccess2_idl__
  35 #include <com/sun/star/ucb/XSimpleFileAccess2.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_io_XInputStream_idl__
  39 #include <com/sun/star/io/XInputStream.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_uno_Exception_idl__
  43 #include <com/sun/star/uno/Exception.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module ucb {
  49
  50 //=============================================================================
  51 /** This is an extension to the interface <type>XSimpleFileAccess2</type>.
  52
  53     @since OOo 1.1.2
  54 */
  55 published interface XSimpleFileAccess3 : com::sun::star::ucb::XSimpleFileAccess2
  56 {
  57     //-------------------------------------------------------------------------
  58     /** Checks if a file is "hidden"
  59
  60         @param FileURL
  61         URL to be checked
  62
  63         @return
  64         true, if the given File is "hidden", false otherwise
  65     */
  66     boolean isHidden( [in] string FileURL )
  67         raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
  68
  69     //-------------------------------------------------------------------------
  70     /** Sets the "hidden" of a file according to the boolean parameter,
  71         if the actual process has the right to do so and the used
  72         operation system supports this operation.
  73
  74         @param bHidden
  75         true; "hidden" flag will be set, false; "hidden" flag will be reset
  76     */
  77     void setHidden( [in] string FileURL, [in] boolean bHidden )
  78         raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
  79
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; }; };
  85
  86 #endif