INTEGRATION: CWS uno2 (1.1.2); FILE ADDED

2003/04/04 12:52:25 ab 1.1.2.1: 107504# Interface to handle hidden flag

1 files changed, 115 insertions, 0 deletions

diff --git a/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl b/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl
new file mode 100644
index 000000000000..32e42de1806c
--- /dev/null
+++ b/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl
@@ -0,0 +1,115 @@
+/*************************************************************************
+ *
+ *  $RCSfile: XSimpleFileAccess3.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2003-04-23 17:14:58 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_ucb_XSimpleFileAccess3_idl__
+#define __com_sun_star_ucb_XSimpleFileAccess3_idl__
+
+#ifndef __com_sun_star_ucb_XSimpleFileAccess2_idl__
+#include <com/sun/star/ucb/XSimpleFileAccess2.idl>
+#endif
+
+#ifndef __com_sun_star_io_XInputStream_idl__
+#include <com/sun/star/io/XInputStream.idl>
+#endif
+
+#ifndef __com_sun_star_uno_Exception_idl__
+#include <com/sun/star/uno/Exception.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module ucb {
+
+//=============================================================================
+/** This is an extension to the interface <type>XSimpleFileAccess2</type>.
+*/
+interface XSimpleFileAccess3 : com::sun::star::ucb::XSimpleFileAccess2
+{
+    //-------------------------------------------------------------------------
+    /** Checks if a file is "hidden"
+
+        @param FileURL
+        URL to be checked
+
+        @return
+        true, if the given File is "hidden", false otherwise
+    */
+    boolean isHidden( [in] string FileURL )
+        raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
+
+    //-------------------------------------------------------------------------
+    /** Sets the "hidden" of a file according to the boolean parameter,
+        if the actual process has the right to do so and the used
+        operation system supports this operation.
+
+        @param bHidden
+        true; "hidden" flag will be set, false; "hidden" flag will be reset
+    */
+    void setHidden( [in] string FileURL, [in] boolean bHidden )
+        raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception );
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif