SDL/wayland-protocols/wayland.xml at SDL2 · pusewicz/SDL

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<?xml version="1.0" encoding="UTF-8"?>

Permission is hereby granted, free of charge, to any person

obtaining a copy of this software and associated documentation files

(the "Software"), to deal in the Software without restriction,

including without limitation the rights to use, copy, modify, merge,

publish, distribute, sublicense, and/or sell copies of the Software,

and to permit persons to whom the Software is furnished to do so,

subject to the following conditions:

The above copyright notice and this permission notice (including the

next paragraph) shall be included in all copies or substantial

portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS

BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.

</copyright>

The core global object. This is a special singleton object. It

is used for internal Wayland protocol features.

</description>

The sync request asks the server to emit the 'done' event

on the returned wl_callback object. Since requests are

handled in-order and events are delivered in-order, this can

be used as a barrier to ensure all previous requests and the

resulting events have been handled.

The object returned by this request will be destroyed by the

compositor after the callback is fired and as such the client must not

attempt to use it after that point.

The callback_data passed in the callback is the event serial.

</description>

<arg name="callback" type="new_id" interface="wl_callback"

summary="callback object for the sync request"/>

</request>

This request creates a registry object that allows the client

to list and bind the global objects available from the

compositor.

It should be noted that the server side resources consumed in

response to a get_registry request can only be released when the

client disconnects, not when the client side proxy is destroyed.

Therefore, clients should invoke get_registry as infrequently as

possible to avoid wasting memory.

</description>

<arg name="registry" type="new_id" interface="wl_registry"

summary="global registry object"/>

</request>

The error event is sent out when a fatal (non-recoverable)

error has occurred. The object_id argument is the object

where the error occurred, most often in response to a request

to that object. The code identifies the error and is defined

by the object interface. As such, each interface defines its

own set of error codes. The message is a brief description

of the error, for (debugging) convenience.

</description>

</event>

These errors are global and can be emitted in response to any

server request.

</description>

<entry name="invalid_object" value="0"

summary="server couldn't find object"/>

<entry name="invalid_method" value="1"

summary="method doesn't exist on the specified interface or malformed request"/>

<entry name="no_memory" value="2"

summary="server is out of memory"/>

<entry name="implementation" value="3"

summary="implementation error in compositor"/>

</enum>

This event is used internally by the object ID management

logic. When a client deletes an object that it had created,

the server will send this event to acknowledge that it has

seen the delete request. When the client receives this event,

it will know that it can safely reuse the object ID.

</description>

</event>

</interface>

The singleton global registry object. The server has a number of

global objects that are available to all clients. These objects

typically represent an actual object in the server (for example,

an input device) or they are singleton objects that provide

extension functionality.

When a client creates a registry object, the registry object

will emit a global event for each global currently in the

registry. Globals come and go as a result of device or

monitor hotplugs, reconfiguration or other events, and the

registry will send out global and global_remove events to

keep the client up to date with the changes. To mark the end

of the initial burst of events, the client can use the

wl_display.sync request immediately after calling

wl_display.get_registry.

A client can bind to a global object by using the bind

request. This creates a client-side handle that lets the object

emit events to the client and lets the client invoke requests on

the object.

</description>

Binds a new, client-created object to the server using the

specified name as the identifier.

</description>

</request>

Notify the client of global objects.

The event notifies the client that a global object with

the given name is now available, and it implements the

given version of the given interface.

</description>

</event>

Notify the client of removed global objects.

This event notifies the client that the global identified

by name is no longer available. If the client bound to

the global using the bind request, the client should now

destroy that object.

The object remains valid and requests to the object will be

ignored until the client destroys it, to avoid races between

the global going away and a client sending a request to it.

</description>

</event>

</interface>

Clients can handle the 'done' event to get notified when

the related request is done.

</description>

Notify the client when the related request is done.

</description>

</event>

</interface>

A compositor. This object is a singleton global. The

compositor is in charge of combining the contents of multiple

surfaces into one displayable output.

</description>

Ask the compositor to create a new surface.

</description>

</request>

Ask the compositor to create a new region.

</description>

</request>

</interface>

The wl_shm_pool object encapsulates a piece of memory shared

between the compositor and client. Through the wl_shm_pool

