1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_datatransfer_clipboard_XClipboardManager_idl__ 25cdf0e10cSrcweir#define __com_sun_star_datatransfer_clipboard_XClipboardManager_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 28cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_container_ElementExistException_idl__ 32cdf0e10cSrcweir#include <com/sun/star/container/ElementExistException.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir#ifndef __com_sun_star_container_NoSuchElementException_idl__ 36cdf0e10cSrcweir#include <com/sun/star/container/NoSuchElementException.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 40cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 41cdf0e10cSrcweir#endif 42cdf0e10cSrcweir 43cdf0e10cSrcweir//============================================================================= 44cdf0e10cSrcweir 45cdf0e10cSrcweirmodule com { module sun { module star { module datatransfer { module clipboard { 46cdf0e10cSrcweir 47cdf0e10cSrcweir published interface XClipboard; 48cdf0e10cSrcweir 49cdf0e10cSrcweir//============================================================================= 50cdf0e10cSrcweir/** This interface is used to retrieve, add, or remove clipboard instances. 51cdf0e10cSrcweir 52cdf0e10cSrcweir @see com::sun::star::datatransfer::clipboard::XClipboard 53cdf0e10cSrcweir*/ 54cdf0e10cSrcweir 55cdf0e10cSrcweirpublished interface XClipboardManager: com::sun::star::uno::XInterface 56cdf0e10cSrcweir{ 57cdf0e10cSrcweir //------------------------------------------------------------------------- 58cdf0e10cSrcweir /** Get a clipboard instance by name. 59cdf0e10cSrcweir 60cdf0e10cSrcweir @returns 61cdf0e10cSrcweir The clipboard object with the specified name. 62cdf0e10cSrcweir 63cdf0e10cSrcweir @param aName 64cdf0e10cSrcweir The name of clipboard to return. To retrieve the default (system) 65cdf0e10cSrcweir clipboard, pass an empty string. 66cdf0e10cSrcweir 67cdf0e10cSrcweir @throws com::sun::star::container::NoSuchElementException 68cdf0e10cSrcweir if no clipboard with the specified name exists. 69cdf0e10cSrcweir */ 70cdf0e10cSrcweir XClipboard getClipboard( [in] string aName ) 71cdf0e10cSrcweir raises ( com::sun::star::container::NoSuchElementException ); 72cdf0e10cSrcweir 73cdf0e10cSrcweir //------------------------------------------------------------------------- 74cdf0e10cSrcweir /** Add a clipboard instance to the manager's list. 75cdf0e10cSrcweir 76cdf0e10cSrcweir @param xClipboard 77cdf0e10cSrcweir The clipboard to add. 78cdf0e10cSrcweir 79cdf0e10cSrcweir @throws com::sun::star::IllegalArgumentException 80cdf0e10cSrcweir if xClipboard is not a valid clipboard. 81cdf0e10cSrcweir 82cdf0e10cSrcweir @throws com::sun::star::container::ElementExistsException 83cdf0e10cSrcweir if a clipboard with the name of xClipboard already exists. 84cdf0e10cSrcweir */ 85cdf0e10cSrcweir void addClipboard( [in] XClipboard xClipboard ) 86cdf0e10cSrcweir raises ( com::sun::star::lang::IllegalArgumentException, 87cdf0e10cSrcweir com::sun::star::container::ElementExistException ); 88cdf0e10cSrcweir 89cdf0e10cSrcweir //------------------------------------------------------------------------- 90cdf0e10cSrcweir /** Removes the clipboard with the specified name from the list. 91cdf0e10cSrcweir 92cdf0e10cSrcweir @param aName 93cdf0e10cSrcweir The name of the clipboard to remove. 94cdf0e10cSrcweir */ 95cdf0e10cSrcweir void removeClipboard( [in] string aName ); 96cdf0e10cSrcweir 97cdf0e10cSrcweir //------------------------------------------------------------------------- 98cdf0e10cSrcweir /** Get a list of a managed clipboards. 99cdf0e10cSrcweir 100cdf0e10cSrcweir @returns 101cdf0e10cSrcweir A sequence of the names of all available clipboards. 102cdf0e10cSrcweir */ 103cdf0e10cSrcweir sequence < string > listClipboardNames(); 104cdf0e10cSrcweir}; 105cdf0e10cSrcweir 106cdf0e10cSrcweir//============================================================================= 107cdf0e10cSrcweir 108cdf0e10cSrcweir}; }; }; }; }; 109cdf0e10cSrcweir 110cdf0e10cSrcweir#endif 111