wp_primary_selection_unstable_v1

• # zwp_primary_selection_device_manager_v1

  The primary selection device manager is a singleton global object that provides access to the primary selection. It allows to create wp_primary_selection_source objects, as well as retrieving the per-seat wp_primary_selection_device objects.

  Requests

  • #

    create_source

    create a new primary selection source
    struct zwp_primary_selection_source_v1* zwp_primary_selection_device_manager_v1_create_source(

    struct zwp_primary_selection_device_manager_v1* zwp_primary_selection_device_manager_v1

    )
    Create a new primary selection source.
  • #

    get_device

    create a new primary selection device
    struct zwp_primary_selection_device_v1* zwp_primary_selection_device_manager_v1_get_device(

    struct zwp_primary_selection_device_manager_v1* zwp_primary_selection_device_manager_v1,

    struct wl_seat* seat

    )
    Create a new data device for a given seat.
  • #

    destroy

    destroy the primary selection device manager
    void zwp_primary_selection_device_manager_v1_destroy(

    struct zwp_primary_selection_device_manager_v1* zwp_primary_selection_device_manager_v1

    )
    Destroy the primary selection device manager.

• # zwp_primary_selection_device_v1

  Requests

  • #

    set_selection

    set the primary selection
    void zwp_primary_selection_device_v1_set_selection(

    struct zwp_primary_selection_device_v1* zwp_primary_selection_device_v1,

    struct zwp_primary_selection_source_v1* source,

    uint32_t serial /* serial of the event that triggered this request */

    )
    Replaces the current selection. The previous owner of the primary selection will receive a wp_primary_selection_source.cancelled event. To unset the selection, set the source to NULL.
  • #

    destroy

    destroy the primary selection device
    void zwp_primary_selection_device_v1_destroy(

    struct zwp_primary_selection_device_v1* zwp_primary_selection_device_v1

    )
    Destroy the primary selection device.

  Events

  • #

    data_offer

    introduce a new wp_primary_selection_offer
    struct zwp_primary_selection_offer_v1* offer
    Introduces a new wp_primary_selection_offer object that may be used to receive the current primary selection. Immediately following this event, the new wp_primary_selection_offer object will send wp_primary_selection_offer.offer events to describe the offered mime types.
  • #

    selection

    advertise a new primary selection
    struct zwp_primary_selection_offer_v1* id
    The wp_primary_selection_device.selection event is sent to notify the client of a new primary selection. This event is sent after the wp_primary_selection.data_offer event introducing this object, and after the offer has announced its mimetypes through wp_primary_selection_offer.offer. The data_offer is valid until a new offer or NULL is received or until the client loses keyboard focus. The client must destroy the previous selection data_offer, if any, upon receiving this event.

• # zwp_primary_selection_offer_v1

  A wp_primary_selection_offer represents an offer to transfer the contents of the primary selection clipboard to the client. Similar to wl_data_offer, the offer also describes the mime types that the data can be converted to and provides the mechanisms for transferring the data directly to the client.

  Requests

  • #

    receive

    request that the data is transferred
    void zwp_primary_selection_offer_v1_receive(

    struct zwp_primary_selection_offer_v1* zwp_primary_selection_offer_v1,

    const char* mime_type,

    int32_t fd

    )
    To transfer the contents of the primary selection clipboard, the client issues this request and indicates the mime type that it wants to receive. The transfer happens through the passed file descriptor (typically created with the pipe system call). The source client writes the data in the mime type representation requested and then closes the file descriptor. The receiving client reads from the read end of the pipe until EOF and closes its end, at which point the transfer is complete.
  • #

    destroy

    destroy the primary selection offer
    void zwp_primary_selection_offer_v1_destroy(

    struct zwp_primary_selection_offer_v1* zwp_primary_selection_offer_v1

    )
    Destroy the primary selection offer.

  Events

  • #

    offer

    advertise offered mime type
    const char* mime_type
    Sent immediately after creating announcing the wp_primary_selection_offer through wp_primary_selection_device.data_offer. One event is sent per offered mime type.

• # zwp_primary_selection_source_v1

  The source side of a wp_primary_selection_offer, it provides a way to describe the offered data and respond to requests to transfer the requested contents of the primary selection clipboard.

  Requests

  • #

    offer

    add an offered mime type
    void zwp_primary_selection_source_v1_offer(

    struct zwp_primary_selection_source_v1* zwp_primary_selection_source_v1,

    const char* mime_type

    )
    This request adds a mime type to the set of mime types advertised to targets. Can be called several times to offer multiple types.
  • #

    destroy

    destroy the primary selection source
    void zwp_primary_selection_source_v1_destroy(

    struct zwp_primary_selection_source_v1* zwp_primary_selection_source_v1

    )
    Destroy the primary selection source.

  Events

  • #

    send

    send the primary selection contents
    const char* mime_type
    int32_t fd
    Request for the current primary selection contents from the client. Send the specified mime type over the passed file descriptor, then close it.
  • #

    cancelled

    request for primary selection contents was canceled
    This primary selection source is no longer valid. The client should clean up and destroy this primary selection source.

Copyright Info