docs/reference/gobject/tmpl/param_value_types.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Parameters and Values
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Standard Parameter and Value Types
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 #GValue provides an abstract container structure which can be copied,
  10 transformed and compared while holding a value of any (derived) type, which
  11 is registered as a #GType with a #GTypeValueTable in its #GTypeInfo structure.
  12 Parameter specifications for most value types can be created as
  13 #GParamSpec derived instances, to implement e.g. #GObject properties which
  14 operate on #GValue containers.
  15 </para>
  16
  17 <!-- ##### SECTION See_Also ##### -->
  18 <para>
  19 #GParamSpec, #GValue, g_object_class_install_property().
  20 </para>
  21
  22 <!-- ##### MACRO G_IS_PARAM_SPEC_BOOLEAN ##### -->
  23 <para>
  24 Return whether the given #GParamSpec is of type %G_TYPE_PARAM_BOOLEAN.
  25 </para>
  26
  27 @pspec: a valid #GParamSpec instance
  28
  29
  30 <!-- ##### MACRO G_PARAM_SPEC_BOOLEAN ##### -->
  31 <para>
  32 Cast a #GParamSpec instance into a #GParamSpecBoolean.
  33 </para>
  34
  35 @pspec: a valid #GParamSpec instance
  36
  37
  38 <!-- ##### MACRO G_VALUE_HOLDS_BOOLEAN ##### -->
  39 <para>
  40 Return whether the given #GValue can hold values of type %G_TYPE_BOOLEAN.
  41 </para>
  42
  43 @value: a valid #GValue structure
  44
  45
  46 <!-- ##### MACRO G_TYPE_PARAM_BOOLEAN ##### -->
  47 <para>
  48 The #GType of #GParamSpecBoolean.
  49 </para>
  50
  51
  52
  53 <!-- ##### STRUCT GParamSpecBoolean ##### -->
  54 <para>
  55 A #GParamSpec derived structure that contains the meta data for boolean properties.
  56 </para>
  57
  58 @parent_instance: private #GParamSpec portion
  59 @default_value:   default value for the property specified
  60
  61 <!-- ##### FUNCTION g_param_spec_boolean ##### -->
  62 <para>
  63 Creates a new #GParamSpecBoolean instance specifying a %G_TYPE_BOOLEAN
  64 property.
  65 </para>
  66 <para>
  67 See g_param_spec_internal() for details on property names.
  68 </para>
  69
  70 @name:          canonical name of the property specified
  71 @nick:          nick name for the property specified
  72 @blurb:         description of the property specified
  73 @default_value: default value for the property specified
  74 @flags:         flags for the property specified
  75 @Returns: a newly created parameter specification
  76
  77
  78 <!-- ##### FUNCTION g_value_set_boolean ##### -->
  79 <para>
  80 Set the contents of a %G_TYPE_BOOLEAN #GValue to @v_boolean.
  81 </para>
  82
  83 @value:     a valid #GValue of type %G_TYPE_BOOLEAN
  84 @v_boolean: boolean value to be set
  85
  86
  87 <!-- ##### FUNCTION g_value_get_boolean ##### -->
  88 <para>
  89 Get the contents of a %G_TYPE_BOOLEAN #GValue.
  90 </para>
  91
  92 @value:   a valid #GValue of type %G_TYPE_BOOLEAN
  93 @Returns: boolean contents of @value
  94
  95
  96 <!-- ##### MACRO G_IS_PARAM_SPEC_CHAR ##### -->
  97 <para>
  98 Return whether the given #GParamSpec is of type %G_TYPE_PARAM_CHAR.
  99 </para>
 100
 101 @pspec: a valid #GParamSpec instance
 102
 103
 104 <!-- ##### MACRO G_PARAM_SPEC_CHAR ##### -->
 105 <para>
 106 Cast a #GParamSpec instance into a #GParamSpecChar.
 107 </para>
 108
 109 @pspec: a valid #GParamSpec instance
 110
 111
 112 <!-- ##### MACRO G_VALUE_HOLDS_CHAR ##### -->
 113 <para>
 114 Return whether the given #GValue can hold values of type %G_TYPE_CHAR.
 115 </para>
 116
 117 @value: a valid #GValue structure
 118
 119
 120 <!-- ##### MACRO G_TYPE_PARAM_CHAR ##### -->
 121 <para>
 122 The #GType of #GParamSpecChar.
 123 </para>
 124
 125
 126
 127 <!-- ##### STRUCT GParamSpecChar ##### -->
 128 <para>
 129 A #GParamSpec derived structure that contains the meta data for character properties.
 130 </para>
 131
 132 @parent_instance: private #GParamSpec portion
 133 @minimum:         minimum value for the property specified
 134 @maximum:         maximum value for the property specified
 135 @default_value:   default value for the property specified
 136
 137 <!-- ##### FUNCTION g_param_spec_char ##### -->
 138 <para>
 139 Creates a new #GParamSpecChar instance specifying a %G_TYPE_CHAR property.
 140 </para>
 141
 142 @name:          canonical name of the property specified
 143 @nick:          nick name for the property specified
 144 @blurb:         description of the property specified
 145 @minimum:       minimum value for the property specified
 146 @maximum:       maximum value for the property specified
 147 @default_value: default value for the property specified
 148 @flags:         flags for the property specified
 149 @Returns: a newly created parameter specification
 150
 151
 152 <!-- ##### FUNCTION g_value_set_char ##### -->
 153 <para>
 154 Set the contents of a %G_TYPE_CHAR #GValue to @v_char.
 155 </para>
 156
 157 @value:  a valid #GValue of type %G_TYPE_CHAR
 158 @v_char: character value to be set
 159
 160
 161 <!-- ##### FUNCTION g_value_get_char ##### -->
 162 <para>
 163 Get the contents of a %G_TYPE_CHAR #GValue.
 164 </para>
 165
 166 @value:   a valid #GValue of type %G_TYPE_CHAR
 167 @Returns: character contents of @value
 168
 169
 170 <!-- ##### MACRO G_IS_PARAM_SPEC_UCHAR ##### -->
 171 <para>
 172 Return whether the given #GParamSpec is of type %G_TYPE_PARAM_UCHAR.
 173 </para>
 174
 175 @pspec: a valid #GParamSpec instance
 176
 177
 178 <!-- ##### MACRO G_PARAM_SPEC_UCHAR ##### -->
 179 <para>
 180 Cast a #GParamSpec instance into a #GParamSpecUChar.
 181 </para>
 182
 183 @pspec: a valid #GParamSpec instance
 184
 185
 186 <!-- ##### MACRO G_VALUE_HOLDS_UCHAR ##### -->
 187 <para>
 188 Return whether the given #GValue can hold values of type %G_TYPE_UCHAR.
 189 </para>
 190
 191 @value: a valid #GValue structure
 192
 193
 194 <!-- ##### MACRO G_TYPE_PARAM_UCHAR ##### -->
 195 <para>
 196 The #GType of #GParamSpecUChar.
 197 </para>
 198
 199
 200
 201 <!-- ##### STRUCT GParamSpecUChar ##### -->
 202 <para>
 203 A #GParamSpec derived structure that contains the meta data for unsigned character properties.
 204 </para>
 205
 206 @parent_instance: private #GParamSpec portion
 207 @minimum:         minimum value for the property specified
 208 @maximum:         maximum value for the property specified
 209 @default_value:   default value for the property specified
 210
 211 <!-- ##### FUNCTION g_param_spec_uchar ##### -->
 212 <para>
 213 Creates a new #GParamSpecUChar instance specifying a %G_TYPE_UCHAR property.
 214 </para>
 215
 216 @name:          canonical name of the property specified
 217 @nick:          nick name for the property specified
 218 @blurb:         description of the property specified
 219 @minimum:       minimum value for the property specified
 220 @maximum:       maximum value for the property specified
 221 @default_value: default value for the property specified
 222 @flags:         flags for the property specified
 223 @Returns: a newly created parameter specification
 224
 225
 226 <!-- ##### FUNCTION g_value_set_uchar ##### -->
 227 <para>
 228 Set the contents of a %G_TYPE_UCHAR #GValue to @v_uchar.
 229 </para>
 230
 231 @value:   a valid #GValue of type %G_TYPE_UCHAR
 232 @v_uchar: unsigned character value to be set
 233
 234
 235 <!-- ##### FUNCTION g_value_get_uchar ##### -->
 236 <para>
 237 Get the contents of a %G_TYPE_UCHAR #GValue.
 238 </para>
 239
 240 @value:   a valid #GValue of type %G_TYPE_UCHAR
 241 @Returns: unsigned character contents of @value
 242
 243
 244 <!-- ##### MACRO G_IS_PARAM_SPEC_INT ##### -->
 245 <para>
 246 Return whether the given #GParamSpec is of type %G_TYPE_PARAM_INT.
 247 </para>
 248
 249 @pspec: a valid #GParamSpec instance
 250
 251
 252 <!-- ##### MACRO G_PARAM_SPEC_INT ##### -->
 253 <para>
 254 Cast a #GParamSpec instance into a #GParamSpecInt.
 255 </para>
 256
 257 @pspec: a valid #GParamSpec instance
 258
 259
 260 <!-- ##### MACRO G_VALUE_HOLDS_INT ##### -->
 261 <para>
 262 Return whether the given #GValue can hold values of type %G_TYPE_INT.
 263 </para>
 264
 265 @value: a valid #GValue structure
 266
 267
 268 <!-- ##### MACRO G_TYPE_PARAM_INT ##### -->
 269 <para>
 270 The #GType of #GParamSpecInt.
 271 </para>
 272
 273
 274
 275 <!-- ##### STRUCT GParamSpecInt ##### -->
 276 <para>
 277 A #GParamSpec derived structure that contains the meta data for integer properties.
 278 </para>
 279
 280 @parent_instance: private #GParamSpec portion
 281 @minimum:         minimum value for the property specified
 282 @maximum:         maximum value for the property specified
 283 @default_value:   default value for the property specified
 284
 285 <!-- ##### FUNCTION g_param_spec_int ##### -->
 286 <para>
 287 Creates a new #GParamSpecInt instance specifying a %G_TYPE_INT property.
 288 </para>
 289 <para>
 290 See g_param_spec_internal() for details on property names.
 291 </para>
 292
 293 @name:          canonical name of the property specified
 294 @nick:          nick name for the property specified
 295 @blurb:         description of the property specified
 296 @minimum:       minimum value for the property specified
 297 @maximum:       maximum value for the property specified
 298 @default_value: default value for the property specified
 299 @flags:         flags for the property specified
 300 @Returns: a newly created parameter specification
 301
 302
 303 <!-- ##### FUNCTION g_value_set_int ##### -->
 304 <para>
 305 Set the contents of a %G_TYPE_INT #GValue to @v_int.
 306 </para>
 307
 308 @value: a valid #GValue of type %G_TYPE_INT
 309 @v_int: integer value to be set
 310
 311
 312 <!-- ##### FUNCTION g_value_get_int ##### -->
 313 <para>
 314 Get the contents of a %G_TYPE_INT #GValue.
 315 </para>
 316
 317 @value:   a valid #GValue of type %G_TYPE_INT
 318 @Returns: integer contents of @value
 319
 320
 321 <!-- ##### MACRO G_IS_PARAM_SPEC_UINT ##### -->
 322 <para>
 323 Return whether the given #GParamSpec is of type %G_TYPE_PARAM_UINT.
 324 </para>
 325
 326 @pspec: a valid #GParamSpec instance
 327
 328
 329 <!-- ##### MACRO G_PARAM_SPEC_UINT ##### -->
 330 <para>
 331 Cast a #GParamSpec instance into a #GParamSpecUInt.
 332 </para>
 333
 334 @pspec: a valid #GParamSpec instance
 335
 336
 337 <!-- ##### MACRO G_VALUE_HOLDS_UINT ##### -->
 338 <para>
 339 Return whether the given #GValue can hold values of type %G_TYPE_UINT.
 340 </para>
 341
 342 @value: a valid #GValue structure
 343
 344
 345 <!-- ##### MACRO G_TYPE_PARAM_UINT ##### -->
 346 <para>
 347 The #GType of #GParamSpecUInt.
 348 </para>
 349
 350
 351
 352 <!-- ##### STRUCT GParamSpecUInt ##### -->
 353 <para>
 354 A #GParamSpec derived structure that contains the meta data for unsigned integer properties.
 355 </para>
 356
 357 @parent_instance: private #GParamSpec portion
 358 @minimum:         minimum value for the property specified
 359 @maximum:         maximum value for the property specified
 360 @default_value:   default value for the property specified
 361
 362 <!-- ##### FUNCTION g_param_spec_uint ##### -->
 363 <para>
 364 Creates a new #GParamSpecUInt instance specifying a %G_TYPE_UINT property.
 365 </para>
 366 <para>
 367 See g_param_spec_internal() for details on property names.
 368 </para>
 369
 370 @name:          canonical name of the property specified
 371 @nick:          nick name for the property specified
 372 @blurb:         description of the property specified
 373 @minimum:       minimum value for the property specified
 374 @maximum:       maximum value for the property specified
 375 @default_value: default value for the property specified
 376 @flags:         flags for the property specified
 377 @Returns:  a newly created parameter specification
 378
 379
 380 <!-- ##### FUNCTION g_value_set_uint ##### -->
 381 <para>
 382 Set the contents of a %G_TYPE_UINT #GValue to @v_uint.
 383 </para>
 384
 385 @value:  a valid #GValue of type %G_TYPE_UINT
 386 @v_uint: unsigned integer value to be set
 387
 388
 389 <!-- ##### FUNCTION g_value_get_uint ##### -->
 390 <para>
 391 Get the contents of a %G_TYPE_UINT #GValue.
 392 </para>
 393
 394 @value:   a valid #GValue of type %G_TYPE_UINT
 395 @Returns: unsigned integer contents of @value
 396
 397
 398 <!-- ##### MACRO G_IS_PARAM_SPEC_LONG ##### -->
 399 <para>
 400 Return whether the given #GParamSpec is of type %G_TYPE_PARAM_LONG.
 401 </para>
 402
 403 @pspec: a valid #GParamSpec instance
 404
 405
 406 <!-- ##### MACRO G_PARAM_SPEC_LONG ##### -->
 407 <para>
 408 Cast a #GParamSpec instance into a #GParamSpecLong.
 409 </para>
 410
 411 @pspec: a valid #GParamSpec instance
 412
 413
 414 <!-- ##### MACRO G_VALUE_HOLDS_LONG ##### -->
 415 <para>
 416 Return whether the given #GValue can hold values of type %G_TYPE_LONG.
 417 </para>
 418
 419 @value: a valid #GValue structure
 420
 421
 422 <!-- ##### MACRO G_TYPE_PARAM_LONG ##### -->
 423 <para>
 424 The #GType of #GParamSpecLong.
 425 </para>
 426
 427
 428
 429 <!-- ##### STRUCT GParamSpecLong ##### -->
 430 <para>
 431 A #GParamSpec derived structure that contains the meta data for long integer properties.
 432 </para>
 433
 434 @parent_instance: private #GParamSpec portion
 435 @minimum:         minimum value for the property specified
 436 @maximum:         maximum value for the property specified
 437 @default_value:   default value for the property specified
 438
 439 <!-- ##### FUNCTION g_param_spec_long ##### -->
 440 <para>
 441 Creates a new #GParamSpecLong instance specifying a %G_TYPE_LONG property.
 442 </para>
 443 <para>
 444 See g_param_spec_internal() for details on property names.
 445 </para>
 446
 447 @name:          canonical name of the property specified
 448 @nick:          nick name for the property specified
 449 @blurb:         description of the property specified
 450 @minimum:       minimum value for the property specified
 451 @maximum:       maximum value for the property specified
 452 @default_value: default value for the property specified
 453 @flags:         flags for the property specified
 454 @Returns: a newly created parameter specification
 455
 456
 457 <!-- ##### FUNCTION g_value_set_long ##### -->
 458 <para>
 459 Set the contents of a %G_TYPE_LONG #GValue to @v_long.
 460 </para>
 461
 462 @value:  a valid #GValue of type %G_TYPE_LONG
 463 @v_long: long integer value to be set
 464
 465
 466 <!-- ##### FUNCTION g_value_get_long ##### -->
 467 <para>
 468 Get the contents of a %G_TYPE_LONG #GValue.
 469 </para>
 470
 471 @value:   a valid #GValue of type %G_TYPE_LONG
 472 @Returns: long integer contents of @value
 473
 474
 475 <!-- ##### MACRO G_IS_PARAM_SPEC_ULONG ##### -->
 476 <para>
 477 Return whether the given #GParamSpec is of type %G_TYPE_PARAM_ULONG.
 478 </para>
 479
 480 @pspec: a valid #GParamSpec instance
 481
 482
 483 <!-- ##### MACRO G_PARAM_SPEC_ULONG ##### -->
 484 <para>
 485 Cast a #GParamSpec instance into a #GParamSpecULong.
 486 </para>
 487
 488 @pspec: a valid #GParamSpec instance
 489
 490
 491 <!-- ##### MACRO G_VALUE_HOLDS_ULONG ##### -->
 492 <para>
 493 Return whether the given #GValue can hold values of type %G_TYPE_ULONG.
 494 </para>
 495
 496 @value: a valid #GValue structure
 497
 498
 499 <!-- ##### MACRO G_TYPE_PARAM_ULONG ##### -->
 500 <para>
 501 The #GType of #GParamSpecULong.
 502 </para>
 503
 504
 505
 506 <!-- ##### STRUCT GParamSpecULong ##### -->
 507 <para>
 508 A #GParamSpec derived structure that contains the meta data for unsigned long integer properties.
 509 </para>
 510
 511 @parent_instance: private #GParamSpec portion
 512 @minimum:         minimum value for the property specified
 513 @maximum:         maximum value for the property specified
 514 @default_value:   default value for the property specified
 515
 516 <!-- ##### FUNCTION g_param_spec_ulong ##### -->
 517 <para>
 518 Creates a new #GParamSpecULong instance specifying a %G_TYPE_ULONG property.
 519 </para>
 520 <para>
 521 See g_param_spec_internal() for details on property names.
 522 </para>
 523
 524 @name:          canonical name of the property specified
 525 @nick:          nick name for the property specified
 526 @blurb:         description of the property specified
 527 @minimum:       minimum value for the property specified
 528 @maximum:       maximum value for the property specified
 529 @default_value: default value for the property specified
 530 @flags:         flags for the property specified
 531 @Returns:   a newly created parameter specification
 532
 533
 534 <!-- ##### FUNCTION g_value_set_ulong ##### -->
 535 <para>
 536 Set the contents of a %G_TYPE_ULONG #GValue to @v_ulong.
 537 </para>
 538
 539 @value:   a valid #GValue of type %G_TYPE_ULONG
 540 @v_ulong: unsigned long integer value to be set
 541
 542
 543 <!-- ##### FUNCTION g_value_get_ulong ##### -->
 544 <para>
 545 Get the contents of a %G_TYPE_ULONG #GValue.
 546 </para>
 547
 548 @value:   a valid #GValue of type %G_TYPE_ULONG
 549 @Returns: unsigned long integer contents of @value
 550
 551
 552 <!-- ##### MACRO G_IS_PARAM_SPEC_INT64 ##### -->
 553 <para>
 554 Return whether the given #GParamSpec is of type %G_TYPE_PARAM_INT64.
 555 </para>
 556
 557 @pspec: a valid #GParamSpec instance
 558
 559
 560 <!-- ##### MACRO G_PARAM_SPEC_INT64 ##### -->
 561 <para>
 562 Cast a #GParamSpec instance into a #GParamSpecInt64.
 563 </para>
 564
 565 @pspec: a valid #GParamSpec instance
 566
 567
 568 <!-- ##### MACRO G_VALUE_HOLDS_INT64 ##### -->
 569 <para>
 570 Return whether the given #GValue can hold values of type %G_TYPE_INT64.
 571 </para>
 572
 573 @value: a valid #GValue structure
 574
 575
 576 <!-- ##### MACRO G_TYPE_PARAM_INT64 ##### -->
 577 <para>
 578 The #GType of #GParamSpecInt64.
 579 </para>
 580
 581
 582
 583 <!-- ##### STRUCT GParamSpecInt64 ##### -->
 584 <para>
 585 A #GParamSpec derived structure that contains the meta data for 64bit integer properties.
 586 </para>
 587
 588 @parent_instance: private #GParamSpec portion
 589 @minimum:         minimum value for the property specified
 590 @maximum:         maximum value for the property specified
 591 @default_value:   default value for the property specified
 592
 593 <!-- ##### FUNCTION g_param_spec_int64 ##### -->
 594 <para>
 595 Creates a new #GParamSpecInt64 instance specifying a %G_TYPE_INT64 property.
 596 </para>
 597 <para>
 598 See g_param_spec_internal() for details on property names.
 599 </para>
 600
 601 @name:          canonical name of the property specified
 602 @nick:          nick name for the property specified
 603 @blurb:         description of the property specified
 604 @minimum:       minimum value for the property specified
 605 @maximum:       maximum value for the property specified
 606 @default_value: default value for the property specified
 607 @flags:         flags for the property specified
 608 @Returns: a newly created parameter specification
 609
 610
 611 <!-- ##### FUNCTION g_value_set_int64 ##### -->
 612 <para>
 613 Set the contents of a %G_TYPE_INT64 #GValue to @v_int64.
 614 </para>
 615
 616 @value:  a valid #GValue of type %G_TYPE_INT64
 617 @v_int64: 64bit integer value to be set
 618
 619
 620 <!-- ##### FUNCTION g_value_get_int64 ##### -->
 621 <para>
 622 Get the contents of a %G_TYPE_INT64 #GValue.
 623 </para>
 624
 625 @value:   a valid #GValue of type %G_TYPE_INT64
 626 @Returns: 64bit integer contents of @value
 627
 628
 629 <!-- ##### MACRO G_IS_PARAM_SPEC_UINT64 ##### -->
 630 <para>
 631 Return whether the given #GParamSpec is of type %G_TYPE_PARAM_UINT64.
 632 </para>
 633
 634 @pspec: a valid #GParamSpec instance
 635
 636
 637 <!-- ##### MACRO G_PARAM_SPEC_UINT64 ##### -->
 638 <para>
 639 Cast a #GParamSpec instance into a #GParamSpecUInt64.
 640 </para>
 641
 642 @pspec: a valid #GParamSpec instance
 643
 644
 645 <!-- ##### MACRO G_VALUE_HOLDS_UINT64 ##### -->
 646 <para>
 647 Return whether the given #GValue can hold values of type %G_TYPE_UINT64.
 648 </para>
 649
 650 @value: a valid #GValue structure
 651
 652
 653 <!-- ##### MACRO G_TYPE_PARAM_UINT64 ##### -->
 654 <para>
 655 The #GType of #GParamSpecUInt64.
 656 </para>
 657
 658
 659
 660 <!-- ##### STRUCT GParamSpecUInt64 ##### -->
 661 <para>
 662 A #GParamSpec derived structure that contains the meta data for unsigned 64bit integer properties.
 663 </para>
 664
 665 @parent_instance: private #GParamSpec portion
 666 @minimum:         minimum value for the property specified
 667 @maximum:         maximum value for the property specified
 668 @default_value:   default value for the property specified
 669
 670 <!-- ##### FUNCTION g_param_spec_uint64 ##### -->
 671 <para>
 672 Creates a new #GParamSpecUInt64 instance specifying a %G_TYPE_UINT64
 673 property.
 674 </para>
 675 <para>
 676 See g_param_spec_internal() for details on property names.
 677 </para>
 678
 679 @name:          canonical name of the property specified
 680 @nick:          nick name for the property specified
 681 @blurb:         description of the property specified
 682 @minimum:       minimum value for the property specified
 683 @maximum:       maximum value for the property specified
 684 @default_value: default value for the property specified
 685 @flags:         flags for the property specified
 686 @Returns: a newly created parameter specification
 687
 688
 689 <!-- ##### FUNCTION g_value_set_uint64 ##### -->
 690 <para>
 691 Set the contents of a %G_TYPE_UINT64 #GValue to @v_uint64.
 692 </para>
 693
 694 @value:   a valid #GValue of type %G_TYPE_UINT64
 695 @v_uint64: unsigned 64bit integer value to be set
 696
 697
 698 <!-- ##### FUNCTION g_value_get_uint64 ##### -->
 699 <para>
 700 Get the contents of a %G_TYPE_UINT64 #GValue.
 701 </para>
 702
 703 @value:   a valid #GValue of type %G_TYPE_UINT64
 704 @Returns: unsigned 64bit integer contents of @value
 705
 706
 707 <!-- ##### MACRO G_IS_PARAM_SPEC_FLOAT ##### -->
 708 <para>
 709 Return whether the given #GParamSpec is of type %G_TYPE_PARAM_FLOAT.
 710 </para>
 711
 712 @pspec: a valid #GParamSpec instance
 713
 714
 715 <!-- ##### MACRO G_PARAM_SPEC_FLOAT ##### -->
 716 <para>
 717 Cast a #GParamSpec instance into a #GParamSpecFloat.
 718 </para>
 719
 720 @pspec: a valid #GParamSpec instance
 721
 722
 723 <!-- ##### MACRO G_VALUE_HOLDS_FLOAT ##### -->
 724 <para>
 725 Return whether the given #GValue can hold values of type %G_TYPE_FLOAT.
 726 </para>
 727
 728 @value: a valid #GValue structure
 729
 730
 731 <!-- ##### MACRO G_TYPE_PARAM_FLOAT ##### -->
 732 <para>
 733 The #GType of #GParamSpecFloat.
 734 </para>
 735
 736
 737
 738 <!-- ##### STRUCT GParamSpecFloat ##### -->
 739 <para>
 740 A #GParamSpec derived structure that contains the meta data for float properties.
 741 </para>
 742
 743 @parent_instance: private #GParamSpec portion
 744 @minimum:         minimum value for the property specified
 745 @maximum:         maximum value for the property specified
 746 @default_value:   default value for the property specified
 747 @epsilon:
 748
 749 <!-- ##### FUNCTION g_param_spec_float ##### -->
 750 <para>
 751 Creates a new #GParamSpecFloat instance specifying a %G_TYPE_FLOAT property.
 752 </para>
 753 <para>
 754 See g_param_spec_internal() for details on property names.
 755 </para>
 756
 757 @name:          canonical name of the property specified
 758 @nick:          nick name for the property specified
 759 @blurb:         description of the property specified
 760 @minimum:       minimum value for the property specified
 761 @maximum:       maximum value for the property specified
 762 @default_value: default value for the property specified
 763 @flags:         flags for the property specified
 764 @Returns: a newly created parameter specification
 765
 766
 767 <!-- ##### FUNCTION g_value_set_float ##### -->
 768 <para>
 769 Set the contents of a %G_TYPE_FLOAT #GValue to @v_float.
 770 </para>
 771
 772 @value:     a valid #GValue of type %G_TYPE_FLOAT
 773 @v_float: float value to be set
 774
 775
 776 <!-- ##### FUNCTION g_value_get_float ##### -->
 777 <para>
 778 Get the contents of a %G_TYPE_FLOAT #GValue.
 779 </para>
 780
 781 @value:   a valid #GValue of type %G_TYPE_FLOAT
 782 @Returns: float contents of @value
 783
 784
 785 <!-- ##### MACRO G_IS_PARAM_SPEC_DOUBLE ##### -->
 786 <para>
 787 Return whether the given #GParamSpec is of type %G_TYPE_PARAM_DOUBLE.
 788 </para>
 789
 790 @pspec: a valid #GParamSpec instance
 791
 792
 793 <!-- ##### MACRO G_PARAM_SPEC_DOUBLE ##### -->
 794 <para>
 795 Cast a #GParamSpec instance into a #GParamSpecDouble.
 796 </para>
 797
 798 @pspec: a valid #GParamSpec instance
 799
 800
 801 <!-- ##### MACRO G_VALUE_HOLDS_DOUBLE ##### -->
 802 <para>
 803 Return whether the given #GValue can hold values of type %G_TYPE_DOUBLE.
 804 </para>
 805
 806 @value: a valid #GValue structure
 807
 808
 809 <!-- ##### MACRO G_TYPE_PARAM_DOUBLE ##### -->
 810 <para>
 811 The #GType of #GParamSpecDouble.
 812 </para>
 813
 814
 815
 816 <!-- ##### STRUCT GParamSpecDouble ##### -->
 817 <para>
 818 A #GParamSpec derived structure that contains the meta data for double properties.
 819 </para>
 820
 821 @parent_instance: private #GParamSpec portion
 822 @minimum:         minimum value for the property specified
 823 @maximum:         maximum value for the property specified
 824 @default_value:   default value for the property specified
 825 @epsilon:
 826
 827 <!-- ##### FUNCTION g_param_spec_double ##### -->
 828 <para>
 829 Creates a new #GParamSpecDouble instance specifying a %G_TYPE_DOUBLE
 830 property.
 831 </para>
 832 <para>
 833 See g_param_spec_internal() for details on property names.
 834 </para>
 835
 836 @name:          canonical name of the property specified
 837 @nick:          nick name for the property specified
 838 @blurb:         description of the property specified
 839 @minimum:       minimum value for the property specified
 840 @maximum:       maximum value for the property specified
 841 @default_value: default value for the property specified
 842 @flags:         flags for the property specified
 843 @Returns:  a newly created parameter specification
 844
 845
 846 <!-- ##### FUNCTION g_value_set_double ##### -->
 847 <para>
 848 Set the contents of a %G_TYPE_DOUBLE #GValue to @v_double.
 849 </para>
 850
 851 @value:     a valid #GValue of type %G_TYPE_DOUBLE
 852 @v_double: double value to be set
 853
 854
 855 <!-- ##### FUNCTION g_value_get_double ##### -->
 856 <para>
 857 Get the contents of a %G_TYPE_DOUBLE #GValue.
 858 </para>
 859
 860 @value:   a valid #GValue of type %G_TYPE_DOUBLE
 861 @Returns: double contents of @value
 862
 863
 864 <!-- ##### MACRO G_IS_PARAM_SPEC_ENUM ##### -->
 865 <para>
 866 Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_ENUM.
 867 </para>
 868
 869 @pspec: a valid #GParamSpec instance
 870
 871
 872 <!-- ##### MACRO G_PARAM_SPEC_ENUM ##### -->
 873 <para>
 874 Cast a #GParamSpec instance into a #GParamSpecEnum.
 875 </para>
 876
 877 @pspec: a valid #GParamSpec instance
 878
 879
 880 <!-- ##### MACRO G_VALUE_HOLDS_ENUM ##### -->
 881 <para>
 882 Return whether the given #GValue can hold values derived from type %G_TYPE_ENUM.
 883 </para>
 884
 885 @value: a valid #GValue structure
 886
 887
 888 <!-- ##### MACRO G_TYPE_PARAM_ENUM ##### -->
 889 <para>
 890 The #GType of #GParamSpecEnum.
 891 </para>
 892
 893
 894
 895 <!-- ##### STRUCT GParamSpecEnum ##### -->
 896 <para>
 897 A #GParamSpec derived structure that contains the meta data for enum
 898 properties.
 899 </para>
 900
 901 @parent_instance: private #GParamSpec portion
 902 @enum_class: the #GEnumClass for the enum
 903 @default_value:   default value for the property specified
 904
 905 <!-- ##### FUNCTION g_param_spec_enum ##### -->
 906 <para>
 907 Creates a new #GParamSpecEnum instance specifying a %G_TYPE_ENUM
 908 property.
 909 </para>
 910 <para>
 911 See g_param_spec_internal() for details on property names.
 912 </para>
 913
 914 @name:          canonical name of the property specified
 915 @nick:          nick name for the property specified
 916 @blurb:         description of the property specified
 917 @enum_type:     a #GType derived from %G_TYPE_ENUM
 918 @default_value: default value for the property specified
 919 @flags:         flags for the property specified
 920 @Returns:  a newly created parameter specification
 921
 922
 923 <!-- ##### FUNCTION g_value_set_enum ##### -->
 924 <para>
 925 Set the contents of a %G_TYPE_ENUM #GValue to @v_enum.
 926 </para>
 927
 928 @value:  a valid #GValue whose type is derived from %G_TYPE_ENUM
 929 @v_enum: enum value to be set
 930
 931
 932 <!-- ##### FUNCTION g_value_get_enum ##### -->
 933 <para>
 934 Get the contents of a %G_TYPE_ENUM #GValue.
 935 </para>
 936
 937 @value:   a valid #GValue whose type is derived from %G_TYPE_ENUM
 938 @Returns: enum contents of @value
 939
 940
 941 <!-- ##### MACRO G_IS_PARAM_SPEC_FLAGS ##### -->
 942 <para>
 943 Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_FLAGS.
 944 </para>
 945
 946 @pspec:  a valid #GParamSpec instance
 947
 948
 949 <!-- ##### MACRO G_PARAM_SPEC_FLAGS ##### -->
 950 <para>
 951 Cast a #GParamSpec instance into a #GParamSpecFlags.
 952 </para>
 953
 954 @pspec: a valid #GParamSpec instance
 955
 956
 957 <!-- ##### MACRO G_VALUE_HOLDS_FLAGS ##### -->
 958 <para>
 959 Returns whether the given #GValue can hold values derived from type %G_TYPE_FLAGS.
 960 </para>
 961
 962 @value: a valid #GValue structure
 963
 964
 965 <!-- ##### MACRO G_TYPE_PARAM_FLAGS ##### -->
 966 <para>
 967 The #GType of #GParamSpecFlags.
 968 </para>
 969
 970
 971
 972 <!-- ##### STRUCT GParamSpecFlags ##### -->
 973 <para>
 974 A #GParamSpec derived structure that contains the meta data for flags
 975 properties.
 976 </para>
 977
 978 @parent_instance: private #GParamSpec portion
 979 @flags_class: the #GFlagsClass for the flags
 980 @default_value:   default value for the property specified
 981
 982 <!-- ##### FUNCTION g_param_spec_flags ##### -->
 983 <para>
 984 Creates a new #GParamSpecEnum instance specifying a %G_TYPE_FLAGS
 985 property.
 986 </para>
 987 <para>
 988 See g_param_spec_internal() for details on property names.
 989 </para>
 990
 991 @name:          canonical name of the property specified
 992 @nick:          nick name for the property specified
 993 @blurb:         description of the property specified
 994 @flags_type:     a #GType derived from %G_TYPE_FLAGS
 995 @default_value: default value for the property specified
 996 @flags:         flags for the property specified
 997 @Returns:  a newly created parameter specification
 998
 999
