docs/reference/gobject/tmpl/signals.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Signals
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12
  13 <!-- ##### SECTION See_Also ##### -->
  14 <para>
  15
  16 </para>
  17
  18
  19 <!-- ##### SECTION Stability_Level ##### -->
  20
  21
  22 <!-- ##### STRUCT GSignalInvocationHint ##### -->
  23 <para>
  24
  25 </para>
  26
  27 @signal_id:
  28 @detail:
  29 @run_type:
  30
  31 <!-- ##### USER_FUNCTION GSignalAccumulator ##### -->
  32 <para>
  33
  34 </para>
  35
  36 @ihint:
  37 @return_accu:
  38 @handler_return:
  39 @data:
  40 @Returns:
  41
  42
  43 <!-- ##### TYPEDEF GSignalCMarshaller ##### -->
  44 <para>
  45
  46 </para>
  47
  48
  49 <!-- ##### USER_FUNCTION GSignalEmissionHook ##### -->
  50 <para>
  51
  52 </para>
  53
  54 @ihint:
  55 @n_param_values:
  56 @param_values:
  57 @data:
  58 @Returns:
  59
  60
  61 <!-- ##### ENUM GSignalFlags ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @G_SIGNAL_RUN_FIRST:
  67 @G_SIGNAL_RUN_LAST:
  68 @G_SIGNAL_RUN_CLEANUP:
  69 @G_SIGNAL_NO_RECURSE:
  70 @G_SIGNAL_DETAILED:
  71 @G_SIGNAL_ACTION:
  72 @G_SIGNAL_NO_HOOKS:
  73
  74 <!-- ##### ENUM GSignalMatchType ##### -->
  75 <para>
  76
  77 </para>
  78
  79 @G_SIGNAL_MATCH_ID:
  80 @G_SIGNAL_MATCH_DETAIL:
  81 @G_SIGNAL_MATCH_CLOSURE:
  82 @G_SIGNAL_MATCH_FUNC:
  83 @G_SIGNAL_MATCH_DATA:
  84 @G_SIGNAL_MATCH_UNBLOCKED:
  85
  86 <!-- ##### STRUCT GSignalQuery ##### -->
  87 <para>
  88
  89 </para>
  90
  91 @signal_id:
  92 @signal_name:
  93 @itype:
  94 @signal_flags:
  95 @return_type:
  96 @n_params:
  97 @param_types:
  98
  99 <!-- ##### MACRO G_SIGNAL_TYPE_STATIC_SCOPE ##### -->
 100 <para>
 101
 102 </para>
 103
 104
 105
 106 <!-- ##### MACRO G_SIGNAL_MATCH_MASK ##### -->
 107 <para>
 108
 109 </para>
 110
 111
 112
 113 <!-- ##### MACRO G_SIGNAL_FLAGS_MASK ##### -->
 114 <para>
 115
 116 </para>
 117
 118
 119
 120 <!-- ##### FUNCTION g_signal_new ##### -->
 121 <para>
 122
 123 </para>
 124
 125 @signal_name:
 126 @itype:
 127 @signal_flags:
 128 @class_offset:
 129 @accumulator:
 130 @accu_data:
 131 @c_marshaller:
 132 @return_type:
 133 @n_params:
 134 @Varargs:
 135 @Returns:
 136
 137
 138 <!-- ##### FUNCTION g_signal_newv ##### -->
 139 <para>
 140
 141 </para>
 142
 143 @signal_name:
 144 @itype:
 145 @signal_flags:
 146 @class_closure:
 147 @accumulator:
 148 @accu_data:
 149 @c_marshaller:
 150 @return_type:
 151 @n_params:
 152 @param_types:
 153 @Returns:
 154
 155
 156 <!-- ##### FUNCTION g_signal_new_valist ##### -->
 157 <para>
 158
 159 </para>
 160
 161 @signal_name:
 162 @itype:
 163 @signal_flags:
 164 @class_closure:
 165 @accumulator:
 166 @accu_data:
 167 @c_marshaller:
 168 @return_type:
 169 @n_params:
 170 @args:
 171 @Returns:
 172
 173
 174 <!-- ##### FUNCTION g_signal_query ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @signal_id:
 180 @query:
 181
 182
 183 <!-- ##### FUNCTION g_signal_lookup ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @name:
 189 @itype:
 190 @Returns:
 191
 192
 193 <!-- ##### FUNCTION g_signal_name ##### -->
 194 <para>
 195
 196 </para>
 197
 198 @signal_id:
 199 @Returns:
 200
 201
 202 <!-- ##### FUNCTION g_signal_list_ids ##### -->
 203 <para>
 204
 205 </para>
 206
 207 @itype:
 208 @n_ids:
 209 @Returns:
 210
 211
 212 <!-- ##### FUNCTION g_signal_emit ##### -->
 213 <para>
 214
 215 </para>
 216
 217 @instance:
 218 @signal_id:
 219 @detail:
 220 @Varargs:
 221
 222
 223 <!-- ##### FUNCTION g_signal_emit_by_name ##### -->
 224 <para>
 225
 226 </para>
 227
 228 @instance:
 229 @detailed_signal:
 230 @Varargs:
 231
 232
 233 <!-- ##### FUNCTION g_signal_emitv ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @instance_and_params:
 239 @signal_id:
 240 @detail:
 241 @return_value:
 242
 243
 244 <!-- ##### FUNCTION g_signal_emit_valist ##### -->
 245 <para>
 246
 247 </para>
 248
 249 @instance:
 250 @signal_id:
 251 @detail:
 252 @var_args:
 253
 254
 255 <!-- ##### MACRO g_signal_connect ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @instance:
 261 @detailed_signal:
 262 @c_handler:
 263 @data:
 264
 265
 266 <!-- ##### MACRO g_signal_connect_after ##### -->
 267 <para>
 268
 269 </para>
 270
 271 @instance:
 272 @detailed_signal:
 273 @c_handler:
 274 @data:
 275
 276
 277 <!-- ##### MACRO g_signal_connect_swapped ##### -->
 278 <para>
 279
 280 </para>
 281
 282 @instance:
 283 @detailed_signal:
 284 @c_handler:
 285 @data:
 286
 287
 288 <!-- ##### FUNCTION g_signal_connect_object ##### -->
 289 <para>
 290
 291 </para>
 292
 293 @instance:
 294 @detailed_signal:
 295 @c_handler:
 296 @gobject:
 297 @connect_flags:
 298 @Returns:
 299
 300
 301 <!-- ##### ENUM GConnectFlags ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @G_CONNECT_AFTER:
 307 @G_CONNECT_SWAPPED:
 308
 309 <!-- ##### FUNCTION g_signal_connect_data ##### -->
 310 <para>
 311
 312 </para>
 313
 314 @instance:
 315 @detailed_signal:
 316 @c_handler:
 317 @data:
 318 @destroy_data:
 319 @connect_flags:
 320 @Returns:
 321
 322
 323 <!-- ##### FUNCTION g_signal_connect_closure ##### -->
 324 <para>
 325
 326 </para>
 327
 328 @instance:
 329 @detailed_signal:
 330 @closure:
 331 @after:
 332 @Returns:
 333
 334
 335 <!-- ##### FUNCTION g_signal_connect_closure_by_id ##### -->
 336 <para>
 337
 338 </para>
 339
 340 @instance:
 341 @signal_id:
 342 @detail:
 343 @closure:
 344 @after:
 345 @Returns:
 346
 347
 348 <!-- ##### FUNCTION g_signal_handler_block ##### -->
 349 <para>
 350
 351 </para>
 352
 353 @instance:
 354 @handler_id:
 355
 356
 357 <!-- ##### FUNCTION g_signal_handler_unblock ##### -->
 358 <para>
 359
 360 </para>
 361
 362 @instance:
 363 @handler_id:
 364
 365
 366 <!-- ##### FUNCTION g_signal_handler_disconnect ##### -->
 367 <para>
 368
 369 </para>
 370
 371 @instance:
 372 @handler_id:
 373
 374
 375 <!-- ##### FUNCTION g_signal_handler_find ##### -->
 376 <para>
 377
 378 </para>
 379
 380 @instance:
 381 @mask:
 382 @signal_id:
 383 @detail:
 384 @closure:
 385 @func:
 386 @data:
 387 @Returns:
 388
 389
 390 <!-- ##### FUNCTION g_signal_handlers_block_matched ##### -->
 391 <para>
 392
 393 </para>
 394
 395 @instance:
 396 @mask:
 397 @signal_id:
 398 @detail:
 399 @closure:
 400 @func:
 401 @data:
 402 @Returns:
 403
 404
 405 <!-- ##### FUNCTION g_signal_handlers_unblock_matched ##### -->
 406 <para>
 407
 408 </para>
 409
 410 @instance:
 411 @mask:
 412 @signal_id:
 413 @detail:
 414 @closure:
 415 @func:
 416 @data:
 417 @Returns:
 418
 419
 420 <!-- ##### FUNCTION g_signal_handlers_disconnect_matched ##### -->
 421 <para>
 422
 423 </para>
 424
 425 @instance:
 426 @mask:
 427 @signal_id:
 428 @detail:
 429 @closure:
 430 @func:
 431 @data:
 432 @Returns:
 433
 434
 435 <!-- ##### FUNCTION g_signal_handler_is_connected ##### -->
 436 <para>
 437
 438 </para>
 439
 440 @instance:
 441 @handler_id:
 442 @Returns:
 443
 444
 445 <!-- ##### MACRO g_signal_handlers_block_by_func ##### -->
 446 <para>
 447
 448 </para>
 449
 450 @instance:
 451 @func:
 452 @data:
 453
 454
 455 <!-- ##### MACRO g_signal_handlers_unblock_by_func ##### -->
 456 <para>
 457
 458 </para>
 459
 460 @instance:
 461 @func:
 462 @data:
 463
 464
 465 <!-- ##### MACRO g_signal_handlers_disconnect_by_func ##### -->
 466 <para>
 467
 468 </para>
 469
 470 @instance:
 471 @func:
 472 @data:
 473
 474
 475 <!-- ##### FUNCTION g_signal_has_handler_pending ##### -->
 476 <para>
 477
 478 </para>
 479
 480 @instance:
 481 @signal_id:
 482 @detail:
 483 @may_be_blocked:
 484 @Returns:
 485
 486
 487 <!-- ##### FUNCTION g_signal_stop_emission ##### -->
 488 <para>
 489
 490 </para>
 491
 492 @instance:
 493 @signal_id:
 494 @detail:
 495
 496
 497 <!-- ##### FUNCTION g_signal_stop_emission_by_name ##### -->
 498 <para>
 499
 500 </para>
 501
 502 @instance:
 503 @detailed_signal:
 504
 505
 506 <!-- ##### FUNCTION g_signal_override_class_closure ##### -->
 507 <para>
 508
 509 </para>
 510
 511 @signal_id:
 512 @instance_type:
 513 @class_closure:
 514
 515
 516 <!-- ##### FUNCTION g_signal_chain_from_overridden ##### -->
 517 <para>
 518
 519 </para>
 520
 521 @instance_and_params:
 522 @return_value:
 523
 524
 525 <!-- ##### FUNCTION g_signal_new_class_handler ##### -->
 526 <para>
 527
 528 </para>
 529
 530 @signal_name:
 531 @itype:
 532 @signal_flags:
 533 @class_handler:
 534 @accumulator:
 535 @accu_data:
 536 @c_marshaller:
 537 @return_type:
 538 @n_params:
 539 @Varargs:
 540 @Returns:
 541
 542
 543 <!-- ##### FUNCTION g_signal_override_class_handler ##### -->
 544 <para>
 545
 546 </para>
 547
 548 @signal_name:
 549 @instance_type:
 550 @class_handler:
 551
 552
 553 <!-- ##### FUNCTION g_signal_chain_from_overridden_handler ##### -->
 554 <para>
 555
 556 </para>
 557
 558 @instance:
 559 @Varargs:
 560
 561
 562 <!-- ##### FUNCTION g_signal_add_emission_hook ##### -->
 563 <para>
 564
 565 </para>
 566
 567 @signal_id:
 568 @detail:
 569 @hook_func:
 570 @hook_data:
 571 @data_destroy:
 572 @Returns:
 573
 574
 575 <!-- ##### FUNCTION g_signal_remove_emission_hook ##### -->
 576 <para>
 577
 578 </para>
 579
 580 @signal_id:
 581 @hook_id:
 582
 583
 584 <!-- ##### FUNCTION g_signal_parse_name ##### -->
 585 <para>
 586
 587 </para>
 588
 589 @detailed_signal:
 590 @itype:
 591 @signal_id_p:
 592 @detail_p:
 593 @force_detail_quark:
 594 @Returns:
 595
 596
 597 <!-- ##### FUNCTION g_signal_get_invocation_hint ##### -->
 598 <para>
 599
 600 </para>
 601
 602 @instance:
 603 @Returns:
 604
 605
 606 <!-- ##### FUNCTION g_signal_type_cclosure_new ##### -->
 607 <para>
 608
 609 </para>
 610
 611 @itype:
 612 @struct_offset:
 613 @Returns:
 614
 615
 616 <!-- ##### FUNCTION g_signal_accumulator_true_handled ##### -->
 617 <para>
 618
 619 </para>
 620
 621 @ihint:
 622 @return_accu:
 623 @handler_return:
 624 @dummy:
 625 @Returns:
 626
 627