docs/reference/gobject/tmpl/standard_params.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Standard Parameter Types
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### MACRO G_IS_PARAM_SPEC_CHAR ##### -->
  18 <para>
  19
  20 </para>
  21
  22 @pspec:
  23
  24
  25 <!-- ##### MACRO G_PARAM_SPEC_CHAR ##### -->
  26 <para>
  27
  28 </para>
  29
  30 @pspec:
  31
  32
  33 <!-- ##### MACRO G_IS_PARAM_SPEC_UCHAR ##### -->
  34 <para>
  35
  36 </para>
  37
  38 @pspec:
  39
  40
  41 <!-- ##### MACRO G_PARAM_SPEC_UCHAR ##### -->
  42 <para>
  43
  44 </para>
  45
  46 @pspec:
  47
  48
  49 <!-- ##### MACRO G_IS_PARAM_SPEC_BOOLEAN ##### -->
  50 <para>
  51
  52 </para>
  53
  54 @pspec:
  55
  56
  57 <!-- ##### MACRO G_PARAM_SPEC_BOOLEAN ##### -->
  58 <para>
  59
  60 </para>
  61
  62 @pspec:
  63
  64
  65 <!-- ##### MACRO G_IS_PARAM_SPEC_INT ##### -->
  66 <para>
  67
  68 </para>
  69
  70 @pspec:
  71
  72
  73 <!-- ##### MACRO G_PARAM_SPEC_INT ##### -->
  74 <para>
  75
  76 </para>
  77
  78 @pspec:
  79
  80
  81 <!-- ##### MACRO G_IS_PARAM_SPEC_UINT ##### -->
  82 <para>
  83
  84 </para>
  85
  86 @pspec:
  87
  88
  89 <!-- ##### MACRO G_PARAM_SPEC_UINT ##### -->
  90 <para>
  91
  92 </para>
  93
  94 @pspec:
  95
  96
  97 <!-- ##### MACRO G_IS_PARAM_SPEC_LONG ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @pspec:
 103
 104
 105 <!-- ##### MACRO G_PARAM_SPEC_LONG ##### -->
 106 <para>
 107
 108 </para>
 109
 110 @pspec:
 111
 112
 113 <!-- ##### MACRO G_IS_PARAM_SPEC_ULONG ##### -->
 114 <para>
 115
 116 </para>
 117
 118 @pspec:
 119
 120
 121 <!-- ##### MACRO G_PARAM_SPEC_ULONG ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @pspec:
 127
 128
 129 <!-- ##### MACRO G_IS_PARAM_SPEC_ENUM ##### -->
 130 <para>
 131
 132 </para>
 133
 134 @pspec:
 135
 136
 137 <!-- ##### MACRO G_PARAM_SPEC_ENUM ##### -->
 138 <para>
 139
 140 </para>
 141
 142 @pspec:
 143
 144
 145 <!-- ##### MACRO G_IS_PARAM_SPEC_FLAGS ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @pspec:
 151
 152
 153 <!-- ##### MACRO G_PARAM_SPEC_FLAGS ##### -->
 154 <para>
 155
 156 </para>
 157
 158 @pspec:
 159
 160
 161 <!-- ##### MACRO G_IS_PARAM_SPEC_FLOAT ##### -->
 162 <para>
 163
 164 </para>
 165
 166 @pspec:
 167
 168
 169 <!-- ##### MACRO G_PARAM_SPEC_FLOAT ##### -->
 170 <para>
 171
 172 </para>
 173
 174 @pspec:
 175
 176
 177 <!-- ##### MACRO G_IS_PARAM_SPEC_DOUBLE ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @pspec:
 183
 184
 185 <!-- ##### MACRO G_PARAM_SPEC_DOUBLE ##### -->
 186 <para>
 187
 188 </para>
 189
 190 @pspec:
 191
 192
 193 <!-- ##### MACRO G_IS_PARAM_SPEC_STRING ##### -->
 194 <para>
 195
 196 </para>
 197
 198 @pspec:
 199
 200
 201 <!-- ##### MACRO G_PARAM_SPEC_STRING ##### -->
 202 <para>
 203
 204 </para>
 205
 206 @pspec:
 207
 208
 209 <!-- ##### MACRO G_IS_PARAM_SPEC_POINTER ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @pspec:
 215
 216
 217 <!-- ##### MACRO G_PARAM_SPEC_POINTER ##### -->
 218 <para>
 219
 220 </para>
 221
 222 @pspec:
 223
 224
 225 <!-- ##### MACRO G_IS_PARAM_SPEC_BOXED ##### -->
 226 <para>
 227
 228 </para>
 229
 230 @pspec:
 231
 232
 233 <!-- ##### MACRO G_PARAM_SPEC_BOXED ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @pspec:
 239
 240
 241 <!-- ##### MACRO G_IS_PARAM_SPEC_CCALLBACK ##### -->
 242 <para>
 243
 244 </para>
 245
 246 @pspec:
 247
 248
 249 <!-- ##### MACRO G_PARAM_SPEC_CCALLBACK ##### -->
 250 <para>
 251
 252 </para>
 253
 254 @pspec:
 255
 256
 257 <!-- ##### MACRO G_IS_PARAM_SPEC_PARAM ##### -->
 258 <para>
 259
 260 </para>
 261
 262 @pspec:
 263
 264
 265 <!-- ##### MACRO G_PARAM_SPEC_PARAM ##### -->
 266 <para>
 267
 268 </para>
 269
 270 @pspec:
 271
 272
 273 <!-- ##### MACRO G_IS_PARAM_SPEC_OBJECT ##### -->
 274 <para>
 275
 276 </para>
 277
 278 @pspec:
 279
 280
 281 <!-- ##### MACRO G_PARAM_SPEC_OBJECT ##### -->
 282 <para>
 283
 284 </para>
 285
 286 @pspec:
 287
 288
 289 <!-- ##### STRUCT GParamSpecChar ##### -->
 290 <para>
 291
 292 </para>
 293
 294 @parent_instance:
 295 @minimum:
 296 @maximum:
 297 @default_value:
 298
 299 <!-- ##### STRUCT GParamSpecUChar ##### -->
 300 <para>
 301
 302 </para>
 303
 304 @parent_instance:
 305 @minimum:
 306 @maximum:
 307 @default_value:
 308
 309 <!-- ##### STRUCT GParamSpecBoolean ##### -->
 310 <para>
 311
 312 </para>
 313
 314 @parent_instance:
 315 @default_value:
 316
 317 <!-- ##### STRUCT GParamSpecInt ##### -->
 318 <para>
 319
 320 </para>
 321
 322 @parent_instance:
 323 @minimum:
 324 @maximum:
 325 @default_value:
 326
 327 <!-- ##### STRUCT GParamSpecUInt ##### -->
 328 <para>
 329
 330 </para>
 331
 332 @parent_instance:
 333 @minimum:
 334 @maximum:
 335 @default_value:
 336
 337 <!-- ##### STRUCT GParamSpecLong ##### -->
 338 <para>
 339
 340 </para>
 341
 342 @parent_instance:
 343 @minimum:
 344 @maximum:
 345 @default_value:
 346
 347 <!-- ##### STRUCT GParamSpecULong ##### -->
 348 <para>
 349
 350 </para>
 351
 352 @parent_instance:
 353 @minimum:
 354 @maximum:
 355 @default_value:
 356
 357 <!-- ##### STRUCT GParamSpecEnum ##### -->
 358 <para>
 359
 360 </para>
 361
 362 @parent_instance:
 363 @enum_class:
 364 @default_value:
 365
 366 <!-- ##### STRUCT GParamSpecFlags ##### -->
 367 <para>
 368
 369 </para>
 370
 371 @parent_instance:
 372 @flags_class:
 373 @default_value:
 374
 375 <!-- ##### STRUCT GParamSpecFloat ##### -->
 376 <para>
 377
 378 </para>
 379
 380 @parent_instance:
 381 @minimum:
 382 @maximum:
 383 @default_value:
 384 @epsilon:
 385
 386 <!-- ##### STRUCT GParamSpecDouble ##### -->
 387 <para>
 388
 389 </para>
 390
 391 @parent_instance:
 392 @minimum:
 393 @maximum:
 394 @default_value:
 395 @epsilon:
 396
 397 <!-- ##### STRUCT GParamSpecString ##### -->
 398 <para>
 399
 400 </para>
 401
 402 @parent_instance:
 403 @default_value:
 404 @cset_first:
 405 @cset_nth:
 406 @substitutor:
 407 @null_fold_if_empty:
 408 @ensure_non_null:
 409
 410 <!-- ##### STRUCT GParamSpecBoxed ##### -->
 411 <para>
 412
 413 </para>
 414
 415 @parent_instance:
 416
 417 <!-- ##### STRUCT GParamSpecCCallback ##### -->
 418 <para>
 419
 420 </para>
 421
 422 @parent_instance:
 423
 424 <!-- ##### STRUCT GParamSpecParam ##### -->
 425 <para>
 426
 427 </para>
 428
 429 @parent_instance:
 430
 431 <!-- ##### STRUCT GParamSpecPointer ##### -->
 432 <para>
 433
 434 </para>
 435
 436 @parent_instance:
 437
 438 <!-- ##### STRUCT GParamSpecObject ##### -->
 439 <para>
 440
 441 </para>
 442
 443 @parent_instance:
 444
 445 <!-- ##### FUNCTION g_param_spec_char ##### -->
 446 <para>
 447
 448 </para>
 449
 450 @name:
 451 @nick:
 452 @blurb:
 453 @minimum:
 454 @maximum:
 455 @default_value:
 456 @flags:
 457 @Returns:
 458
 459
 460 <!-- ##### FUNCTION g_param_spec_uchar ##### -->
 461 <para>
 462
 463 </para>
 464
 465 @name:
 466 @nick:
 467 @blurb:
 468 @minimum:
 469 @maximum:
 470 @default_value:
 471 @flags:
 472 @Returns:
 473
 474
 475 <!-- ##### FUNCTION g_param_spec_boolean ##### -->
 476 <para>
 477
 478 </para>
 479
 480 @name:
 481 @nick:
 482 @blurb:
 483 @default_value:
 484 @flags:
 485 @Returns:
 486
 487
 488 <!-- ##### FUNCTION g_param_spec_int ##### -->
 489 <para>
 490
 491 </para>
 492
 493 @name:
 494 @nick:
 495 @blurb:
 496 @minimum:
 497 @maximum:
 498 @default_value:
 499 @flags:
 500 @Returns:
 501
 502
 503 <!-- ##### FUNCTION g_param_spec_uint ##### -->
 504 <para>
 505
 506 </para>
 507
 508 @name:
 509 @nick:
 510 @blurb:
 511 @minimum:
 512 @maximum:
 513 @default_value:
 514 @flags:
 515 @Returns:
 516
 517
 518 <!-- ##### FUNCTION g_param_spec_long ##### -->
 519 <para>
 520
 521 </para>
 522
 523 @name:
 524 @nick:
 525 @blurb:
 526 @minimum:
 527 @maximum:
 528 @default_value:
 529 @flags:
 530 @Returns:
 531
 532
 533 <!-- ##### FUNCTION g_param_spec_ulong ##### -->
 534 <para>
 535
 536 </para>
 537
 538 @name:
 539 @nick:
 540 @blurb:
 541 @minimum:
 542 @maximum:
 543 @default_value:
 544 @flags:
 545 @Returns:
 546
 547
 548 <!-- ##### FUNCTION g_param_spec_enum ##### -->
 549 <para>
 550
 551 </para>
 552
 553 @name:
 554 @nick:
 555 @blurb:
 556 @enum_type:
 557 @default_value:
 558 @flags:
 559 @Returns:
 560
 561
 562 <!-- ##### FUNCTION g_param_spec_flags ##### -->
 563 <para>
 564
 565 </para>
 566
 567 @name:
 568 @nick:
 569 @blurb:
 570 @flags_type:
 571 @default_value:
 572 @flags:
 573 @Returns:
 574
 575
 576 <!-- ##### FUNCTION g_param_spec_float ##### -->
 577 <para>
 578
 579 </para>
 580
 581 @name:
 582 @nick:
 583 @blurb:
 584 @minimum:
 585 @maximum:
 586 @default_value:
 587 @flags:
 588 @Returns:
 589
 590
 591 <!-- ##### FUNCTION g_param_spec_double ##### -->
 592 <para>
 593
 594 </para>
 595
 596 @name:
 597 @nick:
 598 @blurb:
 599 @minimum:
 600 @maximum:
 601 @default_value:
 602 @flags:
 603 @Returns:
 604
 605
 606 <!-- ##### FUNCTION g_param_spec_string ##### -->
 607 <para>
 608
 609 </para>
 610
 611 @name:
 612 @nick:
 613 @blurb:
 614 @default_value:
 615 @flags:
 616 @Returns:
 617
 618
 619 <!-- ##### FUNCTION g_param_spec_string_c ##### -->
 620 <para>
 621
 622 </para>
 623
 624 @name:
 625 @nick:
 626 @blurb:
 627 @default_value:
 628 @flags:
 629 @Returns:
 630
 631
 632 <!-- ##### FUNCTION g_param_spec_boxed ##### -->
 633 <para>
 634
 635 </para>
 636
 637 @name:
 638 @nick:
 639 @blurb:
 640 @boxed_type:
 641 @flags:
 642 @Returns:
 643
 644
 645 <!-- ##### FUNCTION g_param_spec_ccallback ##### -->
 646 <para>
 647
 648 </para>
 649
 650 @name:
 651 @nick:
 652 @blurb:
 653 @flags:
 654 @Returns:
 655
 656
 657 <!-- ##### FUNCTION g_param_spec_param ##### -->
 658 <para>
 659
 660 </para>
 661
 662 @name:
 663 @nick:
 664 @blurb:
 665 @param_type:
 666 @flags:
 667 @Returns:
 668
 669
 670 <!-- ##### FUNCTION g_param_spec_pointer ##### -->
 671 <para>
 672
 673 </para>
 674
 675 @name:
 676 @nick:
 677 @blurb:
 678 @flags:
 679 @Returns:
 680
 681
 682 <!-- ##### FUNCTION g_param_spec_object ##### -->
 683 <para>
 684
 685 </para>
 686
 687 @name:
 688 @nick:
 689 @blurb:
 690 @object_type:
 691 @flags:
 692 @Returns:
 693
 694