diff options
Diffstat (limited to 'offapi/com/sun/star/datatransfer/XTransferable.idl')
-rw-r--r-- | offapi/com/sun/star/datatransfer/XTransferable.idl | 139 |
1 files changed, 139 insertions, 0 deletions
diff --git a/offapi/com/sun/star/datatransfer/XTransferable.idl b/offapi/com/sun/star/datatransfer/XTransferable.idl new file mode 100644 index 000000000000..ae3664653006 --- /dev/null +++ b/offapi/com/sun/star/datatransfer/XTransferable.idl @@ -0,0 +1,139 @@ +/************************************************************************* + * + * $RCSfile: XTransferable.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:18 $ + * + * 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_XTransferable_idl__ +#define __com_sun_star_datatransfer_XTransferable_idl__ + +#ifndef __com_sun_star_datatransfer_UnsupportedFlavorException_idl__ +#include <com/sun/star/datatransfer/UnsupportedFlavorException.idl> +#endif + +#ifndef __com_sun_star_datatransfer_DataFlavor_idl__ +#include <com/sun/star/datatransfer/DataFlavor.idl> +#endif + +#ifndef __com_sun_star_io_IOException_idl__ +#include <com/sun/star/io/IOException.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 { + +//============================================================================= +/** Interface to be implemented by objects used to provide data for a transfer + operation. + + @see com::sun::star::datatransfer::DataFlavor +*/ + +[ uik(8FDF5C80-0498-11d4-9F4C0050-04D765F1), ident("XTransferable", 0.1) ] +interface XTransferable: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + /** Called by a data consumer to obtain data from the source in a specified + format. + + @returns + the data in the specified data flavor. + + @throws com::sun::star::io::IOException + if the data is no longer available in the requested flavor. + + @throws UnsupportedFlavorException + if the requested data flavor is not supported. + */ + [const] any getTransferData( [in] DataFlavor aFlavor ) + raises ( UnsupportedFlavorException, com::sun::star::io::IOException ); + + //------------------------------------------------------------------------- + /** Returns the list of supported data flavors. + + @returns + the list of supported data flavors. + */ + [const] sequence < DataFlavor > getTransferDataFlavors(); + + //------------------------------------------------------------------------- + /** Checks if the data object supports the specified data flavor. + + @returns + </TRUE> if the data flavor is supported by the transfer source, + </FALSE> otherwise. + + @remarks + This method is only for analogy with the JAVA Clipboard interface. To + avoid many calls the caller should rather use getRansferDataFlavors. + + @see com::sun::star::datatransfer::XTransferable::getRansferDataFlavors + */ + [const] boolean isDataFlavorSupported( [in] DataFlavor aFlavor ); +}; + +//============================================================================= + +}; }; }; }; + +#endif |