object, the client can allocate shared memory wl_buffer objects.

All objects created through the same pool share the same

underlying mapped memory. Reusing the mapped memory avoids the

setup/teardown overhead and is useful when interactively resizing

a surface or for many small buffers.

</description>

Create a wl_buffer object from the pool.

The buffer is created offset bytes into the pool and has

width and height as specified. The stride argument specifies

the number of bytes from the beginning of one row to the beginning

of the next. The format is the pixel format of the buffer and

must be one of those advertised through the wl_shm.format event.

A buffer will keep a reference to the pool it was created from

so it is valid to destroy the pool immediately after creating

a buffer from it.

</description>

</request>

Destroy the shared memory pool.

The mmapped memory will be released when all

buffers that have been created from this pool

are gone.

</description>

</request>

This request will cause the server to remap the backing memory

for the pool from the file descriptor passed when the pool was

created, but using the new size. This request can only be

used to make the pool bigger.

This request only changes the amount of bytes that are mmapped

by the server and does not touch the file corresponding to the

file descriptor passed at creation time. It is the client's

responsibility to ensure that the file is at least as big as

the new pool size.

</description>

</request>

</interface>

A singleton global object that provides support for shared

memory.

Clients can create wl_shm_pool objects using the create_pool

request.

On binding the wl_shm object one or more format events

are emitted to inform clients about the valid pixel formats

that can be used for buffers.

</description>

These errors can be emitted in response to wl_shm requests.

</description>

</enum>

This describes the memory layout of an individual pixel.

All renderers should support argb8888 and xrgb8888 but any other

formats are optional and may not be supported by the particular

renderer in use.

The drm format codes match the macros defined in drm_fourcc.h, except

argb8888 and xrgb8888. The formats actually supported by the compositor

will be reported by the format event.

For all wl_shm formats and unless specified in another protocol

extension, pre-multiplied alpha is used for pixel values.

</description>

<!-- Note to protocol writers: don't update this list manually, instead

run the automated script that keeps it in sync with drm_fourcc.h. -->

</enum>

Create a new wl_shm_pool object.

The pool can be used to create shared memory based buffer

objects. The server will mmap size bytes of the passed file

descriptor, to use as backing memory for the pool.

</description>

</request>

Informs the client about a valid pixel format that

can be used for buffers. Known formats include

argb8888 and xrgb8888.

</description>

</event>

</interface>

A buffer provides the content for a wl_surface. Buffers are

created through factory interfaces such as wl_shm, wp_linux_buffer_params

(from the linux-dmabuf protocol extension) or similar. It has a width and

a height and can be attached to a wl_surface, but the mechanism by which a

client provides and updates the contents is defined by the buffer factory

interface.

If the buffer uses a format that has an alpha channel, the alpha channel

is assumed to be premultiplied in the color channels unless otherwise

specified.

</description>

Destroy a buffer. If and how you need to release the backing

storage is defined by the buffer factory interface.

For possible side-effects to a surface, see wl_surface.attach.

</description>

</request>

Sent when this wl_buffer is no longer used by the compositor.

The client is now free to reuse or destroy this buffer and its

backing storage.

If a client receives a release event before the frame callback

requested in the same wl_surface.commit that attaches this

wl_buffer to a surface, then the client is immediately free to

reuse the buffer and its backing storage, and does not need a

second buffer for the next surface content update. Typically

this is possible, when the compositor maintains a copy of the

wl_surface contents, e.g. as a GL texture. This is an important

optimization for GL(ES) compositors with wl_shm clients.

</description>

</event>

</interface>

A wl_data_offer represents a piece of data offered for transfer

by another client (the source client). It is used by the

copy-and-paste and drag-and-drop mechanisms. The offer

describes the different mime types that the data can be

converted to and provides the mechanism for transferring the

data directly from the source client.

</description>

<entry name="invalid_finish" value="0"

summary="finish request was called untimely"/>

<entry name="invalid_action_mask" value="1"

summary="action mask contains invalid values"/>

<entry name="invalid_action" value="2"

summary="action argument has an invalid value"/>

<entry name="invalid_offer" value="3"

summary="offer doesn't accept this request"/>

</enum>

Indicate that the client can accept the given mime type, or

NULL for not accepted.

For objects of version 2 or older, this request is used by the

client to give feedback whether the client can receive the given

mime type, or NULL if none is accepted; the feedback does not

determine whether the drag-and-drop operation succeeds or not.

For objects of version 3 or newer, this request determines the

final result of the drag-and-drop operation. If the end result

is that no mime types were accepted, the drag-and-drop operation

will be cancelled and the corresponding drag source will receive

wl_data_source.cancelled. Clients may still use this event in

conjunction with wl_data_source.action for feedback.

</description>

</request>

To transfer the offered data, the client issues this request

and indicates the mime type 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 then closes its end, at which point the transfer is

complete.

This request may happen multiple times for different mime types,

both before and after wl_data_device.drop. Drag-and-drop destination

clients may preemptively fetch data or examine it more closely to

determine acceptance.

</description>

</request>

Destroy the data offer.

</description>

</request>

Sent immediately after creating the wl_data_offer object. One

event per offered mime type.

</description>

</event>

Notifies the compositor that the drag destination successfully

finished the drag-and-drop operation.

Upon receiving this request, the compositor will emit

wl_data_source.dnd_finished on the drag source client.

It is a client error to perform other requests than

wl_data_offer.destroy after this one. It is also an error to perform

this request after a NULL mime type has been set in

wl_data_offer.accept or no action was received through

wl_data_offer.action.

If wl_data_offer.finish request is received for a non drag and drop

operation, the invalid_finish protocol error is raised.

</description>

</request>

Sets the actions that the destination side client supports for

this operation. This request may trigger the emission of

wl_data_source.action and wl_data_offer.action events if the compositor

needs to change the selected action.

This request can be called multiple times throughout the

drag-and-drop operation, typically in response to wl_data_device.enter

or wl_data_device.motion events.

This request determines the final result of the drag-and-drop

operation. If the end result is that no action is accepted,

the drag source will receive wl_data_source.cancelled.

The dnd_actions argument must contain only values expressed in the

wl_data_device_manager.dnd_actions enum, and the preferred_action

argument must only contain one of those values set, otherwise it

will result in a protocol error.

While managing an "ask" action, the destination drag-and-drop client

may perform further wl_data_offer.receive requests, and is expected

to perform one last wl_data_offer.set_actions request with a preferred

action other than "ask" (and optionally wl_data_offer.accept) before

requesting wl_data_offer.finish, in order to convey the action selected

by the user. If the preferred action is not in the

wl_data_offer.source_actions mask, an error will be raised.

If the "ask" action is dismissed (e.g. user cancellation), the client

is expected to perform wl_data_offer.destroy right away.

This request can only be made on drag-and-drop offers, a protocol error

will be raised otherwise.

</description>

<arg name="dnd_actions" type="uint" summary="actions supported by the destination client"

enum="wl_data_device_manager.dnd_action"/>

<arg name="preferred_action" type="uint" summary="action preferred by the destination client"

enum="wl_data_device_manager.dnd_action"/>

</request>

This event indicates the actions offered by the data source. It

will be sent right after wl_data_device.enter, or anytime the source

side changes its offered actions through wl_data_source.set_actions.

</description>

<arg name="source_actions" type="uint" summary="actions offered by the data source"

enum="wl_data_device_manager.dnd_action"/>

</event>

This event indicates the action selected by the compositor after

matching the source/destination side actions. Only one action (or

none) will be offered here.

This event can be emitted multiple times during the drag-and-drop

operation in response to destination side action changes through

wl_data_offer.set_actions.

This event will no longer be emitted after wl_data_device.drop

happened on the drag-and-drop destination, the client must

honor the last action received, or the last preferred one set

through wl_data_offer.set_actions when handling an "ask" action.

Compositors may also change the selected action on the fly, mainly

in response to keyboard modifier changes during the drag-and-drop

operation.

The most recent action received is always the valid one. Prior to

receiving wl_data_device.drop, the chosen action may change (e.g.

due to keyboard modifiers being pressed). At the time of receiving

wl_data_device.drop the drag-and-drop destination must honor the

last action received.

Action changes may still happen after wl_data_device.drop,

especially on "ask" actions, where the drag-and-drop destination

may choose another action afterwards. Action changes happening

at this stage are always the result of inter-client negotiation, the

