offapi/com/sun/star/datatransfer/clipboard/XClipboard.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: XClipboard.idl,v $
  10  * $Revision: 1.8 $
  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_clipboard_XClipboard_idl__
  32 #define __com_sun_star_datatransfer_clipboard_XClipboard_idl__
  33
  34 #ifndef __com_sun_star_datatransfer_XTransferable_idl__
  35 #include <com/sun/star/datatransfer/XTransferable.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_uno_XInterface_idl__
  39 #include <com/sun/star/uno/XInterface.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module datatransfer { module clipboard {
  45
  46 //=============================================================================
  47 /** The default interface to access clipboard instances.
  48 */
  49
  50  published interface XClipboardListener;
  51  published interface XClipboardOwner;
  52
  53 published interface XClipboard: com::sun::star::uno::XInterface
  54 {
  55     //-------------------------------------------------------------------------
  56     /** To get the current content of the clipboard.
  57
  58         @returns
  59         The transferable object representing the current content of
  60         this clipboard.
  61
  62         @see com::sun::star::datatransfer::XTransferable
  63     */
  64     XTransferable getContents();
  65
  66     //-------------------------------------------------------------------------
  67     /** Sets the current contents of the clipboard to the specified
  68         transferable object and registers the specified clipboard owner
  69         as the owner of the new contents.
  70
  71         @param xTrans
  72         The transferable object to set as new content.
  73         <p>If the given <type scope="com::sun::star::datatransfer">XTransferable</type>
  74         has no <type scope="com::sun::star::datatransfer">DataFlavor</type> the clipboard
  75         will be deleted.
  76         <p>A NULL value is not allowed.</p>
  77
  78         @param xClipboardOwner
  79         The new owner of the clipboard.
  80         <p>NULL is an acceptable value and means that the
  81         caller is not interested in lost ownership notifications.</p>
  82
  83         @see com::sun::star::datatransfer::XTransferable
  84         @see com::sun::star::datatransfer::clipboard::XClipboardOwner
  85     */
  86     [oneway] void setContents( [in] XTransferable xTrans, [in] XClipboardOwner xClipboardOwner );
  87
  88     //-------------------------------------------------------------------------
  89     /** To get the name of the clipboard instance.
  90
  91         @returns
  92         The name of this clipboard object.
  93         <p>If the returned string is empty the
  94         clipboard instance ist the system clipboard.</p>
  95     */
  96     string getName();
  97 };
  98
  99 //=============================================================================
 100
 101 }; }; }; }; };
 102
 103 #endif