offapi/com/sun/star/datatransfer/clipboard/XClipboard.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_clipboard_XClipboard_idl__
  21 #define __com_sun_star_datatransfer_clipboard_XClipboard_idl__
  22
  23 #include <com/sun/star/datatransfer/XTransferable.idl>
  24 #include <com/sun/star/uno/XInterface.idl>
  25
  26
  27 module com { module sun { module star { module datatransfer { module clipboard {
  28
  29 /** The default interface to access clipboard instances.
  30 */
  31
  32  published interface XClipboardListener;
  33  published interface XClipboardOwner;
  34
  35 published interface XClipboard: com::sun::star::uno::XInterface
  36 {
  37     /** To get the current content of the clipboard.
  38
  39         @returns
  40         The transferable object representing the current content of
  41         this clipboard.
  42
  43         @see com::sun::star::datatransfer::XTransferable
  44     */
  45     com::sun::star::datatransfer::XTransferable getContents();
  46
  47     /** Sets the current contents of the clipboard to the specified
  48         transferable object and registers the specified clipboard owner
  49         as the owner of the new contents.
  50
  51         @param xTrans
  52         The transferable object to set as new content.
  53         <p>If the given com::sun::star::datatransfer::XTransferable
  54         has no com::sun::star::datatransfer::DataFlavor the clipboard
  55         will be deleted.
  56         <p>A NULL value is not allowed.</p>
  57
  58         @param xClipboardOwner
  59         The new owner of the clipboard.
  60         <p>NULL is an acceptable value and means that the
  61         caller is not interested in lost ownership notifications.</p>
  62
  63         @see com::sun::star::datatransfer::XTransferable
  64         @see com::sun::star::datatransfer::clipboard::XClipboardOwner
  65     */
  66     void setContents( [in] com::sun::star::datatransfer::XTransferable xTrans, [in] XClipboardOwner xClipboardOwner );
  67
  68     /** To get the name of the clipboard instance.
  69
  70         @returns
  71         The name of this clipboard object.
  72         <p>If the returned string is empty the
  73         clipboard instance is the system clipboard.</p>
  74     */
  75     string getName();
  76 };
  77
  78
  79 }; }; }; }; };
  80
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */