xref: /aoo42x/main/offapi/com/sun/star/ucb/XRecycler.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_XRecycler_idl__
24#define __com_sun_star_ucb_XRecycler_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_ucb_XContentIdentifier_idl__
31#include <com/sun/star/ucb/XContentIdentifier.idl>
32#endif
33
34#ifndef __com_sun_star_ucb_XCommandProcessor_idl__
35#include <com/sun/star/ucb/XCommandProcessor.idl>
36#endif
37
38//=============================================================================
39
40module com { module sun { module star { module ucb {
41
42//=============================================================================
43/** Allows an <type>XContent</type> to delete itself into the trash can.
44
45	<p>This is an additional interface the XContent representing the trash
46	can (URL: "vnd.sun.staroffice.trashcan:///") should support.
47*/
48published interface XRecycler : com::sun::star::uno::XInterface
49{
50	//-------------------------------------------------------------------------
51	/** Notify the trash can that an <type>XContent</type> is deleting itself
52	    into it.
53
54		@param Properties
55		The trash can uses this interface to access the	properties of the
56		content being deleted, to copy them for later display etc.  The
57		trash can will not use the interface after it has returned from this
58		method.
59
60		@param Identifier
61		When the deleted content is later restored or ultimately deleted, the
62		trash can will use this identifier to query an XContent that it will
63		send the undelete or delete command to.
64	*/
65	void trashContent([in] com::sun::star::ucb::XCommandProcessor Properties,
66			  		  [in] com::sun::star::ucb::XContentIdentifier Identifier);
67};
68
69//=============================================================================
70
71}; }; }; };
72
73#endif
74