/*************************************************************************
 *
 *  $RCSfile: XClipboardManager.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: mi $ $Date: 2002/10/03 13:03:14 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef __com_sun_star_datatransfer_clipboard_XClipboardManager_idl__
#define __com_sun_star_datatransfer_clipboard_XClipboardManager_idl__

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_container_ElementExistException_idl__
#include <com/sun/star/container/ElementExistException.idl>
#endif

#ifndef __com_sun_star_container_NoSuchElementException_idl__
#include <com/sun/star/container/NoSuchElementException.idl>
#endif

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

//=============================================================================

module com { module sun { module star { module datatransfer { module clipboard {

interface XClipboard;
				
//=============================================================================
/** This interface is used to retrieve, add, or remove clipboard instances.
 
	@see com::sun::star::datatransfer::clipboard::XClipboard
*/

interface XClipboardManager: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** Get a clipboard instance by name.
		
		@returns 
		The clipboard object with the specified name.

		@param aName 
		The name of clipboard to return. To retrieve the default (system) 
		clipboard, pass an empty string.

		@throws com::sun::star::container::NoSuchElementException
		if no clipboard with the specified name exists.
	*/
    XClipboard getClipboard( [in] string aName )
		raises ( com::sun::star::container::NoSuchElementException );

	//-------------------------------------------------------------------------
	/** Add a clipboard instance to the manager's list.

		@param xClipboard
		The clipboard to add. 

		@throws com::sun::star::IllegalArgumentException
		if xClipboard is not a valid clipboard.

		@throws com::sun::star::container::ElementExistsException
		if a clipboard with the name of xClipboard already exists.
    */
    void addClipboard( [in] XClipboard xClipboard )
		raises ( com::sun::star::lang::IllegalArgumentException,
		         com::sun::star::container::ElementExistException );

	//-------------------------------------------------------------------------
	/** Removes the clipboard with the specified name from the list.

		@param aName 
		The name of the clipboard to remove.
    */
    void removeClipboard( [in] string aName );

	//-------------------------------------------------------------------------
	/** Get a list of a managed clipboards.

		@returns 
		A sequence of the names of all available clipboards.
     */
	sequence < string > listClipboardNames();
};

//=============================================================================

}; }; }; }; };

#endif
