xref: /aoo41x/main/offapi/com/sun/star/ucb/XRecycler.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_XRecycler_idl__
#define __com_sun_star_ucb_XRecycler_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_ucb_XContentIdentifier_idl__
#include <com/sun/star/ucb/XContentIdentifier.idl>
#endif

#ifndef __com_sun_star_ucb_XCommandProcessor_idl__
#include <com/sun/star/ucb/XCommandProcessor.idl>
#endif

//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** Allows an <type>XContent</type> to delete itself into the trash can.

	<p>This is an additional interface the XContent representing the trash
	can (URL: "vnd.sun.staroffice.trashcan:///") should support.
*/
published interface XRecycler : com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** Notify the trash can that an <type>XContent</type> is deleting itself
	    into it.

		@param Properties
		The trash can uses this interface to access the	properties of the
		content being deleted, to copy them for later display etc.  The
		trash can will not use the interface after it has returned from this
		method.

		@param Identifier
		When the deleted content is later restored or ultimately deleted, the
		trash can will use this identifier to query an XContent that it will
		send the undelete or delete command to.
	*/
	void trashContent([in] com::sun::star::ucb::XCommandProcessor Properties,
			  		  [in] com::sun::star::ucb::XContentIdentifier Identifier);
};

//=============================================================================

}; }; }; };

#endif