1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_datatransfer_clipboard_XClipboard_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_datatransfer_clipboard_XClipboard_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_datatransfer_XTransferable_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/datatransfer/XTransferable.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski//============================================================================= 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module datatransfer { module clipboard { 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================= 40*b1cdbd2cSJim Jagielski/** The default interface to access clipboard instances. 41*b1cdbd2cSJim Jagielski*/ 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski published interface XClipboardListener; 44*b1cdbd2cSJim Jagielski published interface XClipboardOwner; 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielskipublished interface XClipboard: com::sun::star::uno::XInterface 47*b1cdbd2cSJim Jagielski{ 48*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 49*b1cdbd2cSJim Jagielski /** To get the current content of the clipboard. 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski @returns 52*b1cdbd2cSJim Jagielski The transferable object representing the current content of 53*b1cdbd2cSJim Jagielski this clipboard. 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski @see com::sun::star::datatransfer::XTransferable 56*b1cdbd2cSJim Jagielski */ 57*b1cdbd2cSJim Jagielski XTransferable getContents(); 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 60*b1cdbd2cSJim Jagielski /** Sets the current contents of the clipboard to the specified 61*b1cdbd2cSJim Jagielski transferable object and registers the specified clipboard owner 62*b1cdbd2cSJim Jagielski as the owner of the new contents. 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski @param xTrans 65*b1cdbd2cSJim Jagielski The transferable object to set as new content. 66*b1cdbd2cSJim Jagielski <p>If the given <type scope="com::sun::star::datatransfer">XTransferable</type> 67*b1cdbd2cSJim Jagielski has no <type scope="com::sun::star::datatransfer">DataFlavor</type> the clipboard 68*b1cdbd2cSJim Jagielski will be deleted. 69*b1cdbd2cSJim Jagielski <p>A NULL value is not allowed.</p> 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski @param xClipboardOwner 72*b1cdbd2cSJim Jagielski The new owner of the clipboard. 73*b1cdbd2cSJim Jagielski <p>NULL is an acceptable value and means that the 74*b1cdbd2cSJim Jagielski caller is not interested in lost ownership notifications.</p> 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski @see com::sun::star::datatransfer::XTransferable 77*b1cdbd2cSJim Jagielski @see com::sun::star::datatransfer::clipboard::XClipboardOwner 78*b1cdbd2cSJim Jagielski */ 79*b1cdbd2cSJim Jagielski [oneway] void setContents( [in] XTransferable xTrans, [in] XClipboardOwner xClipboardOwner ); 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 82*b1cdbd2cSJim Jagielski /** To get the name of the clipboard instance. 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski @returns 85*b1cdbd2cSJim Jagielski The name of this clipboard object. 86*b1cdbd2cSJim Jagielski <p>If the returned string is empty the 87*b1cdbd2cSJim Jagielski clipboard instance ist the system clipboard.</p> 88*b1cdbd2cSJim Jagielski */ 89*b1cdbd2cSJim Jagielski string getName(); 90*b1cdbd2cSJim Jagielski}; 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski//============================================================================= 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski}; }; }; }; }; 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski#endif 97