docs/reference/gobject/tmpl/gclosure.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Closures
   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 <!-- ##### MACRO G_CLOSURE_NEEDS_MARSHAL ##### -->
  23 <para>
  24
  25 </para>
  26
  27 @closure:
  28
  29
  30 <!-- ##### MACRO G_CLOSURE_N_NOTIFIERS ##### -->
  31 <para>
  32
  33 </para>
  34
  35 @cl:
  36
  37
  38 <!-- ##### MACRO G_CCLOSURE_SWAP_DATA ##### -->
  39 <para>
  40
  41 </para>
  42
  43 @cclosure:
  44
  45
  46 <!-- ##### MACRO G_CALLBACK ##### -->
  47 <para>
  48
  49 </para>
  50
  51 @f:
  52
  53
  54 <!-- ##### USER_FUNCTION GCallback ##### -->
  55 <para>
  56
  57 </para>
  58
  59
  60
  61 <!-- ##### STRUCT GClosure ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @in_marshal:
  67 @is_invalid:
  68
  69 <!-- ##### MACRO G_TYPE_CLOSURE ##### -->
  70 <para>
  71
  72 </para>
  73
  74
  75
  76 <!-- ##### STRUCT GCClosure ##### -->
  77 <para>
  78
  79 </para>
  80
  81 @closure:
  82 @callback:
  83
  84 <!-- ##### USER_FUNCTION GClosureMarshal ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @closure:
  90 @return_value:
  91 @n_param_values:
  92 @param_values:
  93 @invocation_hint:
  94 @marshal_data:
  95
  96
  97 <!-- ##### USER_FUNCTION GClosureNotify ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @data:
 103 @closure:
 104
 105
 106 <!-- ##### FUNCTION g_cclosure_new ##### -->
 107 <para>
 108
 109 </para>
 110
 111 @callback_func:
 112 @user_data:
 113 @destroy_data:
 114 @Returns:
 115
 116
 117 <!-- ##### FUNCTION g_cclosure_new_swap ##### -->
 118 <para>
 119
 120 </para>
 121
 122 @callback_func:
 123 @user_data:
 124 @destroy_data:
 125 @Returns:
 126
 127
 128 <!-- ##### FUNCTION g_cclosure_new_object ##### -->
 129 <para>
 130
 131 </para>
 132
 133 @callback_func:
 134 @object:
 135 @Returns:
 136
 137
 138 <!-- ##### FUNCTION g_cclosure_new_object_swap ##### -->
 139 <para>
 140
 141 </para>
 142
 143 @callback_func:
 144 @object:
 145 @Returns:
 146
 147
 148 <!-- ##### FUNCTION g_closure_new_object ##### -->
 149 <para>
 150
 151 </para>
 152
 153 @sizeof_closure:
 154 @object:
 155 @Returns:
 156
 157
 158 <!-- ##### FUNCTION g_closure_ref ##### -->
 159 <para>
 160
 161 </para>
 162
 163 @closure:
 164 @Returns:
 165
 166
 167 <!-- ##### FUNCTION g_closure_sink ##### -->
 168 <para>
 169
 170 </para>
 171
 172 @closure:
 173
 174
 175 <!-- ##### FUNCTION g_closure_unref ##### -->
 176 <para>
 177
 178 </para>
 179
 180 @closure:
 181
 182
 183 <!-- ##### FUNCTION g_closure_invoke ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @closure:
 189 @return_value:
 190 @n_param_values:
 191 @param_values:
 192 @invocation_hint:
 193
 194
 195 <!-- ##### FUNCTION g_closure_invalidate ##### -->
 196 <para>
 197
 198 </para>
 199
 200 @closure:
 201
 202
 203 <!-- ##### FUNCTION g_closure_add_finalize_notifier ##### -->
 204 <para>
 205
 206 </para>
 207
 208 @closure:
 209 @notify_data:
 210 @notify_func:
 211
 212
 213 <!-- ##### FUNCTION g_closure_add_invalidate_notifier ##### -->
 214 <para>
 215
 216 </para>
 217
 218 @closure:
 219 @notify_data:
 220 @notify_func:
 221
 222
 223 <!-- ##### FUNCTION g_closure_remove_finalize_notifier ##### -->
 224 <para>
 225
 226 </para>
 227
 228 @closure:
 229 @notify_data:
 230 @notify_func:
 231
 232
 233 <!-- ##### FUNCTION g_closure_remove_invalidate_notifier ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @closure:
 239 @notify_data:
 240 @notify_func:
 241
 242
 243 <!-- ##### FUNCTION g_closure_new_simple ##### -->
 244 <para>
 245
 246 </para>
 247
 248 @sizeof_closure:
 249 @data:
 250 @Returns:
 251
 252
 253 <!-- ##### FUNCTION g_closure_set_marshal ##### -->
 254 <para>
 255
 256 </para>
 257
 258 @closure:
 259 @marshal:
 260
 261
 262 <!-- ##### FUNCTION g_closure_add_marshal_guards ##### -->
 263 <para>
 264
 265 </para>
 266
 267 @closure:
 268 @pre_marshal_data:
 269 @pre_marshal_notify:
 270 @post_marshal_data:
 271 @post_marshal_notify:
 272
 273
 274 <!-- ##### FUNCTION g_closure_set_meta_marshal ##### -->
 275 <para>
 276
 277 </para>
 278
 279 @closure:
 280 @marshal_data:
 281 @meta_marshal:
 282
 283
 284 <!-- ##### FUNCTION g_source_set_closure ##### -->
 285 <para>
 286
 287 </para>
 288
 289 @source:
 290 @closure:
 291
 292
 293 <!-- ##### MACRO G_TYPE_IO_CHANNEL ##### -->
 294 <para>
 295
 296 </para>
 297
 298
 299
 300 <!-- ##### MACRO G_TYPE_IO_CONDITION ##### -->
 301 <para>
 302
 303 </para>
 304
 305
 306
 307 <!-- ##### FUNCTION g_cclosure_marshal_VOID__VOID ##### -->
 308 <para>
 309
 310 </para>
 311
 312 @closure:
 313 @return_value:
 314 @n_param_values:
 315 @param_values:
 316 @invocation_hint:
 317 @marshal_data:
 318
 319
 320 <!-- ##### FUNCTION g_cclosure_marshal_VOID__BOOLEAN ##### -->
 321 <para>
 322
 323 </para>
 324
 325 @closure:
 326 @return_value:
 327 @n_param_values:
 328 @param_values:
 329 @invocation_hint:
 330 @marshal_data:
 331
 332
 333 <!-- ##### FUNCTION g_cclosure_marshal_VOID__CHAR ##### -->
 334 <para>
 335
 336 </para>
 337
 338 @closure:
 339 @return_value:
 340 @n_param_values:
 341 @param_values:
 342 @invocation_hint:
 343 @marshal_data:
 344
 345
 346 <!-- ##### FUNCTION g_cclosure_marshal_VOID__UCHAR ##### -->
 347 <para>
 348
 349 </para>
 350
 351 @closure:
 352 @return_value:
 353 @n_param_values:
 354 @param_values:
 355 @invocation_hint:
 356 @marshal_data:
 357
 358
 359 <!-- ##### FUNCTION g_cclosure_marshal_VOID__INT ##### -->
 360 <para>
 361
 362 </para>
 363
 364 @closure:
 365 @return_value:
 366 @n_param_values:
 367 @param_values:
 368 @invocation_hint:
 369 @marshal_data:
 370
 371
 372 <!-- ##### FUNCTION g_cclosure_marshal_VOID__UINT ##### -->
 373 <para>
 374
 375 </para>
 376
 377 @closure:
 378 @return_value:
 379 @n_param_values:
 380 @param_values:
 381 @invocation_hint:
 382 @marshal_data:
 383
 384
 385 <!-- ##### FUNCTION g_cclosure_marshal_VOID__LONG ##### -->
 386 <para>
 387
 388 </para>
 389
 390 @closure:
 391 @return_value:
 392 @n_param_values:
 393 @param_values:
 394 @invocation_hint:
 395 @marshal_data:
 396
 397
 398 <!-- ##### FUNCTION g_cclosure_marshal_VOID__ULONG ##### -->
 399 <para>
 400
 401 </para>
 402
 403 @closure:
 404 @return_value:
 405 @n_param_values:
 406 @param_values:
 407 @invocation_hint:
 408 @marshal_data:
 409
 410
 411 <!-- ##### FUNCTION g_cclosure_marshal_VOID__ENUM ##### -->
 412 <para>
 413
 414 </para>
 415
 416 @closure:
 417 @return_value:
 418 @n_param_values:
 419 @param_values:
 420 @invocation_hint:
 421 @marshal_data:
 422
 423
 424 <!-- ##### FUNCTION g_cclosure_marshal_VOID__FLAGS ##### -->
 425 <para>
 426
 427 </para>
 428
 429 @closure:
 430 @return_value:
 431 @n_param_values:
 432 @param_values:
 433 @invocation_hint:
 434 @marshal_data:
 435
 436
 437 <!-- ##### FUNCTION g_cclosure_marshal_VOID__FLOAT ##### -->
 438 <para>
 439
 440 </para>
 441
 442 @closure:
 443 @return_value:
 444 @n_param_values:
 445 @param_values:
 446 @invocation_hint:
 447 @marshal_data:
 448
 449
 450 <!-- ##### FUNCTION g_cclosure_marshal_VOID__DOUBLE ##### -->
 451 <para>
 452
 453 </para>
 454
 455 @closure:
 456 @return_value:
 457 @n_param_values:
 458 @param_values:
 459 @invocation_hint:
 460 @marshal_data:
 461
 462
 463 <!-- ##### FUNCTION g_cclosure_marshal_VOID__STRING ##### -->
 464 <para>
 465
 466 </para>
 467
 468 @closure:
 469 @return_value:
 470 @n_param_values:
 471 @param_values:
 472 @invocation_hint:
 473 @marshal_data:
 474
 475
 476 <!-- ##### FUNCTION g_cclosure_marshal_VOID__PARAM ##### -->
 477 <para>
 478
 479 </para>
 480
 481 @closure:
 482 @return_value:
 483 @n_param_values:
 484 @param_values:
 485 @invocation_hint:
 486 @marshal_data:
 487
 488
 489 <!-- ##### FUNCTION g_cclosure_marshal_VOID__BOXED ##### -->
 490 <para>
 491
 492 </para>
 493
 494 @closure:
 495 @return_value:
 496 @n_param_values:
 497 @param_values:
 498 @invocation_hint:
 499 @marshal_data:
 500
 501
 502 <!-- ##### FUNCTION g_cclosure_marshal_VOID__POINTER ##### -->
 503 <para>
 504
 505 </para>
 506
 507 @closure:
 508 @return_value:
 509 @n_param_values:
 510 @param_values:
 511 @invocation_hint:
 512 @marshal_data:
 513
 514
 515 <!-- ##### FUNCTION g_cclosure_marshal_VOID__OBJECT ##### -->
 516 <para>
 517
 518 </para>
 519
 520 @closure:
 521 @return_value:
 522 @n_param_values:
 523 @param_values:
 524 @invocation_hint:
 525 @marshal_data:
 526
 527
 528 <!-- ##### FUNCTION g_cclosure_marshal_STRING__OBJECT_POINTER ##### -->
 529 <para>
 530
 531 </para>
 532
 533 @closure:
 534 @return_value:
 535 @n_param_values:
 536 @param_values:
 537 @invocation_hint:
 538 @marshal_data:
 539
 540
 541 <!-- ##### FUNCTION g_cclosure_marshal_VOID__UINT_POINTER ##### -->
 542 <para>
 543
 544 </para>
 545
 546 @closure:
 547 @return_value:
 548 @n_param_values:
 549 @param_values:
 550 @invocation_hint:
 551 @marshal_data:
 552
 553
 554 <!-- ##### FUNCTION g_cclosure_marshal_BOOLEAN__FLAGS ##### -->
 555 <para>
 556
 557 </para>
 558
 559 @closure:
 560 @return_value:
 561 @n_param_values:
 562 @param_values:
 563 @invocation_hint:
 564 @marshal_data:
 565
 566
 567 <!-- ##### MACRO g_cclosure_marshal_BOOL__FLAGS ##### -->
 568 <para>
 569
 570 </para>
 571
 572
 573