summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/ucb/XRecycler.idl
blob: c201153dc98c88707768e75350c1d289a8767c40 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_ucb_XRecycler_idl__
#define __com_sun_star_ucb_XRecycler_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/ucb/XContentIdentifier.idl>
#include <com/sun/star/ucb/XCommandProcessor.idl>


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

/** Allows an XContent 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 XContent 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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */