Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkselection.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Selections
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Functions for handling inter-process communication via selections
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8
   9 <para>
  10 The selection mechanism provides the basis for different types
  11 of communication between processes. In particular, drag and drop and
  12 #GtkClipboard work via selections. You will very seldom or
  13 never need to use most of the functions in this section directly;
  14 #GtkClipboard provides a nicer interface to the same functionality.
  15 </para>
  16 <para>
  17 Some of the datatypes defined this section are used in
  18 the #GtkClipboard and drag-and-drop API's as well. The
  19 #GtkTargetEntry structure and #GtkTargetList objects represent
  20 lists of data types that are supported when sending or
  21 receiving data. The #GtkSelectionData object is used to
  22 store a chunk of data along with the data type and other
  23 associated information.
  24 </para>
  25
  26 <!-- ##### SECTION See_Also ##### -->
  27 <para>
  28 <variablelist>
  29
  30 <varlistentry>
  31 <term>#GtkWidget</term>
  32 <listitem><para>Much of the operation of selections happens via
  33              signals for #GtkWidget. In particular, if you are
  34              using the functions in this section, you may need
  35              to pay attention to ::selection_get,
  36              ::selection_received,  and :selection_clear_event
  37              signals.</para></listitem>
  38 </varlistentry>
  39
  40 </variablelist>
  41
  42 </para>
  43
  44 <!-- ##### SECTION Stability_Level ##### -->
  45
  46
  47 <!-- ##### SECTION Image ##### -->
  48
  49
  50 <!-- ##### STRUCT GtkTargetEntry ##### -->
  51 <para>
  52 A #GtkTargetEntry structure represents a single type of
  53 data than can be supplied for by a widget for a selection
  54 or for supplied or received during drag-and-drop. It
  55 contains a string representing the drag type, a flags
  56 field (used only for drag and drop - see #GtkTargetFlags),
  57 and an application assigned integer ID. The integer
  58 ID will later be passed as a signal parameter for signals
  59 like "selection_get". It allows the application to identify
  60 the target type without extensive string compares.
  61 </para>
  62
  63 @target:
  64 @flags:
  65 @info:
  66
  67 <!-- ##### STRUCT GtkTargetList ##### -->
  68 <para>
  69 A #GtkTargetList structure is a reference counted list
  70 of #GtkTargetPair. It is used to represent the same
  71 information as a table of #GtkTargetEntry, but in
  72 an efficient form. This structure should be treated as
  73 opaque.
  74 </para>
  75
  76 @list:
  77 @ref_count:
  78
  79 <!-- ##### STRUCT GtkTargetPair ##### -->
  80 <para>
  81 Internally used structure in the drag-and-drop and
  82 selection handling code.
  83 </para>
  84
  85 @target:
  86 @flags:
  87 @info:
  88
  89 <!-- ##### FUNCTION gtk_target_list_new ##### -->
  90 <para>
  91 </para>
  92
  93 @targets:
  94 @ntargets:
  95 @Returns:
  96
  97
  98 <!-- ##### FUNCTION gtk_target_list_ref ##### -->
  99 <para>
 100 </para>
 101
 102 @list:
 103 @Returns:
 104
 105
 106 <!-- ##### FUNCTION gtk_target_list_unref ##### -->
 107 <para>
 108 </para>
 109
 110 @list:
 111
 112
 113 <!-- ##### FUNCTION gtk_target_list_add ##### -->
 114 <para>
 115 </para>
 116
 117 @list:
 118 @target:
 119 @flags:
 120 @info:
 121
 122
 123 <!-- ##### FUNCTION gtk_target_list_add_table ##### -->
 124 <para>
 125 </para>
 126
 127 @list:
 128 @targets:
 129 @ntargets:
 130
 131
 132 <!-- ##### FUNCTION gtk_target_list_add_text_targets ##### -->
 133 <para>
 134
 135 </para>
 136
 137 @list:
 138 @info:
 139
 140
 141 <!-- ##### FUNCTION gtk_target_list_add_image_targets ##### -->
 142 <para>
 143
 144 </para>
 145
 146 @list:
 147 @info:
 148 @writable:
 149
 150
 151 <!-- ##### FUNCTION gtk_target_list_add_uri_targets ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @list:
 157 @info:
 158
 159
 160 <!-- ##### FUNCTION gtk_target_list_add_rich_text_targets ##### -->
 161 <para>
 162
 163 </para>
 164
 165 @list:
 166 @info:
 167 @deserializable:
 168 @buffer:
 169
 170
 171 <!-- ##### FUNCTION gtk_target_list_remove ##### -->
 172 <para>
 173 </para>
 174
 175 @list:
 176 @target:
 177
 178
 179 <!-- ##### FUNCTION gtk_target_list_find ##### -->
 180 <para>
 181 </para>
 182
 183 @list:
 184 @target:
 185 @info:
 186 @Returns:
 187
 188
 189 <!-- ##### FUNCTION gtk_target_table_free ##### -->
 190 <para>
 191
 192 </para>
 193
 194 @targets:
 195 @n_targets:
 196
 197
 198 <!-- ##### FUNCTION gtk_target_table_new_from_list ##### -->
 199 <para>
 200
 201 </para>
 202
 203 @list:
 204 @n_targets:
 205 @Returns:
 206
 207
 208 <!-- ##### FUNCTION gtk_selection_owner_set ##### -->
 209 <para>
 210 </para>
 211
 212 @widget:
 213 @selection:
 214 @time_:
 215 @Returns:
 216
 217
 218 <!-- ##### FUNCTION gtk_selection_owner_set_for_display ##### -->
 219 <para>
 220
 221 </para>
 222
 223 @display:
 224 @widget:
 225 @selection:
 226 @time_:
 227 @Returns:
 228
 229
 230 <!-- ##### FUNCTION gtk_selection_add_target ##### -->
 231 <para>
 232 </para>
 233
 234 @widget:
 235 @selection:
 236 @target:
 237 @info:
 238
 239
 240 <!-- ##### FUNCTION gtk_selection_add_targets ##### -->
 241 <para>
 242 </para>
 243
 244 @widget:
 245 @selection:
 246 @targets:
 247 @ntargets:
 248
 249
 250 <!-- ##### FUNCTION gtk_selection_clear_targets ##### -->
 251 <para>
 252
 253 </para>
 254
 255 @widget:
 256 @selection:
 257
 258
 259 <!-- ##### FUNCTION gtk_selection_convert ##### -->
 260 <para>
 261 </para>
 262
 263 @widget:
 264 @selection:
 265 @target:
 266 @time_:
 267 @Returns: x
 268
 269
 270 <!-- ##### FUNCTION gtk_selection_data_set ##### -->
 271 <para>
 272 </para>
 273
 274 @selection_data:
 275 @type:
 276 @format:
 277 @data:
 278 @length:
 279
 280
 281 <!-- ##### FUNCTION gtk_selection_data_set_text ##### -->
 282 <para>
 283
 284 </para>
 285
 286 @selection_data:
 287 @str:
 288 @len:
 289 @Returns:
 290
 291
 292 <!-- ##### FUNCTION gtk_selection_data_get_text ##### -->
 293 <para>
 294
 295 </para>
 296
 297 @selection_data:
 298 @Returns:
 299
 300
 301 <!-- ##### FUNCTION gtk_selection_data_set_pixbuf ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @selection_data:
 307 @pixbuf:
 308 @Returns:
 309
 310
 311 <!-- ##### FUNCTION gtk_selection_data_get_pixbuf ##### -->
 312 <para>
 313
 314 </para>
 315
 316 @selection_data:
 317 @Returns:
 318
 319
 320 <!-- ##### FUNCTION gtk_selection_data_set_uris ##### -->
 321 <para>
 322
 323 </para>
 324
 325 @selection_data:
 326 @uris:
 327 @Returns:
 328
 329
 330 <!-- ##### FUNCTION gtk_selection_data_get_uris ##### -->
 331 <para>
 332
 333 </para>
 334
 335 @selection_data:
 336 @Returns:
 337
 338
 339 <!-- ##### FUNCTION gtk_selection_data_get_targets ##### -->
 340 <para>
 341
 342 </para>
 343
 344 @selection_data:
 345 @targets:
 346 @n_atoms:
 347 @Returns:
 348
 349
 350 <!-- ##### FUNCTION gtk_selection_data_targets_include_image ##### -->
 351 <para>
 352
 353 </para>
 354
 355 @selection_data:
 356 @writable:
 357 @Returns:
 358
 359
 360 <!-- ##### FUNCTION gtk_selection_data_targets_include_text ##### -->
 361 <para>
 362
 363 </para>
 364
 365 @selection_data:
 366 @Returns:
 367
 368
 369 <!-- ##### FUNCTION gtk_selection_data_targets_include_uri ##### -->
 370 <para>
 371
 372 </para>
 373
 374 @selection_data:
 375 @Returns:
 376
 377
 378 <!-- ##### FUNCTION gtk_selection_data_targets_include_rich_text ##### -->
 379 <para>
 380
 381 </para>
 382
 383 @selection_data:
 384 @buffer:
 385 @Returns:
 386
 387
 388 <!-- ##### FUNCTION gtk_selection_data_get_selection ##### -->
 389 <para>
 390
 391 </para>
 392
 393 @selection_data:
 394 @Returns:
 395
 396
 397 <!-- ##### FUNCTION gtk_selection_data_get_data ##### -->
 398 <para>
 399
 400 </para>
 401
 402 @selection_data:
 403 @Returns:
 404
 405
 406 <!-- ##### FUNCTION gtk_selection_data_get_length ##### -->
 407 <para>
 408
 409 </para>
 410
 411 @selection_data:
 412 @Returns:
 413
 414
 415 <!-- ##### FUNCTION gtk_selection_data_get_data_type ##### -->
 416 <para>
 417
 418 </para>
 419
 420 @selection_data:
 421 @Returns:
 422
 423
 424 <!-- ##### FUNCTION gtk_selection_data_get_display ##### -->
 425 <para>
 426
 427 </para>
 428
 429 @selection_data:
 430 @Returns:
 431
 432
 433 <!-- ##### FUNCTION gtk_selection_data_get_format ##### -->
 434 <para>
 435
 436 </para>
 437
 438 @selection_data:
 439 @Returns:
 440
 441
 442 <!-- ##### FUNCTION gtk_selection_data_get_target ##### -->
 443 <para>
 444
 445 </para>
 446
 447 @selection_data:
 448 @Returns:
 449
 450
 451 <!-- ##### FUNCTION gtk_targets_include_image ##### -->
 452 <para>
 453
 454 </para>
 455
 456 @targets:
 457 @n_targets:
 458 @writable:
 459 @Returns:
 460
 461
 462 <!-- ##### FUNCTION gtk_targets_include_text ##### -->
 463 <para>
 464
 465 </para>
 466
 467 @targets:
 468 @n_targets:
 469 @Returns:
 470
 471
 472 <!-- ##### FUNCTION gtk_targets_include_uri ##### -->
 473 <para>
 474
 475 </para>
 476
 477 @targets:
 478 @n_targets:
 479 @Returns:
 480
 481
 482 <!-- ##### FUNCTION gtk_targets_include_rich_text ##### -->
 483 <para>
 484
 485 </para>
 486
 487 @targets:
 488 @n_targets:
 489 @buffer:
 490 @Returns:
 491
 492
 493 <!-- ##### FUNCTION gtk_selection_remove_all ##### -->
 494 <para>
 495 </para>
 496
 497 @widget:
 498
 499
 500 <!-- ##### FUNCTION gtk_selection_data_copy ##### -->
 501 <para>
 502 </para>
 503
 504 @data:
 505 @Returns:
 506
 507
 508 <!-- ##### FUNCTION gtk_selection_data_free ##### -->
 509 <para>
 510 </para>
 511
 512 @data:
 513
 514