diff options
Diffstat (limited to 'offapi/com/sun/star/datatransfer/dnd')
24 files changed, 378 insertions, 302 deletions
diff --git a/offapi/com/sun/star/datatransfer/dnd/DNDConstants.idl b/offapi/com/sun/star/datatransfer/dnd/DNDConstants.idl index 593d8db04..7976db80b 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DNDConstants.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DNDConstants.idl @@ -2,9 +2,9 @@ * * $RCSfile: DNDConstants.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 15:04:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,12 +73,46 @@ module com { module sun { module star { module datatransfer { module dnd { constants DNDConstants { + //============================================================================= + /** No action. + */ + const byte ACTION_NONE = 0x00; + + //============================================================================= + /** Action copy. + */ + const byte ACTION_COPY = 0x01; + + //============================================================================= + /** Action move. + */ + const byte ACTION_MOVE = 0x02; - const byte ACTION_COPY_OR_MOVE = 0x03; + + //============================================================================= + /** 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. + */ + const byte ACTION_DEFAULT = 0x80; }; diff --git a/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl index 900b56210..24fd50aee 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DragGestureEvent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: arellano $ $Date: 2001-07-17 16:07:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,46 +73,49 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDragSource; //============================================================================= -/** A DragGestureEvent is passed to DragGestureListener's dragGestureRecognized() - method when a particular DragGestureRecognizer detects that a platform - dependent drag initiating gesture has occurred on the Component that it is - tracking. - - <!-- Editor: Should Component be capitalized? --> +/** A DragGestureEvent is passed to the method <member>XDragGestureListener::dragGestureRecognized()</member> + when a particular <type>XDragGestureRecognizer</type> detects that a platform + dependent drag initiating gesture has occurred on the component that it is + tracking. */ 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 + 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> + + @see com::sun::star::datatransfer::dnd::DNDConstants */ byte DragAction; //------------------------------------------------------------------------- - /** the x coordinate where the drag originated in Component coords. - - <!-- Editor: Is "coords" an actual term or the abbreviation of coordinates? --> + /** The x coordinate where the drag originated in component coordinates. */ long DragOriginX; //------------------------------------------------------------------------- - /** the y coordinate where the drag originated in Component coords. + /** The y coordinate where the drag originated in component coordinates. */ long DragOriginY; //------------------------------------------------------------------------- - /** the DragSource associated with this drag action. + /** The DragSource associated with this drag action. */ XDragSource DragSource; //------------------------------------------------------------------------- - /** the last event comprising the gesture. + /** The last event comprising the gesture. - <p> The initial trigger event will presumably be a <type scope="com::sun::star::awt">MouseEvent</type> event. + <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> */ diff --git a/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl index 2e3f479b7..907912c35 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DragSourceDragEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-07-20 20:34:24 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,25 +71,30 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** The DragSourceDragEvent is delivered from the DragSourceContext to the - currently registered DragSourceListener. +/** 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 over feedback.</p> - <!-- Editor: Please reword "It contains state" --> + @see com::sun::star::datatransfer::dnd::XDragSourceListener */ struct DragSourceDragEvent: com::sun::star::datatransfer::dnd::DragSourceEvent { //------------------------------------------------------------------------- - /** the drag action selected by the current drop target. + /** The drag action selected by the current drop target. + + @see com::sun::star::datatransfer::dnd::DNDConstants */ byte DropAction; //------------------------------------------------------------------------- - /** the user's currently selected drop action. + /** The user's currently selected drop action. + + @see com::sun::star::datatransfer::dnd::DNDConstants */ byte UserAction; }; diff --git a/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl index 4c486384e..2902b0c1b 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DragSourceDropEvent.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: obr $ $Date: 2001-01-26 11:27:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,23 +71,27 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** The DragSourceDropEvent is delivered from the DragSourceContext to its - currently registered DragSourceListener's dragDropEnd() method. +/** The <type>DragSourceDropEvent</type> is delivered from an object that implements + <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> + + @see com::sun::star::datatransfer::dnd::XDragSourceListener */ struct DragSourceDropEvent: com::sun::star::datatransfer::dnd::DragSourceEvent { //------------------------------------------------------------------------- - /** the action performed by the target on the subject of the drop. + /** The action performed by the target on the subject of the drop. + + @see com::sun::star::datatransfer::dnd::DNDConstants */ byte DropAction; //------------------------------------------------------------------------- - /** indicates if the drop was successful. + /** Indicates if the drop was successful. */ boolean DropSuccess; diff --git a/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl index bb565755a..da7488c05 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DragSourceEvent.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: obr $ $Date: 2001-01-29 10:38:15 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,7 +74,7 @@ interface XDragSource; interface XDragSourceContext; //============================================================================= -/** This class is the base class for DragSourceDragEvent and DragSourceDropEvent. +/** 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 @@ -84,13 +84,17 @@ interface XDragSourceContext; struct DragSourceEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - /** the DragSourceContext of the current drag operation. + /** The drag source context of the current drag operation. + + @see com::sun::star::datatransfer::dnd::XDragSourceContext */ XDragSourceContext DragSourceContext; //------------------------------------------------------------------------- - /** the DragSource on which the drag and drop operation was initiated. + /** The drag source on which the Drag and Drop operation was initiated. + + @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 39a7b1cea..1f0c40654 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DropTargetDragEnterEvent.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: obr $ $Date: 2001-02-09 10:55:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,19 +75,22 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** The DropTargetDragEnterEvent is delivered from the DropTarget to the - currently registered DropTargetListeners whenever the logical cursor +/** 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 DropTarget. + of a window associated with a drop target. - <p>It contains the dataflavors supported by the transferable object of - the current Drag and Drop operation. </p> + <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 */ struct DropTargetDragEnterEvent: DropTargetDragEvent { //------------------------------------------------------------------------- - /** The dataflavors supported by the transferable object. + /** A sequence of supported <type scope="com::sun::star::datatransfer">DataFlavor</type> types. + */ sequence< DataFlavor > SupportedDataFlavors; diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl index 42e98f68e..f905b134d 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DropTargetDragEvent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 18:38:27 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,44 +73,52 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDropTargetDragContext; //============================================================================= -/** The DropTargetDragEvent is delivered from the DropTarget to the currently - registered DropTargetListener. +/** The <type>DropTargetDragEvent</type> is delivered from the drop target + to the currently registered drop target listener. - <p>It contains state regarding the current state of the operation to enable + <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 over feedback.</p> - <!-- Editor: Please reword, "It contains state regarding the current state" --> + @see com::sun::star::datatransfer::dnd::XDropTargetListener */ struct DropTargetDragEvent: com::sun::star::datatransfer::dnd::DropTargetEvent { //------------------------------------------------------------------------- - /** the DropTargetContext of the current drag operation. + /** The drop target context of the current drag operation. + + @see com::sun::star::datatransfer::dnd::XDropTargetDragContext */ XDropTargetDragContext Context; //------------------------------------------------------------------------- - /** this value represents the currently selected drop action. + /** 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. + /** The cursor's current x location within the window's coordinates. */ long LocationX; //------------------------------------------------------------------------- - /** the cursor's current y location within the window's coordinates. + /** The cursor's current y location within the window's coordinates. */ long LocationY; //------------------------------------------------------------------------- - /** this value represents the action or actions supported by the source. + /** 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 */ byte SourceActions; diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl index 585d575bc..a26158dfc 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DropTargetDropEvent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 18:31:04 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,8 +77,8 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDropTargetDropContext; //============================================================================= -/** The DropTargetDropEvent is delivered from the DropTarget to its currently - registered DropTargetListener's dragDropEnd() method. +/** 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> @@ -87,41 +87,47 @@ interface XDropTargetDropContext; struct DropTargetDropEvent: com::sun::star::datatransfer::dnd::DropTargetEvent { //------------------------------------------------------------------------- - /** the DropTargetContext of the current drag operation. + /** The drop target context of the current drag operation. + + @see com::sun::star::datatransfer::dnd::XDropTargetDropContext */ XDropTargetDropContext Context; //------------------------------------------------------------------------- - /** this value represents the action or actions selected by the user at the time of - the drop. + /** 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>DropTargetListener</type> + <p>If more than one action is specified, the <type>XDropTargetListener</type> should raise a dialog to ask the user which action to use.</p> + + @see com::sun::star::datatransfer::dnd::DNDConstants */ byte DropAction; //------------------------------------------------------------------------- - /** the cursor's current x location within the windows' coordinates. + /** The cursor's current x location within the windows' coordinates. */ long LocationX; //------------------------------------------------------------------------- - /** the cursor's current y location within the windows' coordinates. + /** The cursor's current y location within the windows' coordinates. */ long LocationY; //------------------------------------------------------------------------- - /** this value represents the action or actions supported by the source. + /** This value represents the action or actions supported by the source. */ byte SourceActions; //------------------------------------------------------------------------- - /** the transferable object associated with the drop. + /** The transferable object associated with the drop. + + @see com::sun::star::datatransfer::XTransferable */ com::sun::star::datatransfer::XTransferable Transferable; diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl index 1cc068710..e049d3638 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DropTargetEvent.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: obr $ $Date: 2001-01-26 11:27:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,7 +82,7 @@ module com { module sun { module star { module datatransfer { module dnd { struct DropTargetEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - /** UNO specification does not allow empty struct definitions. + /** UNO specification does not allow empty struct definitions. */ byte Dummy; diff --git a/offapi/com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl b/offapi/com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl index b496c9319..a369d0874 100644 --- a/offapi/com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl +++ b/offapi/com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl @@ -2,9 +2,9 @@ * * $RCSfile: InvalidDNDOperationException.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 20:02:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,7 +76,7 @@ module com { module sun { module star { module datatransfer { module dnd { <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 - underlying DnD system is not in the appropriate state.</p> + underlying Drag and Drop system is not in the appropriate state.</p> */ exception InvalidDNDOperationException: com::sun::star::uno::RuntimeException diff --git a/offapi/com/sun/star/datatransfer/dnd/OleDragSource.idl b/offapi/com/sun/star/datatransfer/dnd/OleDragSource.idl index 439b81dab..c4e996b31 100644 --- a/offapi/com/sun/star/datatransfer/dnd/OleDragSource.idl +++ b/offapi/com/sun/star/datatransfer/dnd/OleDragSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: OleDragSource.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: arellano $ $Date: 2001-07-17 16:12:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -96,38 +96,35 @@ interface XDragSource; service OleDragSource { //------------------------------------------------------------------------- - /** used to provide data to other applications via Ole DND protocol. + /** Used to provide data to other applications via the Ole Drag & Drop protocol. */ 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 the service, that is, come from the same machine. <p>TODO: specify how such a machine id should look like.</p> - - <!-- Editor: Should the last sentence be seen by the user? --> - + The second parameter is a window handle of the native windows window. Is is passed as an unsigned long. - */ interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- - /** for shutdown and listener support. + /** For shutdown and listener support. */ interface com::sun::star::lang::XComponent; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; }; diff --git a/offapi/com/sun/star/datatransfer/dnd/OleDropTarget.idl b/offapi/com/sun/star/datatransfer/dnd/OleDropTarget.idl index 3c46ecbe5..480fba301 100644 --- a/offapi/com/sun/star/datatransfer/dnd/OleDropTarget.idl +++ b/offapi/com/sun/star/datatransfer/dnd/OleDropTarget.idl @@ -2,9 +2,9 @@ * * $RCSfile: OleDropTarget.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: arellano $ $Date: 2001-07-17 15:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,7 +87,7 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDropTarget; //============================================================================= -/** This service connects the Java-like UNO drag and drop protocol to the protocol +/** This service connects the Java-like UNO Drag & Drop protocol to the protocol used on window platforms. It realizes the drop target. @see XDropTarget @@ -96,29 +96,27 @@ interface XDropTarget; service OleDropTarget { //------------------------------------------------------------------------- - /** used to provide data to other applications via Ole DND protocol. + /** Used to provide data to other applications via Ole Drap & Drop protocol. */ interface XDropTarget; //------------------------------------------------------------------------- - /** - the service expects a windows window handle. It is passed as unsigned long. - + /** The service expects a windows window handle. It is passed as unsigned long. */ interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- - /** for shutdown and listener support. + /** For shutdown and listener support. */ interface com::sun::star::lang::XComponent; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; }; diff --git a/offapi/com/sun/star/datatransfer/dnd/X11DragSource.idl b/offapi/com/sun/star/datatransfer/dnd/X11DragSource.idl index 8aa86b629..492599adb 100644 --- a/offapi/com/sun/star/datatransfer/dnd/X11DragSource.idl +++ b/offapi/com/sun/star/datatransfer/dnd/X11DragSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: X11DragSource.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 19:52:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,9 +87,9 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDragSource; //============================================================================= -/** This service connects the Java-like UNO drag and drop protocol to the XDND - protocol used on Xservers to transfer data between applications via drag and - drop operations. +/** 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 */ @@ -97,28 +97,29 @@ interface XDragSource; service X11DragSource { //------------------------------------------------------------------------- - /** used to provide data to other applications via XDND protocol. + /** Used to provide data to other applications via X Drag and Drop protocol. */ interface XDragSource; //------------------------------------------------------------------------- - /** the service expects an instance of <type scope="com::sun::star::awt">XDisplayConnection</type> - as the first parameter. + /** The service expects an instance of + <type scope="com::sun::star::awt">XDisplayConnection</type> + as the first parameter. */ interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- - /** for shutdown and listener support. + /** For shutdown and listener support. */ interface com::sun::star::lang::XComponent; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; }; diff --git a/offapi/com/sun/star/datatransfer/dnd/X11DropTarget.idl b/offapi/com/sun/star/datatransfer/dnd/X11DropTarget.idl index 66e8fa60e..9e9d11790 100644 --- a/offapi/com/sun/star/datatransfer/dnd/X11DropTarget.idl +++ b/offapi/com/sun/star/datatransfer/dnd/X11DropTarget.idl @@ -2,9 +2,9 @@ * * $RCSfile: X11DropTarget.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: pl $ $Date: 2001-02-06 10:32:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,9 +87,9 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDropTarget; //============================================================================= -/** This service connects the java like UNO drag and drop protocol to the XDND - protocol used on X servers to transfer data between application via drag and - drop operations. +/** 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 @see XDropTarget @@ -98,30 +98,31 @@ interface XDropTarget; service X11DropTarget { //------------------------------------------------------------------------- - /** used to get data from other applications via XDND protocol. + /** Used to get data from other applications via X Drag and Drop protocol. */ interface XDropTarget; //------------------------------------------------------------------------- - /** the service expects an instance of <type scope="com::sun::star::awt">XDisplayConnection</type> - as the first parameter. The second parameter must be a <type>long</type> - that contains an Xwindow <type>Window</type> which shall be registered + /** 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 as drop target. */ interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- - /** for shutdown and listener support. + /** For shutdown and listener support. */ interface com::sun::star::lang::XComponent; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; }; diff --git a/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl b/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl index 3a7fb3932..a5a957daa 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAutoscroll.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: obr $ $Date: 2001-10-30 11:26:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,39 +71,47 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** interface for autoscroll support. +/** Interface for autoscroll support. - <p>During DnD 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> + the user. This feature is known as autoscrolling.</p> <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 DnD system by implementing this interface. </p> + the Drag and Drop system by implementing this interface.</p> <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 resumes its motion. </p> - */ interface XAutoscroll: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** notify the Component to autoscroll. + /** Notify the component to autoscroll. + + @param cursorLocationX + X location of the cursor in pixel. + + @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 or border - relative to the geometry of the implementing Component. + /** Returns the regions describing the autoscrolling region. + + @returns + The regions describing the autoscrolling region or border + relative to the geometry of the implementing component. */ any getAutoscrollRegion(); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl b/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl index e2c44da68..c5b1d3be3 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDragGestureListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-07-17 16:02:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,23 +75,23 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** This interface is sourced from a DragGestureRecognizer and is invoked when - an object of that (sub)class 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 - as a result of receiving such notification. </p> + <p>The implementor of this interface is responsible for starting the drag + as a result of receiving such notification.</p> */ interface XDragGestureListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - /** A DragGestureRecognizer has detected a platform-dependent drag initiating - gesture and is notifying this listener in order for it to initiate the - action for the user. + /** 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 - the DragGestureEvent describing the gesture that has just occurred. + The DragGestureEvent describing the gesture that has just occurred. */ [oneway] void dragGestureRecognized( [in] DragGestureEvent dge ); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl b/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl index 817b68b86..c53e06000 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDragGestureRecognizer.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 20:00:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,7 +77,7 @@ interface XDragGestureListener; 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> */ @@ -85,25 +85,27 @@ interface XDragGestureListener; interface XDragGestureRecognizer: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** registers a new DragGestureListener. + /** Registers a new <type>XDragGestureListener</type>. @param dgl - the DragGestureListener to register with this DragGestureRecognizer. + The <type>XDragGestureListener</type> to register with this + <type>XDragGestureRecognizer</type>. */ [oneway] void addDragGestureListener( [in] XDragGestureListener dgl ); //------------------------------------------------------------------------- - /** unregisters the specified DragGestureListener. + /** Unregisters the specified <type>XDragGestureListener</type>. @param dgl - the DragGestureListener to register with this DragGestureRecognizer. + 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. + /** 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 28c951756..7207ab358 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragSource.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDragSource.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 18:13:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,78 +86,82 @@ interface XDragSourceListener; //============================================================================= /** This interface is implemented by a view or window that supports drag - operations and can be received through a dragGestureRecognized() call - when imlpementing <type>XDragGestureListener</type>. + operations and will be received as part of a <type>DragGestureEvent</type> + through a <member scope="com::sun::star::datatransfer::dnd">XDragGestureListener::dragGestureRecognized()</member> + callback. - <p>Different to Java, the association between view and interface is fixed - and can not be changed. Otherwise, the awt messaging would have to be - implemented for any window supporting Drag and Drop operations, what would + <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 + implemented for any window supporting Drag and Drop operations, which would be a real performance issue.</p> - - <!-- Editor: Do you mean Java does it differently? --> - - <!-- Editor: Can the last phrase read: which would be a performance issue. --> */ interface XDragSource: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns - a boolean indicating whether or not drag Image support is + /** 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. */ boolean isDragImageSupported(); //------------------------------------------------------------------------- - /** @returns - the default drag cursor for the specified drag action. + /** To get the default cursor for a specified drag action. @param dragAction - a drag action. + A drag action as specified in <type>DNDConstants</type>. + + @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 ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - /** starts the drag operation. + /** Starts the drag operation. <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 endDragDrop on the listener parameter with - a DragSourceDragEvent showing failure. - </p> - - <!-- Editor: Is "block" the right word in the previous paragraph? --> + 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 - the <type>DragGestureEvent</type> that initiated the drag. + The <type>DragGestureEvent</type> that initiated the drag. @param sourceActions - the action or actions supported for this transferable. + The action or actions supported for this transferable as defined + in <type>DNDConstants</type>. @param cursor - the initial drag cursor id or 0 for defaults. + The initial drag cursor id or 0 as default. @param image - the initial drag image id or 0 for defaults. + The initial drag image id or 0 as default. @param trans - the transferable object dragged. + The transferable object dragged. @param listener - the <type>XDragSourceListener</type>. - + The <type>XDragSourceListener</type>. + + @see com::sun::star::datatransfer::XTransferable */ [oneway] void startDrag( [in] DragGestureEvent trigger, [in] byte sourceActions, - [in] long cursor, [in] long image, + [in] long cursor, + [in] long image, [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 da857be20..4017dee2d 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDragSourceContext.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: arellano $ $Date: 2001-07-17 15:48:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,56 +73,62 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDragSourceListener; //============================================================================= -/** The DragSourceContext class is responsible for managing the initiator side +/** 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 transfer. </p> - <p>An instance of this class is created as a result of a DragSource's - startDrag() method being successfully invoked. This instance is responsible - for tracking the state of the operation on behalf of the DragSource and - dispatching state changes to the DragSourceListener. </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 + dispatching state changes to the drag source listener. </p> + + @see com::sun::star::datatransfer::dnd::XDragSourceContext + @see com::sun::star::datatransfer::dnd::XDragSourceListener */ interface XDragSourceContext: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns - the currently selected drag cursor. + /** Get the identifier of the currently used cursor. + + @returns + The currently selected drag cursor. */ long getCurrentCursor(); //------------------------------------------------------------------------- - /** this method sets the current drag Cursor. - - <!-- Editor: Should Cursor have a leading capital? --> + /** This method sets the current drag cursor. <p>This method should only be called to set another cursor than the - default one for drag action currently selected by the user. - Invalid cursor Ids will be ignored.</p> + default one for drag action currently selected by the user.</p> + <p>Invalid cursor identifiers will be ignored.</p> @param cursorId - the id 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 id the drag source returned when registering the image (0 = none). - Invalid Ids will be ignored. + 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 Transferable's DataFlavors - have changed. + /** 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 */ [oneway] void transferablesFlavorsChanged(); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl b/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl index 04db8fff4..784539af0 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDragSourceListener.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:19 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,60 +79,63 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** This interface must be implemented by any <type>DragGestureRecognizer</type> - implementation that a <type>DragSource</type> supports. +/** This interface must be implemented by any drag gesture recognizer + implementation that a drag source supports. + + @see com::sun::star::datatransfer::dnd::XDragGestureRecognizer + @see com::sun::star::datatransfer::dnd::XDragSource */ 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 - the DragSourceDropEvent + The <type>DragSourceDropEvent</type> */ [oneway] void dragDropEnd( [in] DragSourceDropEvent dsde ); //------------------------------------------------------------------------- - /** called as the hotspot enters a platform dependent drop site. + /** Called as the hotspot enters a platform dependent drop site. - <p>NOTE: 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 DragSourceDragEvent + The <type>DragSourceDragEvent</type>. */ [oneway] void dragEnter( [in] DragSourceDragEvent dsde ); //------------------------------------------------------------------------- - /** called as the hotspot exits a platform dependent drop site. + /** Called as the hotspot exits a platform dependent drop site. - <p>NOTE: 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 - the DragSourceEvent + The <type>DragSourceEvent</type>. */ [oneway] void dragExit( [in] DragSourceEvent dse ); //------------------------------------------------------------------------- - /** called as the hotspot moves over a platform dependent drop site. + /** Called as the hotspot moves over a platform dependent drop site. @param dsde - the DragSourceEvent + The <type>DragSourceEvent</type> */ [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 DragSourceEvent + The <type>DragSourceEvent</type>. */ [oneway] void dropActionChanged( [in] DragSourceDragEvent dsde ); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl index e10538d36..d5434cf0b 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDropTarget.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 18:26:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,8 +80,8 @@ interface XDropTargetListener; /** This interface is implemented by a view or window that supports drop 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 + <p>Differently to Java, the association between view and interface is fixed + 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> */ @@ -89,69 +89,70 @@ interface XDropTargetListener; interface XDropTarget: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** add a DropTargetListener. + /** Add a DropTargetListener. - <p>The listener will be querried for the <type>XAutoscroll</type> interface + <p>The listener will be queried for the <type>XAutoscroll</type> interface to see if it supports autoscrolling.</p> @param dtl - the listener to add to the notification list. + The listener to add to the notification list. */ [oneway] void addDropTargetListener( [in] XDropTargetListener dtl ); //------------------------------------------------------------------------- - /** remove a DropTargetListener. + /** Remove a drop target listener. @param dtl - the listener to remove from notification list. + The listener to remove from notification list. */ [oneway] void removeDropTargetListener( [in] XDropTargetListener dtl ); //------------------------------------------------------------------------- - /** @returns - a boolean indicating whether or not this DropTarget is + /** Indicates either a drop target object is active or not. + + @returns + A boolean indicating whether or not this drop target object is currently active, that is ready to accept drops. */ boolean isActive(); //------------------------------------------------------------------------- - /** sets the DropTarget active if <TRUE/>, inactive if <FALSE/>. + /** Sets the drop target object active or inactive. @param active - see describtion above. - - <!-- Editor: Should the first sentence be an @return ? --> + 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 ); //------------------------------------------------------------------------- - /** @returns - the current action or actions supported by this DropTarget. + /** Determine the actions supported by a drop target. + + @returns + The current action or actions supported by this drop target. <p>By default this will include all drag and drop actions.</p> - @see DNDConstants + @see com::sun::star::datatransfer::dnd::DNDConstants */ byte getDefaultActions(); //------------------------------------------------------------------------- - /** sets the default acceptable actions for this DropTarget. + /** Sets the default acceptable actions for this drop target. - <p>This method is a way to reduce the number of drag and drop events + <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> - <p>By default the listener will receive notifications for all actions.</p> - @param actions - the actions. + The actions. - @see DNDConstants + @see com::sun::star::datatransfer::dnd::DNDConstants */ [oneway] void setDefaultActions( [in] byte actions ); }; diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl index 873470b00..a107a9a69 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDropTargetDragContext.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 18:44:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,33 +75,33 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** This interface is implemented by any DropTargetContext object. +/** This interface is implemented by any drop target context object. - <p>A DropTargetContext is created whenever the logical cursor associated + <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 DropTarget. </p> + window associated with a drop target. </p> - <p>The DropTargetContext provides the mechanism for a potential receiver + <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> - + under feedback and effect the subsequent data transfer, if appropriate. </p> */ interface XDropTargetDragContext: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** accept the Drag. - - <p>This method should be called from the <type>XDropTargetListener</type>s - <member>XDropTargetListener::dragEnter</member>, - <member>XDropTargetListener::dragOver</member>, and - <member>XDropTargetListener::dragActionChanged</member> methods if the - implementation wishes to accept the drag operation with the specified + /** Accept the Drag. + + <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> + <li><member>XDropTargetListener::dragActionChanged()</member></li> + </ul> + if the implementation wishes to accept the drag operation with the specified action.</p> @param dragOperation - the operation accepted by the target. + The operation accepted by the target. @see DNDConstants @see DropTargetDragEvent @@ -110,13 +110,9 @@ interface XDropTargetDragContext: com::sun::star::uno::XInterface [oneway] void acceptDrag( [in] byte dragOperation ); //------------------------------------------------------------------------- - /** reject the Drag. - - <p>Reject the drag as a result of examining either or 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>XDropTargetListener::dragEnter</member>. - - <!-- Editor: Something is missing between the "either or" --> + received in the <member scope="com::sun::star::datatransfer::dnd">XDropTargetListener::dragEnter()</member> method. */ [oneway] void rejectDrag(); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl index 82c92e6d4..36719e8f1 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDropTargetDropContext.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 18:11:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,31 +75,28 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** This interface is implemented by any DropTargetContext object. +/** 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 with the visible geometry of a + with a Drag and Drop operation moves within the visible geometry of a window associated with a DropTarget. </p> - <!-- Editor: Should the word be "within" instead of "with"? --> - - <p>The DropTargetContext provides the mechanism for a potential receiver + <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> - */ interface XDropTargetDropContext : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** accept the Drop. + /** Accept the Drop. - <p>This method should be called from the <type>XDropTargetListener</type>s - <member>XDropTargetListener::drop</member> method if the implementation - wishes to accept the drop operation with the specified action.</p> + <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 - the operation accepted by the target. + The operation accepted by the target. @see DNDConstants @see DropTargetDragEvent @@ -108,24 +105,19 @@ interface XDropTargetDropContext : com::sun::star::uno::XInterface [oneway] void acceptDrop( [in] byte dragOperation ); //------------------------------------------------------------------------- - /** reject the Drag. - - <p>Reject the drop as a result of examining either or 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>. - - <!-- Editor: "either" and "or" should have some text between them --> + received in the <member>XDropTargetListener::dragEnter()</member> method. */ [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 - <TRUE/> if drop completed successful, <FALSE/> otherwise. - - <!-- Editor: Should this be @return ? --> + A value of <TRUE/> means the drop completed successfully + <p>A value of <FALSE/> means the drop completed unsuccessfully.</p> */ [oneway] void dropComplete( [in] boolean success ); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl index 9540476f3..5da0bb9fe 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDropTargetListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 19:48:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,8 +79,9 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** This interface is the callback interface used by the DropTarget class to - provide notification of DnD operations that involve the subject DropTarget. +/** 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" visual feedback to the user throughout the Drag and Drop operation.</p> @@ -89,55 +90,54 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDropTargetListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - /** the drag operation has terminated with a drop on this DropTarget. + /** The drag operation has terminated with a drop on this drop target. - <p> NOTE: This method should not be one-way. The implentation - has to wait until dropComplete on the <type>XDropTargetDropContext</type> + <p><strong>NOTE:</strong> This method should not be oneway. The implentation + has to wait until the method <type>XDropTargetDropContext::dropComplete()</type> is called before releasing the data for the drop operation. This should occur before returning from drop in a normal flow of operation. - Also, the implementor of XDropTargetListener should not assume + 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> + from the <member>XDropTargetListener::drop()</member> method.</p> @param dtde - the DropTargetDropEvent + The <type>DropTargetDropEvent</type>. */ void drop( [in] DropTargetDropEvent dtde ); //------------------------------------------------------------------------- - /** called when a drag operation has encountered the DropTarget. + /** Called when a drag operation has encountered the drop target. @param dtde - the DropTargetDragEvent + The <type>DropTargetDragEvent</type>. */ [oneway] void dragEnter( [in] DropTargetDragEnterEvent dtdee ); //------------------------------------------------------------------------- - /** the drag operation has departed the DropTarget without dropping. + /** The drag operation has departed the drop target without dropping. @param dte - the DropTargetEvent + The <type>DropTargetEvent</type>. */ [oneway] void dragExit( [in] DropTargetEvent dte ); //------------------------------------------------------------------------- - /** called when a drag operation is ongoing on the DropTarget. + /** Called when a drag operation is ongoing on the drop target. @param dtde - the DropTargetEvent + The <type>DropTargetEvent</type>. */ [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 DropTargetEvent + The <type>DropTargetEvent</type>. */ [oneway] void dropActionChanged( [in] DropTargetDragEvent dtde ); |