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