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

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