offapi/com/sun/star/ucb/XSimpleFileAccess3.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_ucb_XSimpleFileAccess3_idl__
  29 #define __com_sun_star_ucb_XSimpleFileAccess3_idl__
  30
  31 #ifndef __com_sun_star_ucb_XSimpleFileAccess2_idl__
  32 #include <com/sun/star/ucb/XSimpleFileAccess2.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_io_XInputStream_idl__
  36 #include <com/sun/star/io/XInputStream.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_uno_Exception_idl__
  40 #include <com/sun/star/uno/Exception.idl>
  41 #endif
  42
  43 //=============================================================================
  44
  45 module com { module sun { module star { module ucb {
  46
  47 //=============================================================================
  48 /** This is an extension to the interface <type>XSimpleFileAccess2</type>.
  49
  50     @since OOo 1.1.2
  51 */
  52 published interface XSimpleFileAccess3 : com::sun::star::ucb::XSimpleFileAccess2
  53 {
  54     //-------------------------------------------------------------------------
  55     /** Checks if a file is "hidden"
  56
  57         @param FileURL
  58         URL to be checked
  59
  60         @return
  61         true, if the given File is "hidden", false otherwise
  62     */
  63     boolean isHidden( [in] string FileURL )
  64         raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
  65
  66     //-------------------------------------------------------------------------
  67     /** Sets the "hidden" of a file according to the boolean parameter,
  68         if the actual process has the right to do so and the used
  69         operation system supports this operation.
  70
  71         @param bHidden
  72         true; "hidden" flag will be set, false; "hidden" flag will be reset
  73     */
  74     void setHidden( [in] string FileURL, [in] boolean bHidden )
  75         raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
  76
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 #endif