compositor shall no longer be able to induce a different action.

Upon "ask" actions, it is expected that the drag-and-drop destination

may potentially choose a different action and/or mime type,

based on wl_data_offer.source_actions and finally chosen by the

user (e.g. popping up a menu with the available options). The

final wl_data_offer.set_actions and wl_data_offer.accept requests

must happen before the call to wl_data_offer.finish.

</description>

<arg name="dnd_action" type="uint" summary="action selected by the compositor"

enum="wl_data_device_manager.dnd_action"/>

</event>

</interface>

The wl_data_source object is the source side of a wl_data_offer.

It is created by the source client in a data transfer and

provides a way to describe the offered data and a way to respond

to requests to transfer the data.

</description>

<entry name="invalid_action_mask" value="0"

summary="action mask contains invalid values"/>

<entry name="invalid_source" value="1"

summary="source doesn't accept this request"/>

</enum>

This request adds a mime type to the set of mime types

advertised to targets. Can be called several times to offer

multiple types.

</description>

</request>

Destroy the data source.

</description>

</request>

Sent when a target accepts pointer_focus or motion events. If

a target does not accept any of the offered types, type is NULL.

Used for feedback during drag-and-drop.

</description>

</event>

Request for data from the client. Send the data as the

specified mime type over the passed file descriptor, then

close it.

</description>

</event>

This data source is no longer valid. There are several reasons why

this could happen:

- The data source has been replaced by another data source.

- The drag-and-drop operation was performed, but the drop destination

did not accept any of the mime types offered through

wl_data_source.target.

- The drag-and-drop operation was performed, but the drop destination

did not select any of the actions present in the mask offered through

wl_data_source.action.

- The drag-and-drop operation was performed but didn't happen over a

surface.

- The compositor cancelled the drag-and-drop operation (e.g. compositor

dependent timeouts to avoid stale drag-and-drop transfers).

The client should clean up and destroy this data source.

For objects of version 2 or older, wl_data_source.cancelled will

only be emitted if the data source was replaced by another data

source.

</description>

</event>

Sets the actions that the source side client supports for this

operation. This request may trigger wl_data_source.action and

wl_data_offer.action events if the compositor needs to change the

selected action.

The dnd_actions argument must contain only values expressed in the

wl_data_device_manager.dnd_actions enum, otherwise it will result

in a protocol error.

This request must be made once only, and can only be made on sources

used in drag-and-drop, so it must be performed before

wl_data_device.start_drag. Attempting to use the source other than

for drag-and-drop will raise a protocol error.

</description>

<arg name="dnd_actions" type="uint" summary="actions supported by the data source"

enum="wl_data_device_manager.dnd_action"/>

</request>

The user performed the drop action. This event does not indicate

acceptance, wl_data_source.cancelled may still be emitted afterwards

if the drop destination does not accept any mime type.

However, this event might however not be received if the compositor

cancelled the drag-and-drop operation before this event could happen.

Note that the data_source may still be used in the future and should

not be destroyed here.

</description>

</event>

The drop destination finished interoperating with this data

source, so the client is now free to destroy this data source and

free all associated data.

If the action used to perform the operation was "move", the

source can now delete the transferred data.

</description>

</event>

This event indicates the action selected by the compositor after

matching the source/destination side actions. Only one action (or

none) will be offered here.

This event can be emitted multiple times during the drag-and-drop

operation, mainly in response to destination side changes through

wl_data_offer.set_actions, and as the data device enters/leaves

surfaces.

It is only possible to receive this event after

wl_data_source.dnd_drop_performed if the drag-and-drop operation

ended in an "ask" action, in which case the final wl_data_source.action

event will happen immediately before wl_data_source.dnd_finished.

Compositors may also change the selected action on the fly, mainly

in response to keyboard modifier changes during the drag-and-drop

operation.

The most recent action received is always the valid one. The chosen

action may change alongside negotiation (e.g. an "ask" action can turn

into a "move" operation), so the effects of the final action must

always be applied in wl_data_offer.dnd_finished.

Clients can trigger cursor surface changes from this point, so

they reflect the current action.

</description>

<arg name="dnd_action" type="uint" summary="action selected by the compositor"

enum="wl_data_device_manager.dnd_action"/>

</event>

</interface>

