offapi/com/sun/star/ucb/XRecycler.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_XRecycler_idl__
  20 #define __com_sun_star_ucb_XRecycler_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/ucb/XContentIdentifier.idl>
  24 #include <com/sun/star/ucb/XCommandProcessor.idl>
  25
  26
  27 module com { module sun { module star { module ucb {
  28
  29 /** Allows an XContent to delete itself into the trash can.
  30
  31     <p>This is an additional interface the XContent representing the trash
  32     can (URL: "vnd.sun.staroffice.trashcan:///") should support.
  33 */
  34 published interface XRecycler : com::sun::star::uno::XInterface
  35 {
  36     /** Notify the trash can that an XContent is deleting itself
  37         into it.
  38
  39         @param Properties
  40         The trash can uses this interface to access the properties of the
  41         content being deleted, to copy them for later display etc.  The
  42         trash can will not use the interface after it has returned from this
  43         method.
  44
  45         @param Identifier
  46         When the deleted content is later restored or ultimately deleted, the
  47         trash can will use this identifier to query an XContent that it will
  48         send the undelete or delete command to.
  49     */
  50     void trashContent([in] com::sun::star::ucb::XCommandProcessor Properties,
  51                         [in] com::sun::star::ucb::XContentIdentifier Identifier);
  52 };
  53
  54
  55 }; }; }; };
  56
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */