offapi/com/sun/star/datatransfer/clipboard/XClipboardFactory.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: XClipboardFactory.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_XClipboardFactory_idl__
  32 #define __com_sun_star_datatransfer_clipboard_XClipboardFactory_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_uno_XInterface_idl__
  39 #include <com/sun/star/uno/XInterface.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module datatransfer { module clipboard {
  45
  46  published interface XClipboard;
  47
  48 //=============================================================================
  49 /** Should be implemented by a clipboard factory that simplifies the creation of
  50     multiple clipboard instances.
  51
  52     @see com::sun::star::datatransfer::clipboard::XClipboard
  53 */
  54
  55 published interface XClipboardFactory: com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58     /** Creates a new named clipboard instance.
  59
  60         @returns
  61         A newly created instance of a <type>GenericClipboard</type>
  62         implementation.
  63
  64         @param aName
  65         The name the clipboard should have.
  66
  67         @throws com::sun::star::lang::IllegalArgumentException
  68         If an empty string is passed as clipboard name.
  69     */
  70     XClipboard createClipboard( [in] string aName )
  71         raises ( com::sun::star::lang::IllegalArgumentException );
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; }; };
  77
  78 #endif