offapi/com/sun/star/datatransfer/clipboard/XClipboardManager.idl

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