merged tag ooo/OOO330_m14
[LibreOffice.git] / offapi / com / sun / star / ucb / XRecycler.idl
blobe3e193b6c460e74e6c4d064f6a4a10491c27080f
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * This file is part of OpenOffice.org.
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org. If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
26 ************************************************************************/
27 #ifndef __com_sun_star_ucb_XRecycler_idl__
28 #define __com_sun_star_ucb_XRecycler_idl__
30 #ifndef __com_sun_star_uno_XInterface_idl__
31 #include <com/sun/star/uno/XInterface.idl>
32 #endif
34 #ifndef __com_sun_star_ucb_XContentIdentifier_idl__
35 #include <com/sun/star/ucb/XContentIdentifier.idl>
36 #endif
38 #ifndef __com_sun_star_ucb_XCommandProcessor_idl__
39 #include <com/sun/star/ucb/XCommandProcessor.idl>
40 #endif
42 //=============================================================================
44 module com { module sun { module star { module ucb {
46 //=============================================================================
47 /** Allows an <type>XContent</type> to delete itself into the trash can.
49 <p>This is an additional interface the XContent representing the trash
50 can (URL: "vnd.sun.staroffice.trashcan:///") should support.
52 published interface XRecycler : com::sun::star::uno::XInterface
54 //-------------------------------------------------------------------------
55 /** Notify the trash can that an <type>XContent</type> is deleting itself
56 into it.
58 @param Properties
59 The trash can uses this interface to access the properties of the
60 content being deleted, to copy them for later display etc. The
61 trash can will not use the interface after it has returned from this
62 method.
64 @param Identifier
65 When the deleted content is later restored or ultimately deleted, the
66 trash can will use this identifier to query an XContent that it will
67 send the undelete or delete command to.
69 void trashContent([in] com::sun::star::ucb::XCommandProcessor Properties,
70 [in] com::sun::star::ucb::XContentIdentifier Identifier);
73 //=============================================================================
75 }; }; }; };
77 #endif