There is one wl_data_device per seat which can be obtained

from the global wl_data_device_manager singleton.

A wl_data_device provides access to inter-client data transfer

mechanisms such as copy-and-paste and drag-and-drop.

</description>

</enum>

This request asks the compositor to start a drag-and-drop

operation on behalf of the client.

The source argument is the data source that provides the data

for the eventual data transfer. If source is NULL, enter, leave

and motion events are sent only to the client that initiated the

drag and the client is expected to handle the data passing

internally. If source is destroyed, the drag-and-drop session will be

cancelled.

The origin surface is the surface where the drag originates and

the client must have an active implicit grab that matches the

serial.

The icon surface is an optional (can be NULL) surface that

provides an icon to be moved around with the cursor. Initially,

the top-left corner of the icon surface is placed at the cursor

hotspot, but subsequent wl_surface.attach request can move the

relative position. Attach requests must be confirmed with

wl_surface.commit as usual. The icon surface is given the role of

a drag-and-drop icon. If the icon surface already has another role,

it raises a protocol error.

The current and pending input regions of the icon wl_surface are

cleared, and wl_surface.set_input_region is ignored until the

wl_surface is no longer used as the icon surface. When the use

as an icon ends, the current and pending input regions become

undefined, and the wl_surface is unmapped.

</description>

</request>

This request asks the compositor to set the selection

to the data from the source on behalf of the client.

To unset the selection, set the source to NULL.

</description>

</request>

The data_offer event introduces a new wl_data_offer object,

which will subsequently be used in either the

data_device.enter event (for drag-and-drop) or the

data_device.selection event (for selections). Immediately

following the data_device.data_offer event, the new data_offer

object will send out data_offer.offer events to describe the

mime types it offers.

</description>

</event>

This event is sent when an active drag-and-drop pointer enters

a surface owned by the client. The position of the pointer at

enter time is provided by the x and y arguments, in surface-local

coordinates.

</description>

<arg name="id" type="object" interface="wl_data_offer" allow-null="true"

summary="source data_offer object"/>

</event>

This event is sent when the drag-and-drop pointer leaves the

surface and the session ends. The client must destroy the

wl_data_offer introduced at enter time at this point.

</description>

</event>

This event is sent when the drag-and-drop pointer moves within

the currently focused surface. The new position of the pointer

is provided by the x and y arguments, in surface-local

coordinates.

</description>

</event>

The event is sent when a drag-and-drop operation is ended

because the implicit grab is removed.

The drag-and-drop destination is expected to honor the last action

received through wl_data_offer.action, if the resulting action is

"copy" or "move", the destination can still perform

wl_data_offer.receive requests, and is expected to end all

transfers with a wl_data_offer.finish request.

If the resulting action is "ask", the action will not be considered

final. The drag-and-drop destination is expected to perform one last

wl_data_offer.set_actions request, or wl_data_offer.destroy in order

to cancel the operation.

</description>

</event>

The selection event is sent out to notify the client of a new

wl_data_offer for the selection for this device. The

data_device.data_offer and the data_offer.offer events are

sent out immediately before this event to introduce the data

offer object. The selection event is sent to a client

immediately before receiving keyboard focus and when a new

selection is set while the client has keyboard focus. The

data_offer is valid until a new data_offer or NULL is received

or until the client loses keyboard focus. Switching surface with

keyboard focus within the same client doesn't mean a new selection

will be sent. The client must destroy the previous selection

data_offer, if any, upon receiving this event.

</description>

<arg name="id" type="object" interface="wl_data_offer" allow-null="true"

summary="selection data_offer object"/>

</event>

This request destroys the data device.

</description>

</request>

</interface>

The wl_data_device_manager is a singleton global object that

provides access to inter-client data transfer mechanisms such as

copy-and-paste and drag-and-drop. These mechanisms are tied to

a wl_seat and this interface lets a client get a wl_data_device

corresponding to a wl_seat.

Depending on the version bound, the objects created from the bound

wl_data_device_manager object will have different requirements for

functioning properly. See wl_data_source.set_actions,

wl_data_offer.accept and wl_data_offer.finish for details.

</description>

View remainder of file in raw view

FilesExpand file tree

wayland.xml

Latest commit

History

wayland.xml

File metadata and controls