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