1000 <!-- ##### FUNCTION g_value_set_flags ##### -->
1001 <para>
1002 Set the contents of a %G_TYPE_FLAGS #GValue to @v_flags.
1003 </para>
1004
1005 @value:  a valid #GValue whose type is derived from %G_TYPE_FLAGS
1006 @v_flags: flags value to be set
1007
1008
1009 <!-- ##### FUNCTION g_value_get_flags ##### -->
1010 <para>
1011 Get the contents of a %G_TYPE_FLAGS #GValue.
1012 </para>
1013
1014 @value:   a valid #GValue whose type is derived from %G_TYPE_FLAGS
1015 @Returns: flags contents of @value
1016
1017
1018 <!-- ##### MACRO G_IS_PARAM_SPEC_STRING ##### -->
1019 <para>
1020 Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_STRING.
1021 </para>
1022
1023 @pspec: a valid #GParamSpec instance
1024
1025
1026 <!-- ##### MACRO G_PARAM_SPEC_STRING ##### -->
1027 <para>
1028 Casts a #GParamSpec instance into a #GParamSpecString.
1029 </para>
1030
1031 @pspec: a valid #GParamSpec instance
1032
1033
1034 <!-- ##### MACRO G_VALUE_HOLDS_STRING ##### -->
1035 <para>
1036 Return whether the given #GValue can hold values of type %G_TYPE_STRING.
1037 </para>
1038
1039 @value: a valid #GValue structure
1040
1041
1042 <!-- ##### MACRO G_TYPE_PARAM_STRING ##### -->
1043 <para>
1044 The #GType of #GParamSpecString.
1045 </para>
1046
1047
1048
1049 <!-- ##### STRUCT GParamSpecString ##### -->
1050 <para>
1051 A #GParamSpec derived structure that contains the meta data for string
1052 properties.
1053 </para>
1054
1055 @parent_instance: private #GParamSpec portion
1056 @default_value:   default value for the property specified
1057 @cset_first: a string containing the allowed values for the first byte
1058 @cset_nth: a string containing the allowed values for the subsequent bytes
1059 @substitutor: the replacement byte for bytes which don't match @cset_first or @cset_nth.
1060 @null_fold_if_empty: replace empty string by %NULL
1061 @ensure_non_null:  replace %NULL strings by an empty string
1062
1063 <!-- ##### TYPEDEF gchararray ##### -->
1064 <para>
1065 A C representable type name for #G_TYPE_STRING.
1066 </para>
1067
1068
1069 <!-- ##### FUNCTION g_param_spec_string ##### -->
1070 <para>
1071 Creates a new #GParamSpecString instance.
1072 </para>
1073 <para>
1074 See g_param_spec_internal() for details on property names.
1075 </para>
1076
1077 @name:          canonical name of the property specified
1078 @nick:          nick name for the property specified
1079 @blurb:         description of the property specified
1080 @default_value: default value for the property specified
1081 @flags:         flags for the property specified
1082 @Returns:  a newly created parameter specification
1083
1084
1085 <!-- ##### FUNCTION g_value_set_string ##### -->
1086 <para>
1087 Set the contents of a %G_TYPE_STRING #GValue to @v_string.
1088 </para>
1089
1090 @value:  a valid #GValue of type %G_TYPE_STRING
1091 @v_string: string to be set
1092
1093
1094 <!-- ##### FUNCTION g_value_set_static_string ##### -->
1095 <para>
1096 Set the contents of a %G_TYPE_STRING #GValue to @v_string.
1097 The string is assumed to be static, and is thus not duplicated
1098 when setting the #GValue.
1099 </para>
1100
1101 @value:  a valid #GValue of type %G_TYPE_STRING
1102 @v_string: static string to be set
1103
1104
1105 <!-- ##### FUNCTION g_value_take_string ##### -->
1106 <para>
1107 Sets the contents of a %G_TYPE_STRING #GValue to @v_string.
1108 </para>
1109
1110 @value:   a valid #GValue of type %G_TYPE_STRING
1111 @v_string: duplicated unowned string to be set
1112 @Since: 2.4
1113
1114
1115 <!-- ##### FUNCTION g_value_set_string_take_ownership ##### -->
1116 <para>
1117 This is an internal function introduced mainly for C marshallers.
1118 </para>
1119
1120 @value:   a valid #GValue of type %G_TYPE_STRING
1121 @v_string: duplicated unowned string to be set
1122 @Deprecated: Use g_value_take_string() instead.
1123
1124
1125 <!-- ##### FUNCTION g_value_get_string ##### -->
1126 <para>
1127 Get the contents of a %G_TYPE_STRING #GValue.
1128 </para>
1129
1130 @value:   a valid #GValue of type %G_TYPE_STRING
1131 @Returns: string content of @value
1132
1133
1134 <!-- ##### FUNCTION g_value_dup_string ##### -->
1135 <para>
1136 Get a copy the contents of a %G_TYPE_STRING #GValue.
1137 </para>
1138
1139 @value:   a valid #GValue of type %G_TYPE_STRING
1140 @Returns: a newly allocated copy of the string content of @value
1141
1142
1143 <!-- ##### MACRO G_IS_PARAM_SPEC_PARAM ##### -->
1144 <para>
1145 Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_PARAM.
1146 </para>
1147
1148 @pspec: a valid #GParamSpec instance
1149
1150
1151 <!-- ##### MACRO G_PARAM_SPEC_PARAM ##### -->
1152 <para>
1153 Casts a #GParamSpec instance into a #GParamSpecParam.
1154 </para>
1155
1156 @pspec: a valid #GParamSpec instance
1157
1158
1159 <!-- ##### MACRO G_VALUE_HOLDS_PARAM ##### -->
1160 <para>
1161 Return whether the given #GValue can hold values derived from type %G_TYPE_PARAM.
1162 </para>
1163
1164 @value: a valid #GValue structure
1165
1166
1167 <!-- ##### MACRO G_TYPE_PARAM_PARAM ##### -->
1168 <para>
1169 The #GType of #GParamSpecParam.
1170 </para>
1171
1172
1173
1174 <!-- ##### STRUCT GParamSpecParam ##### -->
1175 <para>
1176 A #GParamSpec derived structure that contains the meta data for %G_TYPE_PARAM
1177 properties.
1178 </para>
1179
1180 @parent_instance: private #GParamSpec portion
1181
1182 <!-- ##### FUNCTION g_param_spec_param ##### -->
1183 <para>
1184 Creates a new #GParamSpecParam instance specifying a %G_TYPE_PARAM
1185 property.
1186 </para>
1187 <para>
1188 See g_param_spec_internal() for details on property names.
1189 </para>
1190
1191 @name:          canonical name of the property specified
1192 @nick:          nick name for the property specified
1193 @blurb:         description of the property specified
1194 @param_type:    a #GType derived from %G_TYPE_PARAM
1195 @flags:         flags for the property specified
1196 @Returns:  a newly created parameter specification
1197 <!-- # Unused Parameters # -->
1198 @default_value: default value for the property specified
1199
1200
1201 <!-- ##### FUNCTION g_value_set_param ##### -->
1202 <para>
1203 Set the contents of a %G_TYPE_PARAM #GValue to @param.
1204 </para>
1205
1206 @value:  a valid #GValue of type %G_TYPE_PARAM
1207 @param: the #GParamSpec to be set
1208
1209
1210 <!-- ##### FUNCTION g_value_take_param ##### -->
1211 <para>
1212 Sets the contents of a %G_TYPE_PARAM #GValue to @param and
1213 takes over the ownership of the callers reference to @param;
1214 the caller doesn't have to unref it any more.
1215 </para>
1216
1217 @value:  a valid #GValue of type %G_TYPE_PARAM
1218 @param: the #GParamSpec to be set
1219 @Since: 2.4
1220
1221
1222 <!-- ##### FUNCTION g_value_set_param_take_ownership ##### -->
1223 <para>
1224 This is an internal function introduced mainly for C marshallers.
1225 </para>
1226
1227 @value:  a valid #GValue of type %G_TYPE_PARAM
1228 @param: the #GParamSpec to be set
1229 @Deprecated: Use g_value_take_param() instead.
1230
1231
1232 <!-- ##### FUNCTION g_value_get_param ##### -->
1233 <para>
1234 Get the contents of a %G_TYPE_PARAM #GValue.
1235 </para>
1236
1237 @value: a valid #GValue whose type is derived from %G_TYPE_PARAM
1238 @Returns: #GParamSpec content of @value
1239
1240
1241 <!-- ##### FUNCTION g_value_dup_param ##### -->
1242 <para>
1243 Get the contents of a %G_TYPE_PARAM #GValue, increasing its reference count.
1244 </para>
1245
1246 @value: a valid #GValue whose type is derived from %G_TYPE_PARAM
1247 @Returns: #GParamSpec content of @value, should be unreferenced when no longer needed.
1248
1249
1250 <!-- ##### MACRO G_IS_PARAM_SPEC_BOXED ##### -->
1251 <para>
1252 Return whether the given #GParamSpec is of type %G_TYPE_PARAM_BOXED.
1253 </para>
1254
1255 @pspec: a valid #GParamSpec instance
1256
1257
1258 <!-- ##### MACRO G_PARAM_SPEC_BOXED ##### -->
1259 <para>
1260 Cast a #GParamSpec instance into a #GParamSpecBoxed.
1261 </para>
1262
1263 @pspec: a valid #GParamSpec instance
1264
1265
1266 <!-- ##### MACRO G_VALUE_HOLDS_BOXED ##### -->
1267 <para>
1268 Return whether the given #GValue can hold values derived from type %G_TYPE_BOXED.
1269 </para>
1270
1271 @value: a valid #GValue structure
1272
1273
1274 <!-- ##### MACRO G_TYPE_PARAM_BOXED ##### -->
1275 <para>
1276 The #GType of #GParamSpecBoxed.
1277 </para>
1278
1279
1280
1281 <!-- ##### STRUCT GParamSpecBoxed ##### -->
1282 <para>
1283 A #GParamSpec derived structure that contains the meta data for boxed properties.
1284 </para>
1285
1286 @parent_instance: private #GParamSpec portion
1287
1288 <!-- ##### FUNCTION g_param_spec_boxed ##### -->
1289 <para>
1290 Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_BOXED
1291 derived property.
1292 </para>
1293 <para>
1294 See g_param_spec_internal() for details on property names.
1295 </para>
1296
1297 @name:          canonical name of the property specified
1298 @nick:          nick name for the property specified
1299 @blurb:         description of the property specified
1300 @boxed_type:    %G_TYPE_BOXED derived type of this property
1301 @flags:         flags for the property specified
1302 @Returns: a newly created parameter specification
1303
1304
1305 <!-- ##### FUNCTION g_value_set_boxed ##### -->
1306 <para>
1307 Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed.
1308 </para>
1309
1310 @value:   a valid #GValue of %G_TYPE_BOXED derived type
1311 @v_boxed: boxed value to be set
1312
1313
1314 <!-- ##### FUNCTION g_value_set_static_boxed ##### -->
1315 <para>
1316 Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed.
1317 The boxed value is assumed to be static, and is thus not duplicated
1318 when setting the #GValue.
1319 </para>
1320
1321 @value:   a valid #GValue of %G_TYPE_BOXED derived type
1322 @v_boxed: static boxed value to be set
1323
1324
1325 <!-- ##### FUNCTION g_value_take_boxed ##### -->
1326 <para>
1327 Sets the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed and
1328 takes over the ownership of the callers reference to @v_boxed;
1329 the caller doesn't have to unref it any more.
1330 </para>
1331
1332 @value: a valid #GValue of %G_TYPE_BOXED derived type
1333 @v_boxed: duplicated unowned boxed value to be set
1334 @Since: 2.4
1335
1336
1337 <!-- ##### FUNCTION g_value_set_boxed_take_ownership ##### -->
1338 <para>
1339 This is an internal function introduced mainly for C marshallers.
1340 </para>
1341
1342 @value:   a valid #GValue of %G_TYPE_BOXED derived type
1343 @v_boxed: duplicated unowned boxed value to be set
1344 @Deprecated: Use g_value_take_boxed() instead.
1345
1346
1347 <!-- ##### FUNCTION g_value_get_boxed ##### -->
1348 <para>
1349 Get the contents of a %G_TYPE_BOXED derived #GValue.
1350 </para>
1351
1352 @value:   a valid #GValue of %G_TYPE_BOXED derived type
1353 @Returns: boxed contents of @value
1354
1355
1356 <!-- ##### FUNCTION g_value_dup_boxed ##### -->
1357 <para>
1358 Get the contents of a %G_TYPE_BOXED derived #GValue.
1359 Upon getting, the boxed value is duplicated and needs to be
1360 later freed with g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value), return_value);
1361 </para>
1362
1363 @value:   a valid #GValue of %G_TYPE_BOXED derived type
1364 @Returns: boxed contents of @value
1365
1366
1367 <!-- ##### MACRO G_IS_PARAM_SPEC_POINTER ##### -->
1368 <para>
1369 Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_POINTER.
1370 </para>
1371
1372 @pspec: a valid #GParamSpec instance
1373
1374
1375 <!-- ##### MACRO G_PARAM_SPEC_POINTER ##### -->
1376 <para>
1377 Casts a #GParamSpec instance into a #GParamSpecPointer.
1378 </para>
1379
1380 @pspec: a valid #GParamSpec instance
1381
1382
1383 <!-- ##### MACRO G_VALUE_HOLDS_POINTER ##### -->
1384 <para>
1385 Return whether the given #GValue can hold values of type %G_TYPE_POINTER.
1386 </para>
1387
1388 @value: a valid #GValue structure
1389
1390
1391 <!-- ##### MACRO G_TYPE_PARAM_POINTER ##### -->
1392 <para>
1393 The #GType of #GParamSpecPointer.
1394 </para>
1395
1396
1397
1398 <!-- ##### STRUCT GParamSpecPointer ##### -->
1399 <para>
1400 A #GParamSpec derived structure that contains the meta data for pointer properties.
1401 </para>
1402
1403 @parent_instance: private #GParamSpec portion
1404
1405 <!-- ##### FUNCTION g_param_spec_pointer ##### -->
1406 <para>
1407 Creates a new #GParamSpecPoiner instance specifying a pointer property.
1408 </para>
1409 <para>
1410 See g_param_spec_internal() for details on property names.
1411 </para>
1412
1413 @name:          canonical name of the property specified
1414 @nick:          nick name for the property specified
1415 @blurb:         description of the property specified
1416 @flags:         flags for the property specified
1417 @Returns: a newly created parameter specification
1418
1419
1420 <!-- ##### FUNCTION g_value_set_pointer ##### -->
1421 <para>
1422 Set the contents of a pointer #GValue to @v_pointer.
1423 </para>
1424
1425 @value:   a valid #GValue of %G_TYPE_POINTER
1426 @v_pointer: pointer value to be set
1427
1428
1429 <!-- ##### FUNCTION g_value_get_pointer ##### -->
1430 <para>
1431 Get the contents of a pointer #GValue.
1432 </para>
1433
1434 @value:   a valid #GValue of %G_TYPE_POINTER
1435 @Returns: pointer contents of @value
1436
1437
1438 <!-- ##### MACRO G_IS_PARAM_SPEC_OBJECT ##### -->
1439 <para>
1440 Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_OBJECT.
1441 </para>
1442
1443 @pspec: a valid #GParamSpec instance
1444
1445
1446 <!-- ##### MACRO G_PARAM_SPEC_OBJECT ##### -->
1447 <para>
1448 Casts a #GParamSpec instance into a #GParamSpecObject.
1449 </para>
1450
1451 @pspec: a valid #GParamSpec instance
1452
1453
1454 <!-- ##### MACRO G_VALUE_HOLDS_OBJECT ##### -->
1455 <para>
1456 Return whether the given #GValue can hold values derived from type %G_TYPE_OBJECT.
1457 </para>
1458
1459 @value: a valid #GValue structure
1460
1461
1462 <!-- ##### MACRO G_TYPE_PARAM_OBJECT ##### -->
1463 <para>
1464 The #GType of #GParamSpecObject.
1465 </para>
1466
1467
1468
1469 <!-- ##### STRUCT GParamSpecObject ##### -->
1470 <para>
1471 A #GParamSpec derived structure that contains the meta data for object properties.
1472 </para>
1473
1474 @parent_instance: private #GParamSpec portion
1475
1476 <!-- ##### FUNCTION g_param_spec_object ##### -->
1477 <para>
1478 Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_OBJECT
1479 derived property.
1480 </para>
1481 <para>
1482 See g_param_spec_internal() for details on property names.
1483 </para>
1484
1485 @name:          canonical name of the property specified
1486 @nick:          nick name for the property specified
1487 @blurb:         description of the property specified
1488 @object_type:   %G_TYPE_OBJECT derived type of this property
1489 @flags:         flags for the property specified
1490 @Returns: a newly created parameter specification
1491
1492
1493 <!-- ##### FUNCTION g_value_set_object ##### -->
1494 <para>
1495 Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object.
1496 </para>
1497
1498 @value:   a valid #GValue of %G_TYPE_OBJECT derived type
1499 @v_object: object value to be set
1500
1501
1502 <!-- ##### FUNCTION g_value_take_object ##### -->
1503 <para>
1504 Sets the contents of a %G_TYPE_OBJECT derived #GValue to @v_object
1505 and takes over the ownership of the callers reference to @v_object;
1506 the caller doesn't have to unref it any more.
1507 </para>
1508
1509 @value:  a valid #GValue of %G_TYPE_OBJECT derived type
1510 @v_object: object value to be set
1511 @Since: 2.4
1512
1513
1514 <!-- ##### FUNCTION g_value_set_object_take_ownership ##### -->
1515 <para>
1516 This is an internal function introduced mainly for C marshallers.
1517 </para>
1518
1519 @value:  a valid #GValue of %G_TYPE_OBJECT derived type
1520 @v_object: object value to be set
1521 @Deprecated: Use g_value_take_object() instead.
1522
1523
1524 <!-- ##### FUNCTION g_value_get_object ##### -->
1525 <para>
1526 Get the contents of a %G_TYPE_OBJECT derived #GValue.
1527 </para>
1528
1529 @value:   a valid #GValue of %G_TYPE_OBJECT derived type
1530 @Returns: object contents of @value
1531
1532
1533 <!-- ##### FUNCTION g_value_dup_object ##### -->
1534 <para>
1535 Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing its reference count.
1536 </para>
1537
1538 @value: a valid #GValue whose type is derived from %G_TYPE_OBJECT
1539 @Returns: object content of @value, should be unreferenced when no longer needed.
1540
1541
1542 <!-- ##### MACRO G_IS_PARAM_SPEC_UNICHAR ##### -->
1543 <para>
1544 Return whether the given #GParamSpec is of type %G_TYPE_PARAM_UNICHAR.
1545 </para>
1546
1547 @pspec: a valid #GParamSpec instance
1548
1549
1550 <!-- ##### MACRO G_PARAM_SPEC_UNICHAR ##### -->
1551 <para>
1552 Cast a #GParamSpec instance into a #GParamSpecUnichar.
1553 </para>
1554
1555 @pspec: a valid #GParamSpec instance
1556
1557
1558 <!-- ##### MACRO G_TYPE_PARAM_UNICHAR ##### -->
1559 <para>
1560 The #GType of #GParamSpecUnichar.
1561 </para>
1562
1563
1564
1565 <!-- ##### STRUCT GParamSpecUnichar ##### -->
1566 <para>
1567 A #GParamSpec derived structure that contains the meta data for unichar (unsigned integer) properties.
1568 </para>
1569
1570 @parent_instance: private #GParamSpec portion
1571 @default_value:   default value for the property specified
1572
1573 <!-- ##### FUNCTION g_param_spec_unichar ##### -->
1574 <para>
1575 Creates a new #GParamSpecUnichar instance specifying a %G_TYPE_UINT
1576 property. #GValue structures for this property can be accessed with
1577 g_value_set_uint() and g_value_get_uint().
1578 </para>
1579 <para>
1580 See g_param_spec_internal() for details on property names.
1581 </para>
1582
1583 @name:          canonical name of the property specified
1584 @nick:          nick name for the property specified
1585 @blurb:         description of the property specified
1586 @default_value: default value for the property specified
1587 @flags:         flags for the property specified
1588 @Returns: a newly created parameter specification
1589
1590
1591 <!-- ##### MACRO G_IS_PARAM_SPEC_VALUE_ARRAY ##### -->
1592 <para>
1593 Return whether the given #GParamSpec is of type %G_TYPE_PARAM_VALUE_ARRAY.
1594 </para>
1595
1596 @pspec: a valid #GParamSpec instance
1597
1598
1599 <!-- ##### MACRO G_PARAM_SPEC_VALUE_ARRAY ##### -->
1600 <para>
1601 Cast a #GParamSpec instance into a #GParamSpecValueArray.
1602 </para>
1603
1604 @pspec: a valid #GParamSpec instance
1605
1606
1607 <!-- ##### MACRO G_TYPE_PARAM_VALUE_ARRAY ##### -->
1608 <para>
1609 The #GType of #GParamSpecValueArray.
1610 </para>
1611
1612
1613
1614 <!-- ##### STRUCT GParamSpecValueArray ##### -->
1615 <para>
1616 A #GParamSpec derived structure that contains the meta data for #GValueArray properties.
1617 </para>
1618
1619 @parent_instance:  private #GParamSpec portion
1620 @element_spec:     a #GParamSpec describing the elements contained in arrays of this property, may be %NULL
1621 @fixed_n_elements: if greater than 0, arrays of this property will always have this many elements
1622
1623 <!-- ##### FUNCTION g_param_spec_value_array ##### -->
1624 <para>
1625 Creates a new #GParamSpecValueArray instance specifying a
1626 %G_TYPE_VALUE_ARRAY property. %G_TYPE_VALUE_ARRAY is a %G_TYPE_BOXED
1627 type, as such, #GValue structures for this property can be accessed
1628 with g_value_set_boxed() and g_value_get_boxed().
1629 </para>
1630 <para>
1631 See g_param_spec_internal() for details on property names.
1632 </para>
1633
1634 @name:          canonical name of the property specified
1635 @nick:          nick name for the property specified
1636 @blurb:         description of the property specified
1637 @element_spec:  a #GParamSpec describing the elements contained in
1638                 arrays of this property, may be %NULL
1639 @flags:         flags for the property specified
1640 @Returns: a newly created parameter specification
1641
1642
1643 <!-- ##### MACRO G_IS_PARAM_SPEC_OVERRIDE ##### -->
1644 <para>
1645 Returns whether the given #GParamSpec is of type %G_TYPE_PARAM_OBJECT.
1646 </para>
1647
1648 @pspec: a #GParamSpec
1649 @Since: 2.4
1650
1651 <!-- ##### MACRO G_PARAM_SPEC_OVERRIDE ##### -->
1652 <para>
1653 Casts a #GParamSpec into a #GParamSpecObject.
1654 </para>
1655
1656 @pspec:  a #GParamSpec
1657 @Since: 2.4
1658
1659
1660 <!-- ##### MACRO G_TYPE_PARAM_OVERRIDE ##### -->
1661 <para>
1662 The #GType of #GParamSpecOverride.
1663 </para>
1664
1665 @Since: 2.4
1666
1667
1668 <!-- ##### STRUCT GParamSpecOverride ##### -->
1669 <para>
1670 This is a type of #GParamSpec type that simply redirects operations to
1671 another paramspec.  All operations other than getting or
1672 setting the value are redirected, including accessing the nick and
1673 blurb, validating a value, and so forth. See
1674 g_param_spec_get_redirect_target() for retrieving the overidden
1675 property. #GParamSpecOverride is used in implementing
1676 g_object_class_override_property(), and will not be directly useful
1677 unless you are implementing a new base type similar to GObject.
1678 </para>
1679
1680 @Since: 2.4
1681
1682 <!-- ##### FUNCTION g_param_spec_override ##### -->
1683 <para>
1684 Creates a new property of type #GParamSpecOverride. This is used
1685 to direct operations to another paramspec, and will not be directly
1686 useful unless you are implementing a new base type similar to GObject.
1687 </para>
1688
1689 @name: the name of the property.
1690 @overridden: The property that is being overridden
1691 @Returns: the newly created #GParamSpec
1692 @Since: 2.4
1693
1694