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