diff options
Diffstat (limited to 'offapi/com/sun/star/datatransfer')
50 files changed, 309 insertions, 309 deletions
diff --git a/offapi/com/sun/star/datatransfer/DataFlavor.idl b/offapi/com/sun/star/datatransfer/DataFlavor.idl index b8c258bc40db..2c0e4a7715f5 100644 --- a/offapi/com/sun/star/datatransfer/DataFlavor.idl +++ b/offapi/com/sun/star/datatransfer/DataFlavor.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -40,15 +40,15 @@ module com { module sun { module star { module datatransfer { published struct DataFlavor { //------------------------------------------------------------------------- - /** The MIME content-type (type/subtype) string describing the data format + /** The MIME content-type (type/subtype) string describing the data format of the object to transfer. MimeType must be conform to <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and - <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>) - */ + <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>) + */ string MimeType; //------------------------------------------------------------------------- /** A human presentable name for the data format. - */ + */ string HumanPresentableName; //------------------------------------------------------------------------- @@ -59,6 +59,6 @@ published struct DataFlavor //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl b/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl index 29e9479f4a01..498cf3161329 100644 --- a/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl +++ b/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -38,15 +38,15 @@ //============================================================================= -module com { module sun { module star { module datatransfer { +module com { module sun { module star { module datatransfer { //============================================================================= published interface XDataFormatTranslator; //============================================================================= -/** Different platforms use different types to describe data formats available - during data exchange operations like clipboard or drag&drop. +/** Different platforms use different types to describe data formats available + during data exchange operations like clipboard or drag&drop. Implementations of this service do convert system dependent data types to a <type>DataFlavor</type> and vice versa. diff --git a/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl b/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl index 82deb7314b0c..818184a93b8a 100644 --- a/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl +++ b/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -42,17 +42,17 @@ //============================================================================= -module com { module sun { module star { module datatransfer { +module com { module sun { module star { module datatransfer { //============================================================================= published interface XMimeContentTypeFactory; //============================================================================= -/** Used to create an instance that implement the interface - <type>XMimeContentType</type> from a string - representation of such a MIME content-type that is conform to - <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and +/** Used to create an instance that implement the interface + <type>XMimeContentType</type> from a string + representation of such a MIME content-type that is conform to + <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>. @see com::sun::star::datatransfer::XMimeContentTypeFactory @@ -60,11 +60,11 @@ module com { module sun { module star { module datatransfer { published service MimeContentTypeFactory { //------------------------------------------------------------------------- - /** Creates an instance that implement the interface - <type>XMimeContentType</type> from the string + /** Creates an instance that implement the interface + <type>XMimeContentType</type> from the string representation of such a MIME content-types that is conform to <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a>, - <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>. + <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>. */ interface XMimeContentTypeFactory; diff --git a/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl b/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl index 0d0ffda23547..0cc5eef93454 100644 --- a/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl +++ b/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -37,7 +37,7 @@ module com { module sun { module star { module datatransfer { //============================================================================= -/** Exception will be thrown if there is a request for data in a +/** Exception will be thrown if there is a request for data in a <type>DataFlavor</type> that is not supported by a data source. @see com::sun::star::datatransfer::DataFlavor @@ -49,6 +49,6 @@ published exception UnsupportedFlavorException: com::sun::star::uno::Exception //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl b/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl index aad2882af77b..4844886d437f 100644 --- a/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl +++ b/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -40,13 +40,13 @@ module com { module sun { module star { module datatransfer { //============================================================================= -/** Interface to be implemented by objects used to translate a <type>DataFlavor</type> to - a system dependent data transfer type and vice versa. +/** Interface to be implemented by objects used to translate a <type>DataFlavor</type> to + a system dependent data transfer type and vice versa. - <p>Different platforms use different types to describe data formats available + <p>Different platforms use different types to describe data formats available during data exchange operations like clipboard or drag&drop. Windows for instance - uses integer values to describe an available clipboard or drag&drop format, Unix - X11 uses so called Atoms etc.</p> + uses integer values to describe an available clipboard or drag&drop format, Unix + X11 uses so called Atoms etc.</p> */ published interface XDataFormatTranslator : com::sun::star::uno::XInterface @@ -59,7 +59,7 @@ published interface XDataFormatTranslator : com::sun::star::uno::XInterface @returns A system dependent data transfer type for the given <type>DataFlavor</type> - if there is one available. + if there is one available. <p>If the is no system dependent data type for a given <type>DataFlavor</type> the returned any is empty.</p> */ @@ -71,7 +71,7 @@ published interface XDataFormatTranslator : com::sun::star::uno::XInterface @param aSysDataType A system dependent data type. If aSysDataType is empty so is the returned <type>DataFlavor</type>. - @returns + @returns A <type>DataFlavor</type> for the given system dependent data transfer type. <p>If there is no appropriate mapping for a sytem dependent data type, the returned <type>DataFlavor</type> will be empty.</p> */ diff --git a/offapi/com/sun/star/datatransfer/XMimeContentType.idl b/offapi/com/sun/star/datatransfer/XMimeContentType.idl index ccfee62c6a2b..a91a4bef6a65 100644 --- a/offapi/com/sun/star/datatransfer/XMimeContentType.idl +++ b/offapi/com/sun/star/datatransfer/XMimeContentType.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -40,8 +40,8 @@ module com { module sun { module star { module datatransfer { //------------------------------------------------------------------------- -/** An implementation of this interface represents a MIME content-type that - is conform to <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and +/** An implementation of this interface represents a MIME content-type that + is conform to <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>. Instances that implement this interface could be created using the interface <type>XMimeContentTypeFactory</type>. @@ -80,10 +80,10 @@ published interface XMimeContentType : com::sun::star::uno::XInterface A list of the names of all parameters of the MIME content-type. */ sequence< string > getParameters( ); - + //------------------------------------------------------------------------- /** To query if a specific parameter is supported. - + @param aName The name of the parameter to query for. @@ -94,7 +94,7 @@ published interface XMimeContentType : com::sun::star::uno::XInterface boolean hasParameter( [in] string aName ); //------------------------------------------------------------------------- - /** To get the value of a specified parameter. + /** To get the value of a specified parameter. @param aName The name of the parameter for which the value is requested. diff --git a/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl b/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl index 5b7df3168c3b..93b515a1c6b2 100644 --- a/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl +++ b/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -44,12 +44,12 @@ module com { module sun { module star { module datatransfer { //------------------------------------------------------------------------- -/** Implementations of this interface do create a +/** Implementations of this interface do create a <type scope="com::sun::star::datatransfer">XMimeContentType</type> from - a given string that represents a MIME content-type - (see <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and + a given string that represents a MIME content-type + (see <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>). - + */ published interface XMimeContentTypeFactory : com::sun::star::uno::XInterface { @@ -57,16 +57,16 @@ published interface XMimeContentTypeFactory : com::sun::star::uno::XInterface /** Creates an object that implements <type>XMimeContentType</type>. @param aContentType - A string that represents a MIME content-type as specified in - <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and + A string that represents a MIME content-type as specified in + <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>. @returns An object that implements <type>XMimeContentType</type>. - + @throws com::sun::star::lang::IllegalArgumentException - if the string does not conform to - <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and + if the string does not conform to + <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>; <p><strong>Exception:</strong> Quoted parameter values may contain spaces.</p> diff --git a/offapi/com/sun/star/datatransfer/XSystemTransferable.idl b/offapi/com/sun/star/datatransfer/XSystemTransferable.idl index ad634d8a6190..a3c0ff9e5448 100644 --- a/offapi/com/sun/star/datatransfer/XSystemTransferable.idl +++ b/offapi/com/sun/star/datatransfer/XSystemTransferable.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -50,7 +50,7 @@ published interface XSystemTransferable: com::sun::star::uno::XInterface different platforms. @param aProcessId - The argument aProcessId is a process identifier of the caller's process. + The argument aProcessId is a process identifier of the caller's process. The interface implementation must ensure that the system data object can be used in that process. If the data object is not valid in the caller process then the returned any must be empty. @@ -66,7 +66,7 @@ published interface XSystemTransferable: com::sun::star::uno::XInterface */ any getData( [in] sequence < byte > aProcessId); }; - -}; }; }; }; + +}; }; }; }; #endif diff --git a/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl b/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl index 1c766cd1ddd8..d1887eff050f 100644 --- a/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl +++ b/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -54,7 +54,7 @@ published interface XTransferDataAccess: com::sun::star::uno::XInterface /** To query for the summarized data size in bytes of a sequence of <type>DataFlavor</type>. @param aFlavorList - A squence of requested <type>DataFlavor</type>. + A squence of requested <type>DataFlavor</type>. <p>An unsupported <type>DataFlavor</type> will be ignored.</p> @returns @@ -66,11 +66,11 @@ published interface XTransferDataAccess: com::sun::star::uno::XInterface /** To get all the data of a sequence of <type>DataFlavor</type>. @param aFlavorList - The sequence of requested <type>DataFlavor</type>. + The sequence of requested <type>DataFlavor</type>. <p>An unsupported <type>DataFlavor</type> will be ignored.</p> @returns - The data in the requested <type>DataFlavor</type>. + The data in the requested <type>DataFlavor</type>. <p>For unsupported <type>DataFlavor</type> an empty any will be returned.</p> */ @@ -79,6 +79,6 @@ published interface XTransferDataAccess: com::sun::star::uno::XInterface //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/datatransfer/XTransferable.idl b/offapi/com/sun/star/datatransfer/XTransferable.idl index 3336b2d5db0b..7f1b71fc5740 100644 --- a/offapi/com/sun/star/datatransfer/XTransferable.idl +++ b/offapi/com/sun/star/datatransfer/XTransferable.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -49,7 +49,7 @@ module com { module sun { module star { module datatransfer { //============================================================================= -/** Interface to be implemented by objects used to provide data for a data +/** Interface to be implemented by objects used to provide data for a data transfer operation. @see com::sun::star::datatransfer::DataFlavor @@ -58,20 +58,20 @@ module com { module sun { module star { module datatransfer { published interface XTransferable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** Called by a data consumer to obtain data from the source in a specified + /** Called by a data consumer to obtain data from the source in a specified format. - + @param aFlavor - Describes the requested data format + Describes the requested data format @returns The data in the specified <type>DataFlavor</type>. - @throws com::sun::star::io::IOException + @throws com::sun::star::io::IOException if the data is no longer available in the requested flavor. - + @throws com::sun::star::datatransfer::UnsupportedFlavorException - if the requested <type>DataFlavor</type> is not supported. + if the requested <type>DataFlavor</type> is not supported. */ any getTransferData( [in] DataFlavor aFlavor ) raises ( UnsupportedFlavorException, com::sun::star::io::IOException ); @@ -89,22 +89,22 @@ published interface XTransferable: com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** Checks if the data object supports the specified data flavor. - @param aFlavor + @param aFlavor Describes the format that should be checked @returns A value of <TRUE/> if the <type>DataFlavor</type> is supported by the transfer source. <p>A value of <FALSE/> if the <type>DataFlavor</type> is unsupported by the transfer source.</p> - + <br/><br/><p><strong>Note: </strong>This method is only for analogy with the JAVA Clipboard interface. To - avoid many calls, the caller should instead use - <member scope="com::sun::star::datatransfer">XTransferable::getTransferDataFlavors()</member>. + avoid many calls, the caller should instead use + <member scope="com::sun::star::datatransfer">XTransferable::getTransferDataFlavors()</member>. */ boolean isDataFlavorSupported( [in] DataFlavor aFlavor ); }; //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/datatransfer/XTransferableEx.idl b/offapi/com/sun/star/datatransfer/XTransferableEx.idl index ab388725170f..61945aef9484 100644 --- a/offapi/com/sun/star/datatransfer/XTransferableEx.idl +++ b/offapi/com/sun/star/datatransfer/XTransferableEx.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -52,11 +52,11 @@ module com { module sun { module star { module datatransfer { published interface XTransferableEx: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @param requestedFlavors + /** @param requestedFlavors Sequence of <type>DataFlavor</type> of interest. Specify an empty sequence for interest - in all data flavors with top-level MIME content-types. To get all MIME + in all data flavors with top-level MIME content-types. To get all MIME content-types, call <member scope="com::sun::star::datatransfer">XTransferable::getTransferDataFlavors()</member>. - + @returns The list of the matching supported <type>DataFlavor</type> that were requested. For each requested top-level MIME content-type, all supported subtypes are returned. @@ -66,6 +66,6 @@ published interface XTransferableEx: com::sun::star::uno::XInterface //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/datatransfer/XTransferableSource.idl b/offapi/com/sun/star/datatransfer/XTransferableSource.idl index 0ff9bca08302..09fafd9df037 100644 --- a/offapi/com/sun/star/datatransfer/XTransferableSource.idl +++ b/offapi/com/sun/star/datatransfer/XTransferableSource.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -54,6 +54,6 @@ published interface XTransferableSource: com::sun::star::uno::XInterface //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/datatransfer/XTransferableSupplier.idl b/offapi/com/sun/star/datatransfer/XTransferableSupplier.idl index 2cf5c4967597..e616351d2634 100644 --- a/offapi/com/sun/star/datatransfer/XTransferableSupplier.idl +++ b/offapi/com/sun/star/datatransfer/XTransferableSupplier.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/datatransfer/clipboard/ClipboardEvent.idl b/offapi/com/sun/star/datatransfer/clipboard/ClipboardEvent.idl index c7085041b3d0..8506affcadf7 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/ClipboardEvent.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/ClipboardEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -56,6 +56,6 @@ published struct ClipboardEvent: com::sun::star::lang::EventObject //============================================================================= -}; }; }; }; }; +}; }; }; }; }; #endif diff --git a/offapi/com/sun/star/datatransfer/clipboard/ClipboardManager.idl b/offapi/com/sun/star/datatransfer/clipboard/ClipboardManager.idl index 369bfd9c53d0..9159ba0d8c62 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/ClipboardManager.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/ClipboardManager.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -49,9 +49,9 @@ module com { module sun { module star { module datatransfer { module clipboard { published interface XClipboardManager; //============================================================================= -/** The clipboard manager is a one-instance service that holds a list of all +/** The clipboard manager is a one-instance service that holds a list of all known clipboard instances. - + @see XClipboardManager */ published service ClipboardManager diff --git a/offapi/com/sun/star/datatransfer/clipboard/GenericClipboard.idl b/offapi/com/sun/star/datatransfer/clipboard/GenericClipboard.idl index 7a128ee2d108..c8dc1ba56e54 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/GenericClipboard.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/GenericClipboard.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/datatransfer/clipboard/RenderingCapabilities.idl b/offapi/com/sun/star/datatransfer/clipboard/RenderingCapabilities.idl index 5190f52a3ad9..dd71107d231c 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/RenderingCapabilities.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/RenderingCapabilities.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/datatransfer/clipboard/SystemClipboard.idl b/offapi/com/sun/star/datatransfer/clipboard/SystemClipboard.idl index 43a8e0e5ba76..bb068d7310dc 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/SystemClipboard.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/SystemClipboard.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -80,9 +80,9 @@ published service SystemClipboard //------------------------------------------------------------------------- /** Provides the ability to render the complete clipboard content. This - interface is only available if the method + interface is only available if the method <member scope="com::sun::star::datatransfer::clipboard">XClipboardEx::getRenderingCapabilities()</member> - returns Persistant + returns Persistant */ [optional] interface XFlushableClipboard; diff --git a/offapi/com/sun/star/datatransfer/clipboard/XClipboard.idl b/offapi/com/sun/star/datatransfer/clipboard/XClipboard.idl index 11fe45a2a239..af3e25e1422c 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XClipboard.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XClipboard.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -61,8 +61,8 @@ published interface XClipboard: com::sun::star::uno::XInterface XTransferable getContents(); //------------------------------------------------------------------------- - /** Sets the current contents of the clipboard to the specified - transferable object and registers the specified clipboard owner + /** Sets the current contents of the clipboard to the specified + transferable object and registers the specified clipboard owner as the owner of the new contents. @param xTrans @@ -73,10 +73,10 @@ published interface XClipboard: com::sun::star::uno::XInterface <p>A NULL value is not allowed.</p> @param xClipboardOwner - The new owner of the clipboard. + The new owner of the clipboard. <p>NULL is an acceptable value and means that the caller is not interested in lost ownership notifications.</p> - + @see com::sun::star::datatransfer::XTransferable @see com::sun::star::datatransfer::clipboard::XClipboardOwner */ @@ -84,10 +84,10 @@ published interface XClipboard: com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** To get the name of the clipboard instance. - + @returns - The name of this clipboard object. - <p>If the returned string is empty the + The name of this clipboard object. + <p>If the returned string is empty the clipboard instance ist the system clipboard.</p> */ string getName(); diff --git a/offapi/com/sun/star/datatransfer/clipboard/XClipboardEx.idl b/offapi/com/sun/star/datatransfer/clipboard/XClipboardEx.idl index 11f0757fe740..1ced3e55ee34 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XClipboardEx.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XClipboardEx.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/datatransfer/clipboard/XClipboardFactory.idl b/offapi/com/sun/star/datatransfer/clipboard/XClipboardFactory.idl index 24ded33f7239..0b6efa9fec81 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XClipboardFactory.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XClipboardFactory.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -41,11 +41,11 @@ module com { module sun { module star { module datatransfer { module clipboard { published interface XClipboard; - + //============================================================================= /** Should be implemented by a clipboard factory that simplifies the creation of multiple clipboard instances. - + @see com::sun::star::datatransfer::clipboard::XClipboard */ @@ -55,10 +55,10 @@ published interface XClipboardFactory: com::sun::star::uno::XInterface /** Creates a new named clipboard instance. @returns - A newly created instance of a <type>GenericClipboard</type> - implementation. + A newly created instance of a <type>GenericClipboard</type> + implementation. - @param aName + @param aName The name the clipboard should have. @throws com::sun::star::lang::IllegalArgumentException diff --git a/offapi/com/sun/star/datatransfer/clipboard/XClipboardListener.idl b/offapi/com/sun/star/datatransfer/clipboard/XClipboardListener.idl index 36305a4ae412..dd409584190a 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XClipboardListener.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XClipboardListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -42,7 +42,7 @@ module com { module sun { module star { module datatransfer { module clipboard { //============================================================================= /** Interface to be implemented to receive notifications on clipboard content - changes. + changes. */ published interface XClipboardListener: com::sun::star::lang::XEventListener @@ -51,7 +51,7 @@ published interface XClipboardListener: com::sun::star::lang::XEventListener /** The content of the clipboard has changed. @param event - The event object containing the new clipboard content. + The event object containing the new clipboard content. @see com::sun::star::datatransfer::clipboard::ClipboardEvent */ diff --git a/offapi/com/sun/star/datatransfer/clipboard/XClipboardManager.idl b/offapi/com/sun/star/datatransfer/clipboard/XClipboardManager.idl index e9626c9fcd84..3fa46e053594 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XClipboardManager.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XClipboardManager.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -49,10 +49,10 @@ module com { module sun { module star { module datatransfer { module clipboard { published interface XClipboard; - + //============================================================================= /** This interface is used to retrieve, add, or remove clipboard instances. - + @see com::sun::star::datatransfer::clipboard::XClipboard */ @@ -60,12 +60,12 @@ published interface XClipboardManager: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** Get a clipboard instance by name. - - @returns + + @returns The clipboard object with the specified name. - @param aName - The name of clipboard to return. To retrieve the default (system) + @param aName + The name of clipboard to return. To retrieve the default (system) clipboard, pass an empty string. @throws com::sun::star::container::NoSuchElementException @@ -78,7 +78,7 @@ published interface XClipboardManager: com::sun::star::uno::XInterface /** Add a clipboard instance to the manager's list. @param xClipboard - The clipboard to add. + The clipboard to add. @throws com::sun::star::IllegalArgumentException if xClipboard is not a valid clipboard. @@ -93,7 +93,7 @@ published interface XClipboardManager: com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** Removes the clipboard with the specified name from the list. - @param aName + @param aName The name of the clipboard to remove. */ void removeClipboard( [in] string aName ); @@ -101,7 +101,7 @@ published interface XClipboardManager: com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** Get a list of a managed clipboards. - @returns + @returns A sequence of the names of all available clipboards. */ sequence < string > listClipboardNames(); diff --git a/offapi/com/sun/star/datatransfer/clipboard/XClipboardNotifier.idl b/offapi/com/sun/star/datatransfer/clipboard/XClipboardNotifier.idl index 6cfbe19c31f5..5a930b5ada82 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XClipboardNotifier.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XClipboardNotifier.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -52,7 +52,7 @@ published interface XClipboardNotifier: com::sun::star::uno::XInterface @param listener The object receiving the notifications. */ - [oneway] void addClipboardListener( [in] XClipboardListener listener ); + [oneway] void addClipboardListener( [in] XClipboardListener listener ); //------------------------------------------------------------------------- /** Removes listener from notification list. @@ -60,7 +60,7 @@ published interface XClipboardNotifier: com::sun::star::uno::XInterface @param listener The object to remove from notification list. */ - [oneway] void removeClipboardListener( [in] XClipboardListener listener ); + [oneway] void removeClipboardListener( [in] XClipboardListener listener ); }; //============================================================================= diff --git a/offapi/com/sun/star/datatransfer/clipboard/XClipboardOwner.idl b/offapi/com/sun/star/datatransfer/clipboard/XClipboardOwner.idl index 69127087617d..d152b77bfc4b 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XClipboardOwner.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XClipboardOwner.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -42,7 +42,7 @@ module com { module sun { module star { module datatransfer { module clipboard { published interface XClipboard; //============================================================================= -/** The owner of a transferable object may pass this interface to the +/** The owner of a transferable object may pass this interface to the clipboard instance. @see com::sun::star::datatransfer::clipboard::XClipboard diff --git a/offapi/com/sun/star/datatransfer/clipboard/XFlushableClipboard.idl b/offapi/com/sun/star/datatransfer/clipboard/XFlushableClipboard.idl index d3e1682090f7..514e42a5975b 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XFlushableClipboard.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XFlushableClipboard.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -37,13 +37,13 @@ module com { module sun { module star { module datatransfer { module clipboard { //============================================================================= -/** An interface for flushable clipboards may optionally be implemented by a - system clipboard service. +/** An interface for flushable clipboards may optionally be implemented by a + system clipboard service. @see com::sun::star::datatransfer::clipboard::SystemClipboard */ - + published interface XFlushableClipboard: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/datatransfer/dnd/DNDConstants.idl b/offapi/com/sun/star/datatransfer/dnd/DNDConstants.idl index 2f3ec5a7912c..7809b762f4a6 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DNDConstants.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DNDConstants.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -33,8 +33,8 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** These values represent the type of action or actions to be performed by a - Drag and Drop operation. +/** These values represent the type of action or actions to be performed by a + Drag and Drop operation. */ published constants DNDConstants @@ -42,7 +42,7 @@ published constants DNDConstants //============================================================================= /** No action. */ - + const byte ACTION_NONE = 0x00; //============================================================================= @@ -50,31 +50,31 @@ published constants DNDConstants */ const byte ACTION_COPY = 0x01; - + //============================================================================= /** Action move. */ const byte ACTION_MOVE = 0x02; - + //============================================================================= /** Action copy or move. */ const byte ACTION_COPY_OR_MOVE = 0x03; - + //============================================================================= /** Action link. */ const byte ACTION_LINK = 0x04; - + //============================================================================= /** Action reference. */ const byte ACTION_REFERENCE = 0x04; - + //============================================================================= /** Action default. */ diff --git a/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl index bc23cd376ced..dccf954967d5 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -40,17 +40,17 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= /** A DragGestureEvent is passed to the method <member>XDragGestureListener::dragGestureRecognized()</member> - when a particular <type>XDragGestureRecognizer</type> detects that a platform + when a particular <type>XDragGestureRecognizer</type> detects that a platform dependent drag initiating gesture has occurred on the component that it is - tracking. + tracking. */ published struct DragGestureEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - /** The action selected by the user. + /** The action selected by the user. <p>Different constants may be combined using a logical OR.</p> - It's further possible to combine the ACTION_DEFAULT with one of the other + It's further possible to combine the ACTION_DEFAULT with one of the other actions defined in <type scope="com::sun::star::datatransfer::dnd">DNDConstants</type>. This means the user did not press any key during the Drag and Drop operation and the action that was combined with ACTION_DEFAULT is the system default action.</p> @@ -83,7 +83,7 @@ published struct DragGestureEvent: com::sun::star::lang::EventObject <p>The initial trigger event will presumably be a <type scope="com::sun::star::awt">MouseEvent</type> event. If it is not, the implementation should either react accordingly or - presume that the left mouse button was clicked. </p> + presume that the left mouse button was clicked. </p> */ any Event; diff --git a/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl index 4a51d894e1a6..f0e91f634c9a 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -37,12 +37,12 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** The <type>DragSourceDragEvent</type> is delivered from an object that - implements the <type>XDragSourceContext</type> to the - currently registered drag source listener. +/** The <type>DragSourceDragEvent</type> is delivered from an object that + implements the <type>XDragSourceContext</type> to the + currently registered drag source listener. <p>It contains state regarding the current state of the operation to enable - the operations initiator to provide the end user with the appropriate drag + the operations initiator to provide the end user with the appropriate drag over feedback.</p> @see com::sun::star::datatransfer::dnd::XDragSourceListener @@ -56,7 +56,7 @@ published struct DragSourceDragEvent: com::sun::star::datatransfer::dnd::DragSou @see com::sun::star::datatransfer::dnd::DNDConstants */ byte DropAction; - + //------------------------------------------------------------------------- /** The user's currently selected drop action. diff --git a/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl index 3ff38b281d17..d3164f0a0132 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -38,10 +38,10 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= /** The <type>DragSourceDropEvent</type> is delivered from an object that implements - <type>XDragSourceContext</type> to its currently registered drag source listener's. + <type>XDragSourceContext</type> to its currently registered drag source listener's. - <p>It contains sufficient information for the originator of the operation to - provide appropriate feedback to the end user when the operation completes.</p> + <p>It contains sufficient information for the originator of the operation to + provide appropriate feedback to the end user when the operation completes.</p> @see com::sun::star::datatransfer::dnd::XDragSourceListener */ @@ -50,10 +50,10 @@ published struct DragSourceDropEvent: com::sun::star::datatransfer::dnd::DragSou { //------------------------------------------------------------------------- /** The action performed by the target on the subject of the drop. - + @see com::sun::star::datatransfer::dnd::DNDConstants */ - + byte DropAction; //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl index 3cf97f7c4418..f8d580b44c3a 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -43,7 +43,7 @@ module com { module sun { module star { module datatransfer { module dnd { /** This class is the base class for <type>DragSourceDragEvent</type> and <type>DragSourceDropEvent</type>. <p>To access the <type>XDragSource</type> that originated this event, use the - <member scope="com::sun::star::lang">EventObject::Source</member> member of + <member scope="com::sun::star::lang">EventObject::Source</member> member of this object.</p> */ @@ -54,7 +54,7 @@ published struct DragSourceEvent: com::sun::star::lang::EventObject @see com::sun::star::datatransfer::dnd::XDragSourceContext */ - + XDragSourceContext DragSourceContext; //------------------------------------------------------------------------- @@ -62,7 +62,7 @@ published struct DragSourceEvent: com::sun::star::lang::EventObject @see com::sun::star::datatransfer::dnd::XDragSource */ - + XDragSource DragSource; }; diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl index 688cfe843d52..5e40014ff59c 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -41,12 +41,12 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** The <type>DropTargetDragEnterEvent</type> is delivered from the drop target to the - currently registered drop target listeners whenever the logical cursor - associated with a Drag and Drop operation enters the visible geometry +/** The <type>DropTargetDragEnterEvent</type> is delivered from the drop target to the + currently registered drop target listeners whenever the logical cursor + associated with a Drag and Drop operation enters the visible geometry of a window associated with a drop target. - <p>It contains the <type scope="com::sun::star::datatransfer">DataFlavor</type> + <p>It contains the <type scope="com::sun::star::datatransfer">DataFlavor</type> types supported by the transferable object of the current Drag and Drop operation. </p> @see com::sun::star::datatransfer::XTransferable diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl index d8280d0e5454..1c5314cd4055 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -39,11 +39,11 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDropTargetDragContext; //============================================================================= -/** The <type>DropTargetDragEvent</type> is delivered from the drop target - to the currently registered drop target listener. +/** The <type>DropTargetDragEvent</type> is delivered from the drop target + to the currently registered drop target listener. <p>It contains information regarding the current state of the operation to enable - the operations initiator to provide the end user with the appropriate drag + the operations initiator to provide the end user with the appropriate drag over feedback.</p> @see com::sun::star::datatransfer::dnd::XDropTargetListener @@ -58,15 +58,15 @@ published struct DropTargetDragEvent: com::sun::star::datatransfer::dnd::DropTar */ XDropTargetDragContext Context; - + //------------------------------------------------------------------------- /** This value represents the currently selected drop action. - + @see com::sun::star::datatransfer::dnd::DNDConstants */ byte DropAction; - + //------------------------------------------------------------------------- /** The cursor's current x location within the window's coordinates. */ @@ -83,7 +83,7 @@ published struct DropTargetDragEvent: com::sun::star::datatransfer::dnd::DropTar /** This value represents the action or actions supported by the source. This may be a combination of arbitrary source actions except ACTION_DEFAULT. <p>To combine different actions use a logical OR.</p> - + @see com::sun::star::datatransfer::dnd::DNDConstants */ diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl index 661bfbdeae0c..ac68824e5920 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -43,11 +43,11 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDropTargetDropContext; //============================================================================= -/** The <type>DropTargetDropEvent</type> is delivered from the drop target to - its currently registered drop target listener. +/** The <type>DropTargetDropEvent</type> is delivered from the drop target to + its currently registered drop target listener. - <p>It contains sufficient information for the originator of the operation to - provide appropriate feedback to the end user when the operation completes.</p> + <p>It contains sufficient information for the originator of the operation to + provide appropriate feedback to the end user when the operation completes.</p> */ published struct DropTargetDropEvent: com::sun::star::datatransfer::dnd::DropTargetEvent @@ -59,9 +59,9 @@ published struct DropTargetDropEvent: com::sun::star::datatransfer::dnd::DropTar */ XDropTargetDropContext Context; - + //------------------------------------------------------------------------- - /** This value represents the action or actions selected by the user at + /** This value represents the action or actions selected by the user at the time of the drop. <p>If more than one action is specified, the <type>XDropTargetListener</type> diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl index c73958afce3a..65e644a29832 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -38,10 +38,10 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= /** This class is the base class for <type>DropTargetDragEvent</type> and - <type>DropTargetDropEvent</type>. + <type>DropTargetDropEvent</type>. <p>To access the <type>XDropTarget</type> that originated this event, use the - <member scope="com::sun::star::lang">EventObject::Source</member> member of + <member scope="com::sun::star::lang">EventObject::Source</member> member of this object.</p> */ diff --git a/offapi/com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl b/offapi/com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl index 80397604cdc8..93dc8189a7b9 100644 --- a/offapi/com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl +++ b/offapi/com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -37,11 +37,11 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** This exception is thrown by various methods in the datatransfer.dnd - package. +/** This exception is thrown by various methods in the datatransfer.dnd + package. <p>It is usually thrown to indicate that the target in question is unable - to undertake the requested operation at the present time, since the + to undertake the requested operation at the present time, since the underlying Drag and Drop system is not in the appropriate state.</p> */ diff --git a/offapi/com/sun/star/datatransfer/dnd/OleDragSource.idl b/offapi/com/sun/star/datatransfer/dnd/OleDragSource.idl index 7227f805f642..14bd59b8918f 100644 --- a/offapi/com/sun/star/datatransfer/dnd/OleDragSource.idl +++ b/offapi/com/sun/star/datatransfer/dnd/OleDragSource.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -67,13 +67,13 @@ published service OleDragSource interface XDragSource; //------------------------------------------------------------------------- - /** The service expects a byte sequence uniquely identifying the machine as + /** The service expects a byte sequence uniquely identifying the machine as the first, and only, parameter. This idenifier should be checked to - ensure that the window ids used for creating DropTargets are valid for + ensure that the window ids used for creating DropTargets are valid for the service, that is, come from the same machine. <p>TODO: specify how such a machine id should look like.</p> - + The second parameter is a window handle of the native windows window. Is is passed as an unsigned long. */ diff --git a/offapi/com/sun/star/datatransfer/dnd/OleDropTarget.idl b/offapi/com/sun/star/datatransfer/dnd/OleDropTarget.idl index de1431e59e65..b0e4cccc7d3d 100644 --- a/offapi/com/sun/star/datatransfer/dnd/OleDropTarget.idl +++ b/offapi/com/sun/star/datatransfer/dnd/OleDropTarget.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/datatransfer/dnd/X11DragSource.idl b/offapi/com/sun/star/datatransfer/dnd/X11DragSource.idl index c301d81e24f8..33ab110706b3 100644 --- a/offapi/com/sun/star/datatransfer/dnd/X11DragSource.idl +++ b/offapi/com/sun/star/datatransfer/dnd/X11DragSource.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -53,8 +53,8 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDragSource; //============================================================================= -/** This service connects the Java-like UNO Drag and Drop protocol to the - X Drag and Drop protocol used on X-Servers to transfer data between +/** This service connects the Java-like UNO Drag and Drop protocol to the + X Drag and Drop protocol used on X-Servers to transfer data between applications via Drag and Drop operations. @see XDragSource @@ -68,7 +68,7 @@ published service X11DragSource interface XDragSource; //------------------------------------------------------------------------- - /** The service expects an instance of + /** The service expects an instance of <type scope="com::sun::star::awt">XDisplayConnection</type> as the first parameter. */ diff --git a/offapi/com/sun/star/datatransfer/dnd/X11DropTarget.idl b/offapi/com/sun/star/datatransfer/dnd/X11DropTarget.idl index 0ed961ede186..94ac8536b233 100644 --- a/offapi/com/sun/star/datatransfer/dnd/X11DropTarget.idl +++ b/offapi/com/sun/star/datatransfer/dnd/X11DropTarget.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -53,8 +53,8 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDropTarget; //============================================================================= -/** This service connects the Java-like UNO Drag and Drop protocol to the - X Drag and Drop protocol used on X-Servers to transfer data between +/** This service connects the Java-like UNO Drag and Drop protocol to the + X Drag and Drop protocol used on X-Servers to transfer data between application via Drag and Drop operations. @see XDragSource @@ -69,7 +69,7 @@ published service X11DropTarget interface XDropTarget; //------------------------------------------------------------------------- - /** The service expects an instance of + /** The service expects an instance of <type scope="com::sun::star::awt">XDisplayConnection</type> as the first parameter. The second parameter must be a long that contains an XWindow window which shall be registered diff --git a/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl b/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl index 37efc1d7f6cd..e54d341ab669 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -39,19 +39,19 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= /** Interface for autoscroll support. - <p>During Drag and Drop operations it is possible that a user may wish to drop the + <p>During Drag and Drop operations it is possible that a user may wish to drop the subject of the operation on a region of a scrollable GUI control that is - not currently visible to the user.</p> + not currently visible to the user.</p> <p>In such situations it is desirable that the GUI control detect this and institute a scroll operation in order to make obscured region(s) visible to the user. This feature is known as autoscrolling.</p> - <p>If a GUI control is both an active DropTarget and is also scrollable, + <p>If a GUI control is both an active DropTarget and is also scrollable, it can receive notifications of autoscrolling gestures by the user from the Drag and Drop system by implementing this interface.</p> - <p>An autoscrolling gesture is initiated by the user by keeping the drag + <p>An autoscrolling gesture is initiated by the user by keeping the drag cursor motionless with a border region of the Component, referred to as the "autoscrolling region", for a predefined period of time, this will result in repeated scroll requests to the Component until the drag Cursor @@ -69,18 +69,18 @@ published interface XAutoscroll: com::sun::star::uno::XInterface @param cursorLocationY Y location of the cursor in pixel. */ - + [oneway] void autoscroll( [in] long cursorLocationX, [in] long cursorLocationY ); - + //------------------------------------------------------------------------- /** Returns the regions describing the autoscrolling region. - @returns - The regions describing the autoscrolling region or border + @returns + The regions describing the autoscrolling region or border relative to the geometry of the implementing component. */ - - any getAutoscrollRegion(); + + any getAutoscrollRegion(); }; //============================================================================= diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl b/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl index 3aa14195448a..ca8a8fed5a5b 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -41,10 +41,10 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** This interface will be used by a <type>XDragGestureRecognizer</type> - when it detects a drag initiating gesture. +/** This interface will be used by a <type>XDragGestureRecognizer</type> + when it detects a drag initiating gesture. - <p>The implementor of this interface is responsible for starting the drag + <p>The implementor of this interface is responsible for starting the drag as a result of receiving such notification.</p> */ @@ -52,8 +52,8 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDragGestureListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - /** A <type>XDragGestureRecognizer</type> has detected a platform-dependent - drag initiating gesture and is notifying this listener in order + /** A <type>XDragGestureRecognizer</type> has detected a platform-dependent + drag initiating gesture and is notifying this listener in order for it to initiate the action for the user. @param dge diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl b/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl index 1d0fc5b63d13..29b7b8fd97f2 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -39,11 +39,11 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDragGestureListener; //============================================================================= -/** This interface is implemented by a view or window that supports drag +/** This interface is implemented by a view or window that supports drag operations. <p>Different to Java, the association between view and interface is fixed - and cannot be changed. Otherwise, the AWT messaging would have to be + and cannot be changed. Otherwise, the AWT messaging would have to be implemented for any window supporting Drag and Drop operations, which would be a performance issue.</p> */ @@ -51,29 +51,29 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDragGestureRecognizer: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** Registers a new <type>XDragGestureListener</type>. + /** Registers a new <type>XDragGestureListener</type>. @param dgl - The <type>XDragGestureListener</type> to register with this + The <type>XDragGestureListener</type> to register with this <type>XDragGestureRecognizer</type>. */ - + [oneway] void addDragGestureListener( [in] XDragGestureListener dgl ); - + //------------------------------------------------------------------------- /** Unregisters the specified <type>XDragGestureListener</type>. @param dgl - The <type>XDragGestureListener</type> to register with this + The <type>XDragGestureListener</type> to register with this <type>XDragGestureRecognizer</type>. */ - + [oneway] void removeDragGestureListener( [in] XDragGestureListener dgl ); //------------------------------------------------------------------------- /** Reset the recognizer. If it is currently recognizing a gesture, ignore it. */ - + void resetRecognizer(); }; diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragSource.idl b/offapi/com/sun/star/datatransfer/dnd/XDragSource.idl index a67de276c1a5..5d2771dd9bfc 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragSource.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragSource.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -53,27 +53,27 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= /** This interface is implemented by a view or window that supports drag operations and will be received as part of a <type>DragGestureEvent</type> - through a <member scope="com::sun::star::datatransfer::dnd">XDragGestureListener::dragGestureRecognized()</member> + through a <member scope="com::sun::star::datatransfer::dnd">XDragGestureListener::dragGestureRecognized()</member> callback. <p>Differently to Java, the association between view and interface is fixed - and can not be changed. Otherwise, the AWT messaging would have to be + and can not be changed. Otherwise, the AWT messaging would have to be implemented for any window supporting Drag and Drop operations, which would be a real performance issue.</p> */ published interface XDragSource: com::sun::star::uno::XInterface { - + //------------------------------------------------------------------------- /** In order to query if drag image support is available. - @returns - A boolean indicating whether or not drag image support is - available on the underlying platform. + @returns + A boolean indicating whether or not drag image support is + available on the underlying platform. */ - - boolean isDragImageSupported(); + + boolean isDragImageSupported(); //------------------------------------------------------------------------- /** To get the default cursor for a specified drag action. @@ -81,24 +81,24 @@ published interface XDragSource: com::sun::star::uno::XInterface @param dragAction A drag action as specified in <type>DNDConstants</type>. - @returns + @returns The default drag cursor for the specified drag action. <p>The returned value may be used as parameter for the method <member scope="com::sun::star::datatransfer::dnd">XDragSourceContext::setCursor()</member>.</p> */ - - long getDefaultCursor( [in] byte dragAction ) + + long getDefaultCursor( [in] byte dragAction ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- /** Starts the drag operation. - <p>Note: this call does <em>not</em> block until the drag and drop + <p>Note: this call does <em>not</em> block until the drag and drop operation ends. If the Drag and Drop system is unable to initiate a drag operation or if the user attempts to start a drag while an existing drag operation is still executing, the action fails immediately. - This is indicated by calling - <member scope="com::sun::star::datatransfer::dnd">XDragSourceListener::dragDropEnd()</member> + This is indicated by calling + <member scope="com::sun::star::datatransfer::dnd">XDragSourceListener::dragDropEnd()</member> on the parameter listener with a DragSourceDragEvent showing a failure.</p> @param trigger @@ -113,22 +113,22 @@ published interface XDragSource: com::sun::star::uno::XInterface @param image The initial drag image id or 0 as default. - + @param trans The transferable object dragged. @param listener The <type>XDragSourceListener</type>. - - @see com::sun::star::datatransfer::XTransferable + + @see com::sun::star::datatransfer::XTransferable */ - + [oneway] void startDrag( [in] DragGestureEvent trigger, [in] byte sourceActions, - [in] long cursor, + [in] long cursor, [in] long image, - [in] com::sun::star::datatransfer::XTransferable trans, + [in] com::sun::star::datatransfer::XTransferable trans, [in] XDragSourceListener listener ); }; diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl b/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl index 3c212d8999b0..c56c6bede19c 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -39,16 +39,16 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDragSourceListener; //============================================================================= -/** The drag source context class is responsible for managing the initiator side - of the Drag and Drop protocol. +/** The drag source context class is responsible for managing the initiator side + of the Drag and Drop protocol. - <p>In particular, it is responsible for managing event notifications to the - DragSourceListener and providing the Transferable state to enable the data + <p>In particular, it is responsible for managing event notifications to the + DragSourceListener and providing the Transferable state to enable the data transfer. </p> <p>An instance of this class is created as a result of the method <member>XDragSource::startDrag()</member> - being successfully invoked. This instance is responsible - for tracking the state of the operation on behalf of the drag source and + being successfully invoked. This instance is responsible + for tracking the state of the operation on behalf of the drag source and dispatching state changes to the drag source listener. </p> @see com::sun::star::datatransfer::dnd::XDragSourceContext @@ -60,10 +60,10 @@ published interface XDragSourceContext: com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** Get the identifier of the currently used cursor. - @returns + @returns The currently selected drag cursor. */ - + long getCurrentCursor(); //------------------------------------------------------------------------- @@ -74,29 +74,29 @@ published interface XDragSourceContext: com::sun::star::uno::XInterface <p>Invalid cursor identifiers will be ignored.</p> @param cursorId - The identifier the drag source returned when registering the cursor. + The identifier the drag source returned when registering the cursor. */ - + [oneway] void setCursor( [in] long cursorId ); //------------------------------------------------------------------------- - /** This method sets the current drag image. + /** This method sets the current drag image. @param dragImage The identifier the drag source returned when registering the image (0 = none). Invalid identifier will be ignored. */ - + [oneway] void setImage( [in] long imageId ); //------------------------------------------------------------------------- - /** This method notifies the context that the - <type scope="com::sun::star::datatransfer">DataFlavor</type> types + /** This method notifies the context that the + <type scope="com::sun::star::datatransfer">DataFlavor</type> types of the transferable object have changed. - - @see com::sun::star::datatransfer::XTransferable + + @see com::sun::star::datatransfer::XTransferable */ - + [oneway] void transferablesFlavorsChanged(); }; diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl b/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl index b15896be1e6a..5e745982d2b8 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -55,7 +55,7 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDragSourceListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - /** This method is invoked to signify that the Drag and Drop operation is + /** This method is invoked to signify that the Drag and Drop operation is complete. @param dsde @@ -67,19 +67,19 @@ published interface XDragSourceListener: com::sun::star::lang::XEventListener //------------------------------------------------------------------------- /** Called as the hotspot enters a platform dependent drop site. - <p><strong>NOTE:</strong> currently this notification can not be ensured by all + <p><strong>NOTE:</strong> currently this notification can not be ensured by all implementations. Do not rely on it ! </p> @param dsde The <type>DragSourceDragEvent</type>. */ - + [oneway] void dragEnter( [in] DragSourceDragEvent dsde ); //------------------------------------------------------------------------- /** Called as the hotspot exits a platform dependent drop site. - <p><strong>NOTE:</strong> Currently this notification can not be ensured by all + <p><strong>NOTE:</strong> Currently this notification can not be ensured by all implementations. Do not rely on it ! </p> @param dse @@ -98,7 +98,7 @@ published interface XDragSourceListener: com::sun::star::lang::XEventListener [oneway] void dragOver( [in] DragSourceDragEvent dsde ); //------------------------------------------------------------------------- - /** Called when the user has modified the drop gesture. + /** Called when the user has modified the drop gesture. @param dsde The <type>DragSourceEvent</type>. diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl index f4b52182583a..83770e8bdddf 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -43,11 +43,11 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDropTargetListener; //============================================================================= -/** This interface is implemented by a view or window that supports drop +/** This interface is implemented by a view or window that supports drop operations. <p>Differently to Java, the association between view and interface is fixed - and cannot be changed. Otherwise, the AWT messaging would have to be + and cannot be changed. Otherwise, the AWT messaging would have to be implemented for any window supporting Drag and Drop operations, which would be a performance issue.</p> */ @@ -74,42 +74,42 @@ published interface XDropTarget: com::sun::star::uno::XInterface */ [oneway] void removeDropTargetListener( [in] XDropTargetListener dtl ); - + //------------------------------------------------------------------------- /** Indicates either a drop target object is active or not. - + @returns - A boolean indicating whether or not this drop target object is + A boolean indicating whether or not this drop target object is currently active, that is ready to accept drops. */ - + boolean isActive(); //------------------------------------------------------------------------- - /** Sets the drop target object active or inactive. + /** Sets the drop target object active or inactive. @param active A value of <TRUE/> sets the drop target object active. <p>A value of <FALSE/> sets the drop target object inactive. */ - + void setActive( [in] boolean active ); //------------------------------------------------------------------------- /** Determine the actions supported by a drop target. - - @returns + + @returns The current action or actions supported by this drop target. <p>By default this will include all drag and drop actions.</p> - + @see com::sun::star::datatransfer::dnd::DNDConstants */ - + byte getDefaultActions(); - + //------------------------------------------------------------------------- - /** Sets the default acceptable actions for this drop target. + /** Sets the default acceptable actions for this drop target. <p>This method is a way to reduce the number of Drag and Drop events by blocking events for actions not supported by this target.</p> diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl index 261ad3a857f0..c05decfaad8e 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -43,21 +43,21 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= /** This interface is implemented by any drop target context object. - <p>A drop target context is created whenever the logical cursor associated - with a Drag and Drop operation moves within the visible geometry of a + <p>A drop target context is created whenever the logical cursor associated + with a Drag and Drop operation moves within the visible geometry of a window associated with a drop target. </p> - - <p>The drop target context provides the mechanism for a potential receiver - of a drop operation to both provide the end user with the appropriate drag + + <p>The drop target context provides the mechanism for a potential receiver + of a drop operation to both provide the end user with the appropriate drag under feedback and effect the subsequent data transfer, if appropriate. </p> */ published interface XDropTargetDragContext: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** Accept the Drag. + /** Accept the Drag. - <p>This method should be called from the methods of <type>XDropTargetListener</type> + <p>This method should be called from the methods of <type>XDropTargetListener</type> <ul> <li><member>XDropTargetListener::dragEnter()</member></li> <li><member>XDropTargetListener::dragOver()</member></li> @@ -72,11 +72,11 @@ published interface XDropTargetDragContext: com::sun::star::uno::XInterface @see DNDConstants @see DropTargetDragEvent */ - + [oneway] void acceptDrag( [in] byte dragOperation ); //------------------------------------------------------------------------- - /** Reject the drag as a result of examining the available + /** Reject the drag as a result of examining the available <type scope="com::sun::star::datatransfer">DataFlavor</type> types received in the <member scope="com::sun::star::datatransfer::dnd">XDropTargetListener::dragEnter()</member> method. */ diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl index 6cd354a92b2e..59760d52f8c9 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -43,22 +43,22 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= /** This interface is implemented by any drop target context object. - <p>A DropTargetContext is created whenever the logical cursor associated - with a Drag and Drop operation moves within the visible geometry of a + <p>A DropTargetContext is created whenever the logical cursor associated + with a Drag and Drop operation moves within the visible geometry of a window associated with a DropTarget. </p> - <p>The drop target context provides the mechanism for a potential receiver - of a drop operation to provide the end user with the appropriate drag + <p>The drop target context provides the mechanism for a potential receiver + of a drop operation to provide the end user with the appropriate drag under feedback and to effect the subsequent data transfer, if appropriate. </p> */ published interface XDropTargetDropContext : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** Accept the Drop. + /** Accept the Drop. - <p>This method should be called from the - <member scope="com::sun::star::datatransfer::dnd">XDropTargetListener::drop()</member> + <p>This method should be called from the + <member scope="com::sun::star::datatransfer::dnd">XDropTargetListener::drop()</member> method if the implementation wishes to accept the drop operation with the specified action.</p> @param dragOperation @@ -67,11 +67,11 @@ published interface XDropTargetDropContext : com::sun::star::uno::XInterface @see DNDConstants @see DropTargetDragEvent */ - + [oneway] void acceptDrop( [in] byte dragOperation ); //------------------------------------------------------------------------- - /** Reject the drop as a result of examining the available + /** Reject the drop as a result of examining the available <type scope="com::sun::star::datatransfer">DataFlavor</type> types received in the <member>XDropTargetListener::dragEnter()</member> method. */ @@ -79,7 +79,7 @@ published interface XDropTargetDropContext : com::sun::star::uno::XInterface [oneway] void rejectDrop(); //------------------------------------------------------------------------- - /** Signals that the drop is completed and if it was successful or not. + /** Signals that the drop is completed and if it was successful or not. @param success A value of <TRUE/> means the drop completed successfully diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl index 78516990da84..a7b2306693c6 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -45,11 +45,11 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** This interface is the callback interface used by the drop target object to - provide notification of Drag and Drop operations that involve the subject +/** This interface is the callback interface used by the drop target object to + provide notification of Drag and Drop operations that involve the subject drop target. - <p>Methods of this interface may be implemented to provide "drag under" + <p>Methods of this interface may be implemented to provide "drag under" visual feedback to the user throughout the Drag and Drop operation.</p> */ @@ -65,7 +65,7 @@ published interface XDropTargetListener: com::sun::star::lang::XEventListener Also, the implementor of <type>XDropTargetListener</type> should not assume the <type>DropTargetDropEvent</type> to be meaningful after returning from the <member>XDropTargetListener::drop()</member> method.</p> - + @param dtde The <type>DropTargetDropEvent</type>. */ @@ -78,7 +78,7 @@ published interface XDropTargetListener: com::sun::star::lang::XEventListener @param dtde The <type>DropTargetDragEvent</type>. */ - + [oneway] void dragEnter( [in] DropTargetDragEnterEvent dtdee ); //------------------------------------------------------------------------- @@ -100,7 +100,7 @@ published interface XDropTargetListener: com::sun::star::lang::XEventListener [oneway] void dragOver( [in] DropTargetDragEvent dtde ); //------------------------------------------------------------------------- - /** Called when the user has modified the drop gesture. + /** Called when the user has modified the drop gesture. @param dtde The <type>DropTargetEvent</type>. |