1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28#ifndef __com_sun_star_datatransfer_clipboard_XClipboardManager_idl__ 29#define __com_sun_star_datatransfer_clipboard_XClipboardManager_idl__ 30 31#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 32#include <com/sun/star/lang/IllegalArgumentException.idl> 33#endif 34 35#ifndef __com_sun_star_container_ElementExistException_idl__ 36#include <com/sun/star/container/ElementExistException.idl> 37#endif 38 39#ifndef __com_sun_star_container_NoSuchElementException_idl__ 40#include <com/sun/star/container/NoSuchElementException.idl> 41#endif 42 43#ifndef __com_sun_star_uno_XInterface_idl__ 44#include <com/sun/star/uno/XInterface.idl> 45#endif 46 47//============================================================================= 48 49module com { module sun { module star { module datatransfer { module clipboard { 50 51 published interface XClipboard; 52 53//============================================================================= 54/** This interface is used to retrieve, add, or remove clipboard instances. 55 56 @see com::sun::star::datatransfer::clipboard::XClipboard 57*/ 58 59published interface XClipboardManager: com::sun::star::uno::XInterface 60{ 61 //------------------------------------------------------------------------- 62 /** Get a clipboard instance by name. 63 64 @returns 65 The clipboard object with the specified name. 66 67 @param aName 68 The name of clipboard to return. To retrieve the default (system) 69 clipboard, pass an empty string. 70 71 @throws com::sun::star::container::NoSuchElementException 72 if no clipboard with the specified name exists. 73 */ 74 XClipboard getClipboard( [in] string aName ) 75 raises ( com::sun::star::container::NoSuchElementException ); 76 77 //------------------------------------------------------------------------- 78 /** Add a clipboard instance to the manager's list. 79 80 @param xClipboard 81 The clipboard to add. 82 83 @throws com::sun::star::IllegalArgumentException 84 if xClipboard is not a valid clipboard. 85 86 @throws com::sun::star::container::ElementExistsException 87 if a clipboard with the name of xClipboard already exists. 88 */ 89 void addClipboard( [in] XClipboard xClipboard ) 90 raises ( com::sun::star::lang::IllegalArgumentException, 91 com::sun::star::container::ElementExistException ); 92 93 //------------------------------------------------------------------------- 94 /** Removes the clipboard with the specified name from the list. 95 96 @param aName 97 The name of the clipboard to remove. 98 */ 99 void removeClipboard( [in] string aName ); 100 101 //------------------------------------------------------------------------- 102 /** Get a list of a managed clipboards. 103 104 @returns 105 A sequence of the names of all available clipboards. 106 */ 107 sequence < string > listClipboardNames(); 108}; 109 110//============================================================================= 111 112}; }; }; }; }; 113 114#endif 115