Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkstyle.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Styles
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Functions for drawing widget parts
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### SECTION Stability_Level ##### -->
  18
  19
  20 <!-- ##### MACRO GTK_STYLE_ATTACHED ##### -->
  21 <para>
  22 Returns whether the style is attached to a window.
  23 </para>
  24
  25 @style: a #GtkStyle.
  26
  27
  28 <!-- ##### STRUCT GtkStyle ##### -->
  29 <para>
  30
  31 </para>
  32
  33 @fg:
  34 @bg:
  35 @light:
  36 @dark:
  37 @mid:
  38 @text:
  39 @base:
  40 @text_aa:
  41 @black:
  42 @white:
  43 @font_desc:
  44 @xthickness:
  45 @ythickness:
  46 @fg_gc:
  47 @bg_gc:
  48 @light_gc:
  49 @dark_gc:
  50 @mid_gc:
  51 @text_gc:
  52 @base_gc:
  53 @text_aa_gc:
  54 @black_gc:
  55 @white_gc:
  56 @bg_pixmap:
  57
  58 <!-- ##### SIGNAL GtkStyle::realize ##### -->
  59 <para>
  60
  61 </para>
  62
  63 @style: the object which received the signal.
  64
  65 <!-- ##### SIGNAL GtkStyle::unrealize ##### -->
  66 <para>
  67
  68 </para>
  69
  70 @style: the object which received the signal.
  71
  72 <!-- ##### FUNCTION gtk_style_new ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @Returns:
  78
  79
  80 <!-- ##### FUNCTION gtk_style_copy ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @style:
  86 @Returns:
  87
  88
  89 <!-- ##### FUNCTION gtk_style_attach ##### -->
  90 <para>
  91
  92 </para>
  93
  94 @style:
  95 @window:
  96 @Returns:
  97
  98
  99 <!-- ##### FUNCTION gtk_style_detach ##### -->
 100 <para>
 101
 102 </para>
 103
 104 @style:
 105
 106
 107 <!-- ##### FUNCTION gtk_style_ref ##### -->
 108 <para>
 109
 110 </para>
 111
 112 @style:
 113 @Returns:
 114
 115
 116 <!-- ##### FUNCTION gtk_style_unref ##### -->
 117 <para>
 118
 119 </para>
 120
 121 @style:
 122
 123
 124 <!-- ##### FUNCTION gtk_style_set_background ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @style:
 130 @window:
 131 @state_type:
 132
 133
 134 <!-- ##### FUNCTION gtk_style_apply_default_background ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @style:
 140 @window:
 141 @set_bg:
 142 @state_type:
 143 @area:
 144 @x:
 145 @y:
 146 @width:
 147 @height:
 148
 149
 150 <!-- ##### MACRO gtk_style_apply_default_pixmap ##### -->
 151 <para>
 152 Does the same as gtk_style_apply_default_background().
 153 </para>
 154
 155 @s:
 156 @gw:
 157 @st:
 158 @a:
 159 @x:
 160 @y:
 161 @w:
 162 @h:
 163 @Deprecated: Use gtk_style_apply_default_background() instead.
 164
 165
 166 <!-- ##### FUNCTION gtk_style_lookup_color ##### -->
 167 <para>
 168
 169 </para>
 170
 171 @style:
 172 @color_name:
 173 @color:
 174 @Returns:
 175
 176
 177 <!-- ##### FUNCTION gtk_style_lookup_icon_set ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @style:
 183 @stock_id:
 184 @Returns:
 185
 186
 187 <!-- ##### FUNCTION gtk_style_render_icon ##### -->
 188 <para>
 189
 190 </para>
 191
 192 @style:
 193 @source:
 194 @direction:
 195 @state:
 196 @size:
 197 @widget:
 198 @detail:
 199 @Returns:
 200
 201
 202 <!-- ##### FUNCTION gtk_style_get_font ##### -->
 203 <para>
 204
 205 </para>
 206
 207 @style:
 208 @Returns:
 209
 210
 211 <!-- ##### FUNCTION gtk_style_set_font ##### -->
 212 <para>
 213
 214 </para>
 215
 216 @style:
 217 @font:
 218
 219
 220 <!-- ##### FUNCTION gtk_style_get_style_property ##### -->
 221 <para>
 222
 223 </para>
 224
 225 @style:
 226 @widget_type:
 227 @property_name:
 228 @value:
 229
 230
 231 <!-- ##### FUNCTION gtk_style_get_valist ##### -->
 232 <para>
 233
 234 </para>
 235
 236 @style:
 237 @widget_type:
 238 @first_property_name:
 239 @var_args:
 240
 241
 242 <!-- ##### FUNCTION gtk_style_get ##### -->
 243 <para>
 244
 245 </para>
 246
 247 @style:
 248 @widget_type:
 249 @first_property_name:
 250 @Varargs:
 251
 252
 253 <!-- ##### FUNCTION gtk_draw_hline ##### -->
 254 <para>
 255
 256 </para>
 257
 258 @style:
 259 @window:
 260 @state_type:
 261 @x1:
 262 @x2:
 263 @y:
 264
 265
 266 <!-- ##### FUNCTION gtk_draw_vline ##### -->
 267 <para>
 268
 269 </para>
 270
 271 @style:
 272 @window:
 273 @state_type:
 274 @y1_:
 275 @y2_:
 276 @x:
 277
 278
 279 <!-- ##### FUNCTION gtk_draw_shadow ##### -->
 280 <para>
 281
 282 </para>
 283
 284 @style:
 285 @window:
 286 @state_type:
 287 @shadow_type:
 288 @x:
 289 @y:
 290 @width:
 291 @height:
 292
 293
 294 <!-- ##### FUNCTION gtk_draw_polygon ##### -->
 295 <para>
 296
 297 </para>
 298
 299 @style:
 300 @window:
 301 @state_type:
 302 @shadow_type:
 303 @points:
 304 @npoints:
 305 @fill:
 306
 307
 308 <!-- ##### FUNCTION gtk_draw_arrow ##### -->
 309 <para>
 310
 311 </para>
 312
 313 @style:
 314 @window:
 315 @state_type:
 316 @shadow_type:
 317 @arrow_type:
 318 @fill:
 319 @x:
 320 @y:
 321 @width:
 322 @height:
 323
 324
 325 <!-- ##### FUNCTION gtk_draw_diamond ##### -->
 326 <para>
 327
 328 </para>
 329
 330 @style:
 331 @window:
 332 @state_type:
 333 @shadow_type:
 334 @x:
 335 @y:
 336 @width:
 337 @height:
 338
 339
 340 <!-- ##### FUNCTION gtk_draw_string ##### -->
 341 <para>
 342
 343 </para>
 344
 345 @style:
 346 @window:
 347 @state_type:
 348 @x:
 349 @y:
 350 @string:
 351
 352
 353 <!-- ##### FUNCTION gtk_draw_box ##### -->
 354 <para>
 355
 356 </para>
 357
 358 @style:
 359 @window:
 360 @state_type:
 361 @shadow_type:
 362 @x:
 363 @y:
 364 @width:
 365 @height:
 366
 367
 368 <!-- ##### FUNCTION gtk_draw_box_gap ##### -->
 369 <para>
 370
 371 </para>
 372
 373 @style:
 374 @window:
 375 @state_type:
 376 @shadow_type:
 377 @x:
 378 @y:
 379 @width:
 380 @height:
 381 @gap_side:
 382 @gap_x:
 383 @gap_width:
 384
 385
 386 <!-- ##### FUNCTION gtk_draw_check ##### -->
 387 <para>
 388
 389 </para>
 390
 391 @style:
 392 @window:
 393 @state_type:
 394 @shadow_type:
 395 @x:
 396 @y:
 397 @width:
 398 @height:
 399
 400
 401 <!-- ##### FUNCTION gtk_draw_extension ##### -->
 402 <para>
 403
 404 </para>
 405
 406 @style:
 407 @window:
 408 @state_type:
 409 @shadow_type:
 410 @x:
 411 @y:
 412 @width:
 413 @height:
 414 @gap_side:
 415
 416
 417 <!-- ##### FUNCTION gtk_draw_flat_box ##### -->
 418 <para>
 419
 420 </para>
 421
 422 @style:
 423 @window:
 424 @state_type:
 425 @shadow_type:
 426 @x:
 427 @y:
 428 @width:
 429 @height:
 430
 431
 432 <!-- ##### FUNCTION gtk_draw_focus ##### -->
 433 <para>
 434
 435 </para>
 436
 437 @style:
 438 @window:
 439 @x:
 440 @y:
 441 @width:
 442 @height:
 443
 444
 445 <!-- ##### FUNCTION gtk_draw_handle ##### -->
 446 <para>
 447
 448 </para>
 449
 450 @style:
 451 @window:
 452 @state_type:
 453 @shadow_type:
 454 @x:
 455 @y:
 456 @width:
 457 @height:
 458 @orientation:
 459
 460
 461 <!-- ##### FUNCTION gtk_draw_option ##### -->
 462 <para>
 463
 464 </para>
 465
 466 @style:
 467 @window:
 468 @state_type:
 469 @shadow_type:
 470 @x:
 471 @y:
 472 @width:
 473 @height:
 474
 475
 476 <!-- ##### FUNCTION gtk_draw_shadow_gap ##### -->
 477 <para>
 478
 479 </para>
 480
 481 @style:
 482 @window:
 483 @state_type:
 484 @shadow_type:
 485 @x:
 486 @y:
 487 @width:
 488 @height:
 489 @gap_side:
 490 @gap_x:
 491 @gap_width:
 492
 493
 494 <!-- ##### FUNCTION gtk_draw_slider ##### -->
 495 <para>
 496
 497 </para>
 498
 499 @style:
 500 @window:
 501 @state_type:
 502 @shadow_type:
 503 @x:
 504 @y:
 505 @width:
 506 @height:
 507 @orientation:
 508
 509
 510 <!-- ##### FUNCTION gtk_draw_tab ##### -->
 511 <para>
 512
 513 </para>
 514
 515 @style:
 516 @window:
 517 @state_type:
 518 @shadow_type:
 519 @x:
 520 @y:
 521 @width:
 522 @height:
 523
 524
 525 <!-- ##### FUNCTION gtk_draw_expander ##### -->
 526 <para>
 527
 528 </para>
 529
 530 @style:
 531 @window:
 532 @state_type:
 533 @x:
 534 @y:
 535 @expander_style:
 536
 537
 538 <!-- ##### FUNCTION gtk_draw_layout ##### -->
 539 <para>
 540
 541 </para>
 542
 543 @style:
 544 @window:
 545 @state_type:
 546 @use_text:
 547 @x:
 548 @y:
 549 @layout:
 550
 551
 552 <!-- ##### FUNCTION gtk_draw_resize_grip ##### -->
 553 <para>
 554
 555 </para>
 556
 557 @style:
 558 @window:
 559 @state_type:
 560 @edge:
 561 @x:
 562 @y:
 563 @width:
 564 @height:
 565
 566
 567 <!-- ##### FUNCTION gtk_paint_arrow ##### -->
 568 <para>
 569
 570 </para>
 571
 572 @style:
 573 @window:
 574 @state_type:
 575 @shadow_type:
 576 @area:
 577 @widget:
 578 @detail:
 579 @arrow_type:
 580 @fill:
 581 @x:
 582 @y:
 583 @width:
 584 @height:
 585
 586
 587 <!-- ##### FUNCTION gtk_paint_box ##### -->
 588 <para>
 589
 590 </para>
 591
 592 @style:
 593 @window:
 594 @state_type:
 595 @shadow_type:
 596 @area:
 597 @widget:
 598 @detail:
 599 @x:
 600 @y:
 601 @width:
 602 @height:
 603
 604
 605 <!-- ##### FUNCTION gtk_paint_box_gap ##### -->
 606 <para>
 607
 608 </para>
 609
 610 @style:
 611 @window:
 612 @state_type:
 613 @shadow_type:
 614 @area:
 615 @widget:
 616 @detail:
 617 @x:
 618 @y:
 619 @width:
 620 @height:
 621 @gap_side:
 622 @gap_x:
 623 @gap_width:
 624
 625
 626 <!-- ##### FUNCTION gtk_paint_check ##### -->
 627 <para>
 628
 629 </para>
 630
 631 @style:
 632 @window:
 633 @state_type:
 634 @shadow_type:
 635 @area:
 636 @widget:
 637 @detail:
 638 @x:
 639 @y:
 640 @width:
 641 @height:
 642
 643
 644 <!-- ##### FUNCTION gtk_paint_diamond ##### -->
 645 <para>
 646
 647 </para>
 648
 649 @style:
 650 @window:
 651 @state_type:
 652 @shadow_type:
 653 @area:
 654 @widget:
 655 @detail:
 656 @x:
 657 @y:
 658 @width:
 659 @height:
 660
 661
 662 <!-- ##### FUNCTION gtk_paint_extension ##### -->
 663 <para>
 664
 665 </para>
 666
 667 @style:
 668 @window:
 669 @state_type:
 670 @shadow_type:
 671 @area:
 672 @widget:
 673 @detail:
 674 @x:
 675 @y:
 676 @width:
 677 @height:
 678 @gap_side:
 679
 680
 681 <!-- ##### FUNCTION gtk_paint_flat_box ##### -->
 682 <para>
 683
 684 </para>
 685
 686 @style:
 687 @window:
 688 @state_type:
 689 @shadow_type:
 690 @area:
 691 @widget:
 692 @detail:
 693 @x:
 694 @y:
 695 @width:
 696 @height:
 697
 698
 699 <!-- ##### FUNCTION gtk_paint_focus ##### -->
 700 <para>
 701
 702 </para>
 703
 704 @style:
 705 @window:
 706 @state_type:
 707 @area:
 708 @widget:
 709 @detail:
 710 @x:
 711 @y:
 712 @width:
 713 @height:
 714
 715
 716 <!-- ##### FUNCTION gtk_paint_handle ##### -->
 717 <para>
 718
 719 </para>
 720
 721 @style:
 722 @window:
 723 @state_type:
 724 @shadow_type:
 725 @area:
 726 @widget:
 727 @detail:
 728 @x:
 729 @y:
 730 @width:
 731 @height:
 732 @orientation:
 733
 734
 735 <!-- ##### FUNCTION gtk_paint_hline ##### -->
 736 <para>
 737
 738 </para>
 739
 740 @style:
 741 @window:
 742 @state_type:
 743 @area:
 744 @widget:
 745 @detail:
 746 @x1:
 747 @x2:
 748 @y:
 749
 750
 751 <!-- ##### FUNCTION gtk_paint_option ##### -->
 752 <para>
 753
 754 </para>
 755
 756 @style:
 757 @window:
 758 @state_type:
 759 @shadow_type:
 760 @area:
 761 @widget:
 762 @detail:
 763 @x:
 764 @y:
 765 @width:
 766 @height:
 767
 768
 769 <!-- ##### FUNCTION gtk_paint_polygon ##### -->
 770 <para>
 771
 772 </para>
 773
 774 @style:
 775 @window:
 776 @state_type:
 777 @shadow_type:
 778 @area:
 779 @widget:
 780 @detail:
 781 @points:
 782 @n_points:
 783 @fill:
 784
 785
 786 <!-- ##### FUNCTION gtk_paint_shadow ##### -->
 787 <para>
 788
 789 </para>
 790
 791 @style:
 792 @window:
 793 @state_type:
 794 @shadow_type:
 795 @area:
 796 @widget:
 797 @detail:
 798 @x:
 799 @y:
 800 @width:
 801 @height:
 802
 803
 804 <!-- ##### FUNCTION gtk_paint_shadow_gap ##### -->
 805 <para>
 806
 807 </para>
 808
 809 @style:
 810 @window:
 811 @state_type:
 812 @shadow_type:
 813 @area:
 814 @widget:
 815 @detail:
 816 @x:
 817 @y:
 818 @width:
 819 @height:
 820 @gap_side:
 821 @gap_x:
 822 @gap_width:
 823
 824
 825 <!-- ##### FUNCTION gtk_paint_slider ##### -->
 826 <para>
 827
 828 </para>
 829
 830 @style:
 831 @window:
 832 @state_type:
 833 @shadow_type:
 834 @area:
 835 @widget:
 836 @detail:
 837 @x:
 838 @y:
 839 @width:
 840 @height:
 841 @orientation:
 842
 843
 844 <!-- ##### FUNCTION gtk_paint_spinner ##### -->
 845 <para>
 846
 847 </para>
 848
 849 @style:
 850 @window:
 851 @state_type:
 852 @area:
 853 @widget:
 854 @detail:
 855 @step:
 856 @x:
 857 @y:
 858 @width:
 859 @height:
 860
 861
 862 <!-- ##### FUNCTION gtk_paint_string ##### -->
 863 <para>
 864
 865 </para>
 866
 867 @style:
 868 @window:
 869 @state_type:
 870 @area:
 871 @widget:
 872 @detail:
 873 @x:
 874 @y:
 875 @string:
 876
 877
 878 <!-- ##### FUNCTION gtk_paint_tab ##### -->
 879 <para>
 880
 881 </para>
 882
 883 @style:
 884 @window:
 885 @state_type:
 886 @shadow_type:
 887 @area:
 888 @widget:
 889 @detail:
 890 @x:
 891 @y:
 892 @width:
 893 @height:
 894
 895
 896 <!-- ##### FUNCTION gtk_paint_vline ##### -->
 897 <para>
 898
 899 </para>
 900
 901 @style:
 902 @window:
 903 @state_type:
 904 @area:
 905 @widget:
 906 @detail:
 907 @y1_:
 908 @y2_:
 909 @x:
 910
 911
 912 <!-- ##### FUNCTION gtk_paint_expander ##### -->
 913 <para>
 914
 915 </para>
 916
 917 @style:
 918 @window:
 919 @state_type:
 920 @area:
 921 @widget:
 922 @detail:
 923 @x:
 924 @y:
 925 @expander_style:
 926
 927
 928 <!-- ##### FUNCTION gtk_paint_layout ##### -->
 929 <para>
 930
 931 </para>
 932
 933 @style:
 934 @window:
 935 @state_type:
 936 @use_text:
 937 @area:
 938 @widget:
 939 @detail:
 940 @x:
 941 @y:
 942 @layout:
 943
 944
 945 <!-- ##### FUNCTION gtk_paint_resize_grip ##### -->
 946 <para>
 947
 948 </para>
 949
 950 @style:
 951 @window:
 952 @state_type:
 953 @area:
 954 @widget:
 955 @detail:
 956 @edge:
 957 @x:
 958 @y:
 959 @width:
 960 @height:
 961
 962
 963 <!-- ##### FUNCTION gtk_draw_insertion_cursor ##### -->
 964 <para>
 965
 966 </para>
 967
 968 @widget:
 969 @drawable:
 970 @area:
 971 @location:
 972 @is_primary:
 973 @direction:
 974 @draw_arrow:
 975
 976
 977 <!-- ##### STRUCT GtkBorder ##### -->
 978 <para>
 979 A struct that specifies a border around a rectangular area that can
 980 be of different width on each side.
 981 </para>
 982
 983 @left: The width of the left border.
 984 @right: The width of the right border.
 985 @top: The width of the top border.
 986 @bottom: The width of the bottom border.
 987
 988 <!-- ##### FUNCTION gtk_border_new ##### -->
 989 <para>
 990
 991 </para>
 992
 993 @Returns:
 994
 995
 996 <!-- ##### FUNCTION gtk_border_copy ##### -->
 997 <para>
 998
 999 </para>
1000
1001 @border_:
1002 @Returns:
1003
1004
1005 <!-- ##### FUNCTION gtk_border_free ##### -->
1006 <para>
1007
1008 </para>
1009
1010 @border_:
1011
1012
1013 <!-- ##### STRUCT GtkRcProperty ##### -->
1014 <para>
1015
1016 </para>
1017
1018 @type_name:
1019 @property_name:
1020 @origin:
1021 @value:
1022
1023 <!-- ##### USER_FUNCTION GtkRcPropertyParser ##### -->
1024 <para>
1025
1026 </para>
1027
1028 @pspec:
1029 @rc_string:
1030 @property_value:
1031 @Returns:
1032
1033