xref: /aoo41x/main/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl (revision 34c958ab)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#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>.

	@since OpenOffice 1.1.2
*/
published 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