offapi/com/sun/star/datatransfer/XSystemTransferable.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: XSystemTransferable.idl,v $
  10  * $Revision: 1.7 $
  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
  31 #ifndef __com_sun_star_datatransfer_XSystemTransferable_idl__
  32 #define __com_sun_star_datatransfer_XSystemTransferable_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module datatransfer {
  41
  42 //=============================================================================
  43 /** Interface to be implemented by  objects used to provide system dependent data
  44     for a transfer operation. Those objects usually also implement <type>XTransferable</type>.
  45 */
  46
  47 published interface XSystemTransferable: com::sun::star::uno::XInterface
  48 {
  49     //-------------------------------------------------------------------------
  50     /** Called by a data consumer to obtain a system specific data object from the
  51         source.
  52         The data object is returned in an any. The contained type may differ on
  53         different platforms.
  54
  55         @param aProcessId
  56         The argument aProcessId is a process identifier of the caller's process.
  57         The interface implementation must ensure that the system data object can be
  58         used in that process. If the data object is not valid in the caller process
  59         then the returned any must be empty.
  60
  61         @returns
  62         The system dependent data object.
  63
  64         <br/><br/><p><strong>Notes:</strong>Under Windows the returned any contains an unsigned long which represents a pointer to
  65         an IDataObject interface. The caller of getData has to release the data
  66         object (IDataObject::Release) if it is no longer needed.
  67         The caller must also make sure that the current thread has been initialized for
  68         OLE (use OleInitialize).</p>
  69     */
  70     any getData( [in] sequence < byte > aProcessId);
  71 };
  72
  73 }; }; }; };
  74
  75 #endif