From 2db0fb2487a7a54e4861f9a3eaf15261f9d00800 Mon Sep 17 00:00:00 2001 From: arellano Date: Thu, 1 Mar 2001 16:53:51 +0000 Subject: Edited by Dennis --- offapi/com/sun/star/datatransfer/DataFlavor.idl | 8 +++++--- offapi/com/sun/star/datatransfer/DataFormatTranslator.idl | 12 ++++++++---- .../com/sun/star/datatransfer/MimeContentTypeFactory.idl | 8 +++++--- .../sun/star/datatransfer/UnsupportedFlavorException.idl | 6 +++--- offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl | 14 +++++++------- offapi/com/sun/star/datatransfer/XMimeContentType.idl | 12 ++++++++---- .../com/sun/star/datatransfer/XMimeContentTypeFactory.idl | 8 ++++---- offapi/com/sun/star/datatransfer/XTransferDataAccess.idl | 7 ++++--- offapi/com/sun/star/datatransfer/XTransferable.idl | 10 ++++++---- offapi/com/sun/star/datatransfer/XTransferableEx.idl | 10 +++++----- 10 files changed, 55 insertions(+), 40 deletions(-) (limited to 'offapi/com/sun') diff --git a/offapi/com/sun/star/datatransfer/DataFlavor.idl b/offapi/com/sun/star/datatransfer/DataFlavor.idl index 501e82db574c..76fb0dc86a1a 100644 --- a/offapi/com/sun/star/datatransfer/DataFlavor.idl +++ b/offapi/com/sun/star/datatransfer/DataFlavor.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataFlavor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:38 $ + * last change: $Author: arellano $ $Date: 2001-03-01 17:53:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,6 +69,8 @@ module com { module sun { module star { module datatransfer { //============================================================================= /** Each instance represents the opaque concept of a data format as would appear on a clipboard or during drag and drop. + + */ struct DataFlavor @@ -85,7 +87,7 @@ struct DataFlavor string HumanPresentableName; //------------------------------------------------------------------------- - /** The type of the object to transfer, e.g. XOutputStream. + /** The type of the object to transfer, for example, XOutputStream. */ type DataType; }; diff --git a/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl b/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl index cb16ea4c89f4..c933e043102b 100644 --- a/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl +++ b/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataFormatTranslator.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-02-27 09:47:24 $ + * last change: $Author: arellano $ $Date: 2001-03-01 17:53:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,14 +79,18 @@ module com { module sun { module star { module datatransfer { interface XDataFormatTranslator; //============================================================================= -/** manages a list of dataflavors +/** manages a list of dataflavors. + + @see com::sun::star::datatransfer::XDTransFormatTranslator */ service DataFormatTranslator { //------------------------------------------------------------------------- - /** converts DataFlavors to system data types and vice versa + /** converts DataFlavors to system data types and vice versa. + + */ interface XDataFormatTranslator; diff --git a/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl b/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl index aa0c0eefb0b3..75eab9d012a1 100644 --- a/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl +++ b/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: MimeContentTypeFactory.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-01-23 13:29:43 $ + * last change: $Author: arellano $ $Date: 2001-03-01 17:53:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,12 +85,14 @@ interface XMimeContentTypeFactory; //============================================================================= /** the MimeContentType service creates instances of mime contenttype + + @see com::sun::star::datatransfer::XMimeContentTypeFactory */ service MimeContentTypeFactory { //------------------------------------------------------------------------- - /** creates mime contenttypes from strings + /** creates mime contenttypes from strings. */ interface XMimeContentTypeFactory; diff --git a/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl b/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl index 3a066d7ad3fd..fcae62e20531 100644 --- a/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl +++ b/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnsupportedFlavorException.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:38 $ + * last change: $Author: arellano $ $Date: 2001-03-01 17:53:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,7 @@ module com { module sun { module star { module datatransfer { //============================================================================= -/** exception thrown if a tranfer data object is requested in a DataFlavor not +/** exception thrown if a transfer data object is requested in a DataFlavor not supported by the data source. @see com::sun::star::datatransfer::DataFlavor diff --git a/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl b/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl index cd1a8e7de24f..1efb02cac7e8 100644 --- a/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl +++ b/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataFormatTranslator.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-02-27 09:47:51 $ + * last change: $Author: arellano $ $Date: 2001-03-01 17:53:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,9 +77,9 @@ module com { module sun { module star { module datatransfer { /**

Interface to be implemented by objects used to translate DataFlavors to system dependent data transfer types and vice versa. Different platforms use different data transfer types to describe dates during data exchange - operations like clipboard or drag&drop, e.g. Windows uses interger values, - Unix uses atoms, other platforms may use strings etc.

-

Under Windows a data type of format int32 will be interpreted as + operations like clipboard or drag&drop, for example, Windows uses interger values, + Unix uses atoms, other platforms may use strings.

+

Under Windows, a data type of format int32 will be interpreted as clipboard format value, whereas a string will be interpreted as a format name which has to be registered in order to get a valid clipboard format value.

*/ @@ -90,14 +90,14 @@ interface XDataFormatTranslator : com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** @returns - a DataFlavor for the given system data type + a DataFlavor for the given system data type. */ [const] any getSystemDataTypeFromDataFlavor( [in] DataFlavor aDataFlavor ); //------------------------------------------------------------------------- /** @returns - a system data type for the given DataFlavor + a system data type for the given DataFlavor. */ [const] DataFlavor getDataFlavorFromSystemDataType( [in] any aSysDataType ); }; diff --git a/offapi/com/sun/star/datatransfer/XMimeContentType.idl b/offapi/com/sun/star/datatransfer/XMimeContentType.idl index 92f4e2f3ae2b..feacad79455e 100644 --- a/offapi/com/sun/star/datatransfer/XMimeContentType.idl +++ b/offapi/com/sun/star/datatransfer/XMimeContentType.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMimeContentType.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-01-31 10:24:42 $ + * last change: $Author: arellano $ $Date: 2001-03-01 17:53:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,7 +78,9 @@ interface XMimeContentType : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** @returns - the media type of the contenttype + the media type of the contenttype. + + */ [const] string getMediaType( ); @@ -103,6 +105,8 @@ interface XMimeContentType : com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** @returns if the contenttype has the specified parameter + + */ [const] boolean hasParameter( [in] string aName ); @@ -113,7 +117,7 @@ interface XMimeContentType : com::sun::star::uno::XInterface @param the name of the parameter */ - [const] string getParameterValue( [in] string aName ) + [const] string getParameterValue( [in] string aNameaName ) raises ( com::sun::star::container::NoSuchElementException ); }; diff --git a/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl b/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl index f56c09f414a3..02d222dab16a 100644 --- a/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl +++ b/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMimeContentTypeFactory.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-01-31 10:24:42 $ + * last change: $Author: arellano $ $Date: 2001-03-01 17:53:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,11 +89,11 @@ interface XMimeContentTypeFactory : com::sun::star::uno::XInterface com::sun::star::datatransfer::XMimeContentType @throws com::sun::star::lang::IllegalArgumentException - if the string doesn't conform to rfc2045 or rfc2046 + if the string does not conform to rfc2045 or rfc2046 @see com::sun::star::datatransfer::XMimeContentType */ - com::sun::star::datatransfer::XMimeContentType createMimeContentType( [in] string aContentType ) + com::sun::star::datatransfer::XMimeContentType createMimeContentType( [in] string aContentTypeaContentType ) raises ( com::sun::star::lang::IllegalArgumentException ); }; diff --git a/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl b/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl index 2ecc9e91a68c..1614b0485db6 100644 --- a/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl +++ b/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTransferDataAccess.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:38 $ + * last change: $Author: arellano $ $Date: 2001-03-01 17:53:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -101,7 +101,8 @@ interface XTransferDataAccess: com::sun::star::uno::XInterface @param aFlavorList the requested data flavors. Unsupported flavors will be ignored. - */ + + */ sequence < any > getData( [in] sequence < DataFlavor > aFlavorList ); }; diff --git a/offapi/com/sun/star/datatransfer/XTransferable.idl b/offapi/com/sun/star/datatransfer/XTransferable.idl index 3ade7cbbec5a..1beb471d5c51 100644 --- a/offapi/com/sun/star/datatransfer/XTransferable.idl +++ b/offapi/com/sun/star/datatransfer/XTransferable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTransferable.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:38 $ + * last change: $Author: arellano $ $Date: 2001-03-01 17:53:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -120,14 +120,16 @@ interface XTransferable: com::sun::star::uno::XInterface /** Checks if the data object supports the specified data flavor. @returns - if the data flavor is supported by the transfer source, - otherwise. + if the data flavor is supported by the transfer source, + 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 ); }; diff --git a/offapi/com/sun/star/datatransfer/XTransferableEx.idl b/offapi/com/sun/star/datatransfer/XTransferableEx.idl index 875d2fe6502f..66a7e6441405 100644 --- a/offapi/com/sun/star/datatransfer/XTransferableEx.idl +++ b/offapi/com/sun/star/datatransfer/XTransferableEx.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTransferableEx.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:38 $ + * last change: $Author: arellano $ $Date: 2001-03-01 17:53:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,12 +89,12 @@ interface XTransferableEx: com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** @requestedFlavors Sequence of flavors of interest. Specify an empty sequence for interest - in all flavors with top-level MIMIE types. To get all MIME types call + in all flavors with top-level MIME types. To get all MIME types call com::sun::star::datatransfer::XTransferable. @returns - the list of the matching supported falvors that where requested. For - each requested top-level MIMIE type all supported subtypes are returned. + the list of the matching supported flavors that were requested. For + each requested top-level MIME type, all supported subtypes are returned. */ [const] sequence < DataFlavor > queryTransferDataFlavors( [in] sequence< DataFlavor > requestedFlavors ); }; -- cgit