Skip to content
  • Martin Flöser's avatar
    [server] Implement support for drag'n'drop through pointer device · 413025c2
    Martin Flöser authored
    Summary:
    How drag'n'drop works on Wayland:
    When a surface has a pointer grab and a button pressed on the surface
    (implicit grab) the client can initiate a drag'n'drop operation on the
    data device. For this the client needs to provide a data source
    describing the data to be transmitted with the drag'n'drop operation.
    
    When a drag'n'drop operation is active all pointer events are interpreted
    as part of the drag'n'drop operation, the pointer device is grabbed.
    Pointer events are no longer sent to the focused pointer but to the
    focused data device. When the pointer moves to another surface an
    enter event is sent to a data device for that surface and a leave
    event is sent to the data device previously focused. An enter event
    carries a data offer which is created from the data source for the
    operation.
    
    During pointer motion there is a feedback mechanism. The data offer
    can signal to the data source that it can or cannot accept the data
    at the current pointer position. This can be used by the client being
    dragged from to update the cursor.
    
    The drag'n'drop operation ends with the implicit grab being removed,
    that is the pressed pointer button which triggered the operation gets
    released. The server sends a drop event to the focused data device.
    
    The data transfer can now be started. For that the receiving client
    creates a pipe and passes the file descriptor through the data offer
    to the sending data source. The sending client will write into the
    file descriptor and close it to finish the transfer.
    
    Drag'n'drop could also be initiated through a touch device grab, but
    this is not yet implemented.
    
    The implementation in this change focuses on the adjustments for pointer.
    For the user of the library drag'n'drop is implemented in the
    SeatInterface. Signals are emitted whenever drag is started or ended.
    The interaction for pointer events hardly changes. Motion, button press
    and button release can still be indicated in the same way. If a button
    release removes the implicit grab the drop is automatically performed,
    without the user of the library having to do anything.
    
    The only change during drag and drop for the library user is that
    setFocusedPointerSurface is blocked. To update the current drag target
    the library user should use setDragTarget. Sending the enter/leave to the
    data device gets performed automatically.
    
    The data device which triggered the drag and drop operation is exposed
    in the SeatInterface. The user of the library should make sure to render
    the additional drag icon provided on the data device. At least QtWayland
    based applications will freeze during drag and drop if the icon doesn't
    get rendered.
    
    The implementation is currently still lacking the client side and due to
    that also auto test. It's currently only tested with QtWayland clients.
    
    Reviewers: #plasma, sebas
    
    Subscribers: plasma-devel
    
    Projects: #plasma
    
    Differential Revision: https://phabricator.kde.org/D1046
    413025c2