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