docs/reference/gobject/tmpl/types.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GType
   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 <!-- ##### TYPEDEF GType ##### -->
  20 <para>
  21
  22 </para>
  23
  24
  25 <!-- ##### MACRO G_TYPE_FUNDAMENTAL ##### -->
  26 <para>
  27
  28 </para>
  29
  30 @type:
  31
  32
  33 <!-- ##### MACRO G_TYPE_FUNDAMENTAL_MAX ##### -->
  34 <para>
  35
  36 </para>
  37
  38
  39
  40 <!-- ##### MACRO G_TYPE_DERIVE_ID ##### -->
  41 <para>
  42
  43 </para>
  44
  45 @ptype:
  46 @branch_seqno:
  47
  48
  49 <!-- ##### MACRO G_TYPE_BRANCH_SEQNO ##### -->
  50 <para>
  51
  52 </para>
  53
  54 @type:
  55
  56
  57 <!-- ##### MACRO G_TYPE_FUNDAMENTAL_LAST ##### -->
  58 <para>
  59
  60 </para>
  61
  62
  63
  64 <!-- ##### ENUM GTypeFundamentals ##### -->
  65 <para>
  66
  67 </para>
  68
  69 @G_TYPE_INVALID:
  70 @G_TYPE_NONE:
  71 @G_TYPE_INTERFACE:
  72 @G_TYPE_CHAR:
  73 @G_TYPE_UCHAR:
  74 @G_TYPE_BOOLEAN:
  75 @G_TYPE_INT:
  76 @G_TYPE_UINT:
  77 @G_TYPE_LONG:
  78 @G_TYPE_ULONG:
  79 @G_TYPE_ENUM:
  80 @G_TYPE_FLAGS:
  81 @G_TYPE_FLOAT:
  82 @G_TYPE_DOUBLE:
  83 @G_TYPE_STRING:
  84 @G_TYPE_PARAM:
  85 @G_TYPE_OBJECT:
  86 @G_TYPE_GTK_BOXED:
  87 @G_TYPE_GTK_POINTER:
  88 @G_TYPE_GTK_SIGNAL:
  89 @G_TYPE_BSE_PROCEDURE:
  90 @G_TYPE_BSE_TIME:
  91 @G_TYPE_BSE_NOTE:
  92 @G_TYPE_BSE_DOTS:
  93 @G_TYPE_GLE_GOBJECT:
  94 @G_TYPE_LAST_RESERVED_FUNDAMENTAL:
  95 @G_TYPE_PARAM_CHAR:
  96 @G_TYPE_PARAM_UCHAR:
  97 @G_TYPE_PARAM_BOOLEAN:
  98 @G_TYPE_PARAM_INT:
  99 @G_TYPE_PARAM_UINT:
 100 @G_TYPE_PARAM_LONG:
 101 @G_TYPE_PARAM_ULONG:
 102 @G_TYPE_PARAM_ENUM:
 103 @G_TYPE_PARAM_FLAGS:
 104 @G_TYPE_PARAM_FLOAT:
 105 @G_TYPE_PARAM_DOUBLE:
 106 @G_TYPE_PARAM_STRING:
 107 @G_TYPE_PARAM_OBJECT:
 108
 109 <!-- ##### MACRO G_TYPE_IS_CLASSED ##### -->
 110 <para>
 111
 112 </para>
 113
 114 @type:
 115
 116
 117 <!-- ##### MACRO G_TYPE_IS_INSTANTIATABLE ##### -->
 118 <para>
 119
 120 </para>
 121
 122 @type:
 123
 124
 125 <!-- ##### MACRO G_TYPE_IS_DERIVABLE ##### -->
 126 <para>
 127
 128 </para>
 129
 130 @type:
 131
 132
 133 <!-- ##### MACRO G_TYPE_IS_DEEP_DERIVABLE ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @type:
 139
 140
 141 <!-- ##### MACRO G_TYPE_IS_INTERFACE ##### -->
 142 <para>
 143
 144 </para>
 145
 146 @type:
 147
 148
 149 <!-- ##### STRUCT GTypePlugin ##### -->
 150 <para>
 151
 152 </para>
 153
 154 @vtable:
 155
 156 <!-- ##### STRUCT GTypePluginVTable ##### -->
 157 <para>
 158
 159 </para>
 160
 161 @plugin_ref:
 162 @plugin_unref:
 163 @complete_type_info:
 164 @complete_interface_info:
 165
 166 <!-- ##### STRUCT GTypeInterface ##### -->
 167 <para>
 168
 169 </para>
 170
 171
 172 <!-- ##### STRUCT GTypeInstance ##### -->
 173 <para>
 174
 175 </para>
 176
 177
 178 <!-- ##### STRUCT GTypeInfo ##### -->
 179 <para>
 180
 181 </para>
 182
 183 @class_size:
 184 @base_init:
 185 @base_finalize:
 186 @class_init:
 187 @class_finalize:
 188 @class_data:
 189 @instance_size:
 190 @n_preallocs:
 191 @instance_init:
 192 @value_table:
 193
 194 <!-- ##### STRUCT GTypeFundamentalInfo ##### -->
 195 <para>
 196
 197 </para>
 198
 199 @type_flags:
 200
 201 <!-- ##### STRUCT GInterfaceInfo ##### -->
 202 <para>
 203
 204 </para>
 205
 206 @interface_init:
 207 @interface_finalize:
 208 @interface_data:
 209
 210 <!-- ##### STRUCT GTypeValueTable ##### -->
 211 <para>
 212
 213 </para>
 214
 215 @value_init:
 216 @value_free:
 217 @value_copy:
 218 @collect_type:
 219 @collect_value:
 220 @lcopy_type:
 221 @lcopy_value:
 222
 223 <!-- ##### MACRO G_TYPE_CHECK_INSTANCE_CAST ##### -->
 224 <para>
 225
 226 </para>
 227
 228 @instance:
 229 @g_type:
 230 @c_type:
 231
 232
 233 <!-- ##### MACRO G_TYPE_CHECK_CLASS_CAST ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @g_class:
 239 @g_type:
 240 @c_type:
 241
 242
 243 <!-- ##### MACRO G_TYPE_CHECK_INSTANCE_TYPE ##### -->
 244 <para>
 245
 246 </para>
 247
 248 @instance:
 249 @g_type:
 250
 251
 252 <!-- ##### MACRO G_TYPE_CHECK_CLASS_TYPE ##### -->
 253 <para>
 254
 255 </para>
 256
 257 @g_class:
 258 @g_type:
 259
 260
 261 <!-- ##### MACRO G_TYPE_INSTANCE_GET_CLASS ##### -->
 262 <para>
 263
 264 </para>
 265
 266 @instance:
 267 @g_type:
 268 @c_type:
 269
 270
 271 <!-- ##### MACRO G_TYPE_FROM_INSTANCE ##### -->
 272 <para>
 273
 274 </para>
 275
 276 @instance:
 277
 278
 279 <!-- ##### MACRO G_TYPE_FROM_CLASS ##### -->
 280 <para>
 281
 282 </para>
 283
 284 @g_class:
 285
 286
 287 <!-- ##### MACRO G_TYPE_FROM_INTERFACE ##### -->
 288 <para>
 289
 290 </para>
 291
 292 @g_iface:
 293
 294
 295 <!-- ##### FUNCTION g_type_init ##### -->
 296 <para>
 297
 298 </para>
 299
 300
 301
 302 <!-- ##### FUNCTION g_type_name ##### -->
 303 <para>
 304
 305 </para>
 306
 307 @type:
 308 @Returns:
 309
 310
 311 <!-- ##### FUNCTION g_type_qname ##### -->
 312 <para>
 313
 314 </para>
 315
 316 @type:
 317 @Returns:
 318
 319
 320 <!-- ##### FUNCTION g_type_from_name ##### -->
 321 <para>
 322
 323 </para>
 324
 325 @name:
 326 @Returns:
 327
 328
 329 <!-- ##### FUNCTION g_type_parent ##### -->
 330 <para>
 331
 332 </para>
 333
 334 @type:
 335 @Returns:
 336
 337
 338 <!-- ##### FUNCTION g_type_next_base ##### -->
 339 <para>
 340
 341 </para>
 342
 343 @type:
 344 @base_type:
 345 @Returns:
 346
 347
 348 <!-- ##### FUNCTION g_type_is_a ##### -->
 349 <para>
 350
 351 </para>
 352
 353 @type:
 354 @is_a_type:
 355 @Returns:
 356
 357
 358 <!-- ##### FUNCTION g_type_conforms_to ##### -->
 359 <para>
 360
 361 </para>
 362
 363 @type:
 364 @iface_type:
 365 @Returns:
 366
 367
 368 <!-- ##### FUNCTION g_type_fundamental_branch_last ##### -->
 369 <para>
 370
 371 </para>
 372
 373 @type:
 374 @Returns:
 375
 376
 377 <!-- ##### FUNCTION g_type_class_ref ##### -->
 378 <para>
 379
 380 </para>
 381
 382 @type:
 383 @Returns:
 384
 385
 386 <!-- ##### FUNCTION g_type_class_peek ##### -->
 387 <para>
 388
 389 </para>
 390
 391 @type:
 392 @Returns:
 393
 394
 395 <!-- ##### FUNCTION g_type_class_unref ##### -->
 396 <para>
 397
 398 </para>
 399
 400 @g_class:
 401
 402
 403 <!-- ##### FUNCTION g_type_class_peek_parent ##### -->
 404 <para>
 405
 406 </para>
 407
 408 @g_class:
 409 @Returns:
 410
 411
 412 <!-- ##### FUNCTION g_type_interface_peek ##### -->
 413 <para>
 414
 415 </para>
 416
 417 @instance_class:
 418 @iface_type:
 419 @Returns:
 420
 421
 422 <!-- ##### FUNCTION g_type_children ##### -->
 423 <para>
 424
 425 </para>
 426
 427 @type:
 428 @n_children:
 429 @Returns:
 430
 431
 432 <!-- ##### FUNCTION g_type_interfaces ##### -->
 433 <para>
 434
 435 </para>
 436
 437 @type:
 438 @n_interfaces:
 439 @Returns:
 440
 441
 442 <!-- ##### FUNCTION g_type_set_qdata ##### -->
 443 <para>
 444
 445 </para>
 446
 447 @type:
 448 @quark:
 449 @data:
 450
 451
 452 <!-- ##### FUNCTION g_type_get_qdata ##### -->
 453 <para>
 454
 455 </para>
 456
 457 @type:
 458 @quark:
 459 @Returns:
 460
 461
 462 <!-- ##### USER_FUNCTION GBaseInitFunc ##### -->
 463 <para>
 464
 465 </para>
 466
 467 @g_class:
 468
 469
 470 <!-- ##### USER_FUNCTION GBaseFinalizeFunc ##### -->
 471 <para>
 472
 473 </para>
 474
 475 @g_class:
 476
 477
 478 <!-- ##### USER_FUNCTION GClassInitFunc ##### -->
 479 <para>
 480
 481 </para>
 482
 483 @g_class:
 484 @class_data:
 485
 486
 487 <!-- ##### USER_FUNCTION GClassFinalizeFunc ##### -->
 488 <para>
 489
 490 </para>
 491
 492 @g_class:
 493 @class_data:
 494
 495
 496 <!-- ##### USER_FUNCTION GInstanceInitFunc ##### -->
 497 <para>
 498
 499 </para>
 500
 501 @instance:
 502 @g_class:
 503
 504
 505 <!-- ##### USER_FUNCTION GInterfaceInitFunc ##### -->
 506 <para>
 507
 508 </para>
 509
 510 @g_iface:
 511 @iface_data:
 512
 513
 514 <!-- ##### USER_FUNCTION GInterfaceFinalizeFunc ##### -->
 515 <para>
 516
 517 </para>
 518
 519 @g_iface:
 520 @iface_data:
 521
 522
 523 <!-- ##### USER_FUNCTION GTypePluginRef ##### -->
 524 <para>
 525
 526 </para>
 527
 528 @plugin:
 529
 530
 531 <!-- ##### USER_FUNCTION GTypePluginUnRef ##### -->
 532 <para>
 533
 534 </para>
 535
 536 @plugin:
 537
 538
 539 <!-- ##### USER_FUNCTION GTypePluginFillTypeInfo ##### -->
 540 <para>
 541
 542 </para>
 543
 544 @plugin:
 545 @g_type:
 546 @info:
 547 @value_table:
 548
 549
 550 <!-- ##### USER_FUNCTION GTypePluginFillInterfaceInfo ##### -->
 551 <para>
 552
 553 </para>
 554
 555 @plugin:
 556 @interface_type:
 557 @instance_type:
 558 @info:
 559
 560
 561 <!-- ##### USER_FUNCTION GTypeClassCacheFunc ##### -->
 562 <para>
 563
 564 </para>
 565
 566 @cache_data:
 567 @g_class:
 568 @Returns:
 569
 570
 571 <!-- ##### ENUM GTypeFlags ##### -->
 572 <para>
 573
 574 </para>
 575
 576 @G_TYPE_FLAG_CLASSED:
 577 @G_TYPE_FLAG_INSTANTIATABLE:
 578 @G_TYPE_FLAG_DERIVABLE:
 579 @G_TYPE_FLAG_DEEP_DERIVABLE:
 580
 581 <!-- ##### FUNCTION g_type_register_static ##### -->
 582 <para>
 583
 584 </para>
 585
 586 @parent_type:
 587 @type_name:
 588 @info:
 589 @Returns:
 590
 591
 592 <!-- ##### FUNCTION g_type_register_dynamic ##### -->
 593 <para>
 594
 595 </para>
 596
 597 @parent_type:
 598 @type_name:
 599 @plugin:
 600 @Returns:
 601
 602
 603 <!-- ##### FUNCTION g_type_register_fundamental ##### -->
 604 <para>
 605
 606 </para>
 607
 608 @type_id:
 609 @type_name:
 610 @info:
 611 @finfo:
 612 @Returns:
 613
 614
 615 <!-- ##### FUNCTION g_type_add_interface_static ##### -->
 616 <para>
 617
 618 </para>
 619
 620 @instance_type:
 621 @interface_type:
 622 @info:
 623
 624
 625 <!-- ##### FUNCTION g_type_add_interface_dynamic ##### -->
 626 <para>
 627
 628 </para>
 629
 630 @instance_type:
 631 @interface_type:
 632 @plugin:
 633
 634
 635 <!-- ##### FUNCTION g_type_class_is_a ##### -->
 636 <para>
 637
 638 </para>
 639
 640 @g_class:
 641 @is_a_type:
 642 @Returns:
 643
 644
 645 <!-- ##### FUNCTION g_type_check_class_cast ##### -->
 646 <para>
 647
 648 </para>
 649
 650 @g_class:
 651 @is_a_type:
 652 @Returns:
 653
 654
 655 <!-- ##### FUNCTION g_type_check_instance_cast ##### -->
 656 <para>
 657
 658 </para>
 659
 660 @instance:
 661 @iface_type:
 662 @Returns:
 663
 664
 665 <!-- ##### FUNCTION g_type_instance_conforms_to ##### -->
 666 <para>
 667
 668 </para>
 669
 670 @instance:
 671 @iface_type:
 672 @Returns:
 673
 674
 675 <!-- ##### FUNCTION g_type_check_flags ##### -->
 676 <para>
 677
 678 </para>
 679
 680 @type:
 681 @flags:
 682 @Returns:
 683
 684
 685 <!-- ##### FUNCTION g_type_create_instance ##### -->
 686 <para>
 687
 688 </para>
 689
 690 @type:
 691 @Returns:
 692
 693
 694 <!-- ##### FUNCTION g_type_free_instance ##### -->
 695 <para>
 696
 697 </para>
 698
 699 @instance:
 700
 701
 702 <!-- ##### FUNCTION g_type_value_table_peek ##### -->
 703 <para>
 704
 705 </para>
 706
 707 @type:
 708 @Returns:
 709
 710
 711 <!-- ##### FUNCTION g_type_add_class_cache_func ##### -->
 712 <para>
 713
 714 </para>
 715
 716 @cache_data:
 717 @cache_func:
 718
 719
 720 <!-- ##### FUNCTION g_type_remove_class_cache_func ##### -->
 721 <para>
 722
 723 </para>
 724
 725 @cache_data:
 726 @cache_func:
 727
 728
 729 <!-- ##### FUNCTION g_type_class_unref_uncached ##### -->
 730 <para>
 731
 732 </para>
 733
 734 @g_class:
 735
 736
 737 <!-- ##### FUNCTION g_type_get_plugin ##### -->
 738 <para>
 739
 740 </para>
 741
 742 @type:
 743 @Returns:
 744
 745
 746 <!-- ##### FUNCTION g_type_fundamental_last ##### -->
 747 <para>
 748
 749 </para>
 750
 751 @Returns:
 752
 753