doc/gdk.ref.texi

   1 @menu
   2 * gdk Classes::
   3 * gdk Structs::
   4 * gdk Opaque Boxeds::
   5 * gdk Enums::
   6 * gdk Flags::
   7 @end menu
   8
   9 @node gdk Classes
  10 @section gdk Classes
  11
  12 @menu
  13 * display::
  14 * display-manager::
  15 * drag-context::
  16 * drawable::
  17 * gdk-window::
  18 * graphics-context::
  19 * keymap::
  20 * pango-layout::
  21 * pixbuf::
  22 * pixbuf-animation::
  23 * pixmap::
  24 * screen::
  25 @end menu
  26
  27 Reference of classes in package GDK
  28
  29 @node display
  30 @subsection display
  31 @Class display
  32
  33 Superclasses: @ref{g-object}
  34
  35 Slots:
  36 None
  37
  38 Signals:
  39 @itemize
  40 @item closed. (@code{boolean}) -> @code{null}  [run-last]
  41
  42 @end itemize
  43
  44 @node display-manager
  45 @subsection display-manager
  46 @Class display-manager
  47
  48 Superclasses: @ref{g-object}
  49
  50 Slots:
  51 @itemize
  52 @item default-display. Type: @ref{display} (flags: readable writable)
  53
  54
  55
  56 @end itemize
  57 Signals:
  58 @itemize
  59 @item display-opened. (@ref{display}) -> @code{null}  [run-last]
  60
  61 @end itemize
  62
  63 @node drag-context
  64 @subsection drag-context
  65 @Class drag-context
  66
  67 Superclasses: @ref{g-object}
  68
  69 Slots:
  70 None
  71
  72 Signals:
  73 None
  74
  75
  76 @node drawable
  77 @subsection drawable
  78 @Class drawable
  79
  80 Superclasses: @ref{g-object}
  81
  82 Slots:
  83 None
  84
  85 Signals:
  86 None
  87
  88
  89 @node gdk-window
  90 @subsection gdk-window
  91 @Class gdk-window
  92
  93 Superclasses: @ref{drawable}
  94
  95 Slots:
  96 None
  97
  98 Signals:
  99 None
 100
 101
 102 @node graphics-context
 103 @subsection graphics-context
 104 @Class graphics-context
 105
 106 Superclasses: @ref{g-object}
 107
 108 Slots:
 109 None
 110
 111 Signals:
 112 None
 113
 114
 115 @node keymap
 116 @subsection keymap
 117 @Class keymap
 118
 119 Superclasses: @ref{g-object}
 120
 121 Slots:
 122 None
 123
 124 Signals:
 125 None
 126
 127
 128 @node pango-layout
 129 @subsection pango-layout
 130 @Class pango-layout
 131
 132 Superclasses: @ref{g-object}
 133
 134 Slots:
 135 None
 136
 137 Signals:
 138 None
 139
 140
 141 @node pixbuf
 142 @subsection pixbuf
 143 @Class pixbuf
 144
 145 Superclasses: @ref{g-object}
 146
 147 Slots:
 148 @itemize
 149 @item bits-per-sample. Type: @code{integer} (flags: readable writable constructor-only)
 150
 151
 152
 153 @item colorspace. Type: @ref{colorspace} (flags: readable writable constructor-only)
 154
 155
 156
 157 @item has-alpha. Type: @code{boolean} (flags: readable writable constructor-only)
 158
 159
 160
 161 @item height. Type: @code{integer} (flags: readable writable constructor-only)
 162
 163
 164
 165 @item n-channels. Type: @code{integer} (flags: readable writable constructor-only)
 166
 167
 168
 169 @item pixels. Type: @code{foreign-pointer} (flags: readable writable constructor-only)
 170
 171
 172
 173 @item rowstride. Type: @code{integer} (flags: readable writable constructor-only)
 174
 175
 176
 177 @item width. Type: @code{integer} (flags: readable writable constructor-only)
 178
 179
 180
 181 @end itemize
 182 Signals:
 183 None
 184
 185
 186 @node pixbuf-animation
 187 @subsection pixbuf-animation
 188 @Class pixbuf-animation
 189
 190 Superclasses: @ref{g-object}
 191
 192 Slots:
 193 None
 194
 195 Signals:
 196 None
 197
 198
 199 @node pixmap
 200 @subsection pixmap
 201 @Class pixmap
 202
 203 Superclasses: @ref{drawable}
 204
 205 Slots:
 206 None
 207
 208 Signals:
 209 None
 210
 211
 212 @node screen
 213 @subsection screen
 214 @Class screen
 215
 216 Superclasses: @ref{g-object}
 217
 218 Slots:
 219 @itemize
 220 @item font-options. Type: @code{foreign-pointer} (flags: readable writable)
 221
 222
 223
 224 @item resolution. Type: @code{double-float} (flags: readable writable)
 225
 226
 227
 228 @end itemize
 229 Signals:
 230 @itemize
 231 @item composited-changed. () -> @code{null}  [run-last]
 232
 233 @item monitors-changed. () -> @code{null}  [run-last]
 234
 235 @item size-changed. () -> @code{null}  [run-last]
 236
 237 @end itemize
 238
 239 @node gdk Structs
 240 @section gdk Structs
 241
 242 @menu
 243 * color::
 244 * event::
 245 * event-button::
 246 * event-client::
 247 * event-client-16::
 248 * event-client-32::
 249 * event-client-8::
 250 * event-configure::
 251 * event-crossing::
 252 * event-dnd::
 253 * event-expose::
 254 * event-focus::
 255 * event-grab-broken::
 256 * event-key::
 257 * event-motion::
 258 * event-no-expose::
 259 * event-owner-change::
 260 * event-property::
 261 * event-proximity::
 262 * event-scroll::
 263 * event-selection::
 264 * event-setting::
 265 * event-visibility::
 266 * event-window-state::
 267 * font::
 268 * geometry::
 269 * rectangle::
 270 @end menu
 271
 272 Reference of structs in package GDK
 273
 274 @node color
 275 @subsection color
 276 @Class color
 277
 278 Superclasses: @code{structure-object}
 279
 280 Subclasses: None
 281
 282 Slots:
 283 @itemize
 284 @item blue
 285
 286 @item green
 287
 288 @item pixel
 289
 290 @item red
 291
 292 @end itemize
 293
 294 @node event
 295 @subsection event
 296 @Class event
 297
 298 Superclasses: @code{structure-object}
 299
 300 Subclasses: @ref{event-key}, @ref{event-button}, @ref{event-scroll}, @ref{event-motion}, @ref{event-expose}, @ref{event-visibility}, @ref{event-crossing}, @ref{event-focus}, @ref{event-configure}, @ref{event-property}, @ref{event-selection}, @ref{event-dnd}, @ref{event-proximity}, @ref{event-client}, @ref{event-no-expose}, @ref{event-window-state}, @ref{event-setting}, @ref{event-owner-change}, @ref{event-grab-broken}
 301
 302 Slots:
 303 @itemize
 304 @item send-event
 305
 306 @item type
 307
 308 @item window
 309
 310 @end itemize
 311
 312 @node event-button
 313 @subsection event-button
 314 @Class event-button
 315
 316 Superclasses: @ref{event}
 317
 318 Subclasses: None
 319
 320 Slots:
 321 @itemize
 322 @item axes
 323
 324 @item button
 325
 326 @item device
 327
 328 @item state
 329
 330 @item time
 331
 332 @item type
 333
 334 @item x
 335
 336 @item x-root
 337
 338 @item y
 339
 340 @item y-root
 341
 342 @end itemize
 343
 344 @node event-client
 345 @subsection event-client
 346 @Class event-client
 347
 348 Superclasses: @ref{event}
 349
 350 Subclasses: @ref{event-client-8}, @ref{event-client-16}, @ref{event-client-32}
 351
 352 Slots:
 353 @itemize
 354 @item data-format
 355
 356 @item message-time
 357
 358 @item type
 359
 360 @end itemize
 361
 362 @node event-client-16
 363 @subsection event-client-16
 364 @Class event-client-16
 365
 366 Superclasses: @ref{event-client}
 367
 368 Subclasses: None
 369
 370 Slots:
 371 @itemize
 372 @item data
 373
 374 @item data-format
 375
 376 @end itemize
 377
 378 @node event-client-32
 379 @subsection event-client-32
 380 @Class event-client-32
 381
 382 Superclasses: @ref{event-client}
 383
 384 Subclasses: None
 385
 386 Slots:
 387 @itemize
 388 @item data
 389
 390 @item data-format
 391
 392 @end itemize
 393
 394 @node event-client-8
 395 @subsection event-client-8
 396 @Class event-client-8
 397
 398 Superclasses: @ref{event-client}
 399
 400 Subclasses: None
 401
 402 Slots:
 403 @itemize
 404 @item data
 405
 406 @item data-format
 407
 408 @end itemize
 409
 410 @node event-configure
 411 @subsection event-configure
 412 @Class event-configure
 413
 414 Superclasses: @ref{event}
 415
 416 Subclasses: None
 417
 418 Slots:
 419 @itemize
 420 @item height
 421
 422 @item type
 423
 424 @item width
 425
 426 @item x
 427
 428 @item y
 429
 430 @end itemize
 431
 432 @node event-crossing
 433 @subsection event-crossing
 434 @Class event-crossing
 435
 436 Superclasses: @ref{event}
 437
 438 Subclasses: None
 439
 440 Slots:
 441 @itemize
 442 @item detail
 443
 444 @item focus
 445
 446 @item mode
 447
 448 @item state
 449
 450 @item sub-window
 451
 452 @item time
 453
 454 @item type
 455
 456 @item x
 457
 458 @item x-root
 459
 460 @item y
 461
 462 @item y-root
 463
 464 @end itemize
 465
 466 @node event-dnd
 467 @subsection event-dnd
 468 @Class event-dnd
 469
 470 Superclasses: @ref{event}
 471
 472 Subclasses: None
 473
 474 Slots:
 475 @itemize
 476 @item drag-context
 477
 478 @item time
 479
 480 @item type
 481
 482 @item x-root
 483
 484 @item y-root
 485
 486 @end itemize
 487
 488 @node event-expose
 489 @subsection event-expose
 490 @Class event-expose
 491
 492 Superclasses: @ref{event}
 493
 494 Subclasses: None
 495
 496 Slots:
 497 @itemize
 498 @item area
 499
 500 @item count
 501
 502 @item region
 503
 504 @item type
 505
 506 @end itemize
 507
 508 @node event-focus
 509 @subsection event-focus
 510 @Class event-focus
 511
 512 Superclasses: @ref{event}
 513
 514 Subclasses: None
 515
 516 Slots:
 517 @itemize
 518 @item in
 519
 520 @item type
 521
 522 @end itemize
 523
 524 @node event-grab-broken
 525 @subsection event-grab-broken
 526 @Class event-grab-broken
 527
 528 Superclasses: @ref{event}
 529
 530 Subclasses: None
 531
 532 Slots:
 533 @itemize
 534 @item grab-window
 535
 536 @item implicit
 537
 538 @item keyboard
 539
 540 @item type
 541
 542 @end itemize
 543
 544 @node event-key
 545 @subsection event-key
 546 @Class event-key
 547
 548 Superclasses: @ref{event}
 549
 550 Subclasses: None
 551
 552 Slots:
 553 @itemize
 554 @item group
 555
 556 @item hardware-keycode
 557
 558 @item is-modifier
 559
 560 @item keyval
 561
 562 @item length
 563
 564 @item state
 565
 566 @item string
 567
 568 @item time
 569
 570 @item type
 571
 572 @end itemize
 573
 574 @node event-motion
 575 @subsection event-motion
 576 @Class event-motion
 577
 578 Superclasses: @ref{event}
 579
 580 Subclasses: None
 581
 582 Slots:
 583 @itemize
 584 @item axes
 585
 586 @item device
 587
 588 @item is-hint
 589
 590 @item state
 591
 592 @item time
 593
 594 @item type
 595
 596 @item x
 597
 598 @item x-root
 599
 600 @item y
 601
 602 @item y-root
 603
 604 @end itemize
 605
 606 @node event-no-expose
 607 @subsection event-no-expose
 608 @Class event-no-expose
 609
 610 Superclasses: @ref{event}
 611
 612 Subclasses: None
 613
 614 Slots:
 615 @itemize
 616 @item type
 617
 618 @end itemize
 619
 620 @node event-owner-change
 621 @subsection event-owner-change
 622 @Class event-owner-change
 623
 624 Superclasses: @ref{event}
 625
 626 Subclasses: None
 627
 628 Slots:
 629 @itemize
 630 @item owner
 631
 632 @item reason
 633
 634 @item selection
 635
 636 @item selection-time
 637
 638 @item time
 639
 640 @item type
 641
 642 @end itemize
 643
 644 @node event-property
 645 @subsection event-property
 646 @Class event-property
 647
 648 Superclasses: @ref{event}
 649
 650 Subclasses: None
 651
 652 Slots:
 653 @itemize
 654 @item atom
 655
 656 @item state
 657
 658 @item time
 659
 660 @item type
 661
 662 @end itemize
 663
 664 @node event-proximity
 665 @subsection event-proximity
 666 @Class event-proximity
 667
 668 Superclasses: @ref{event}
 669
 670 Subclasses: None
 671
 672 Slots:
 673 @itemize
 674 @item device
 675
 676 @item time
 677
 678 @item type
 679
 680 @end itemize
 681
 682 @node event-scroll
 683 @subsection event-scroll
 684 @Class event-scroll
 685
 686 Superclasses: @ref{event}
 687
 688 Subclasses: None
 689
 690 Slots:
 691 @itemize
 692 @item device
 693
 694 @item direction
 695
 696 @item state
 697
 698 @item time
 699
 700 @item type
 701
 702 @item x
 703
 704 @item x-root
 705
 706 @item y
 707
 708 @item y-root
 709
 710 @end itemize
 711
 712 @node event-selection
 713 @subsection event-selection
 714 @Class event-selection
 715
 716 Superclasses: @ref{event}
 717
 718 Subclasses: None
 719
 720 Slots:
 721 @itemize
 722 @item property
 723
 724 @item requestor
 725
 726 @item selection
 727
 728 @item target
 729
 730 @item time
 731
 732 @item type
 733
 734 @end itemize
 735
 736 @node event-setting
 737 @subsection event-setting
 738 @Class event-setting
 739
 740 Superclasses: @ref{event}
 741
 742 Subclasses: None
 743
 744 Slots:
 745 @itemize
 746 @item action
 747
 748 @item name
 749
 750 @item type
 751
 752 @end itemize
 753
 754 @node event-visibility
 755 @subsection event-visibility
 756 @Class event-visibility
 757
 758 Superclasses: @ref{event}
 759
 760 Subclasses: None
 761
 762 Slots:
 763 @itemize
 764 @item state
 765
 766 @item type
 767
 768 @end itemize
 769
 770 @node event-window-state
 771 @subsection event-window-state
 772 @Class event-window-state
 773
 774 Superclasses: @ref{event}
 775
 776 Subclasses: None
 777
 778 Slots:
 779 @itemize
 780 @item changed-mask
 781
 782 @item new-window-state
 783
 784 @item type
 785
 786 @end itemize
 787
 788 @node font
 789 @subsection font
 790 @Class font
 791
 792 Superclasses: @code{structure-object}
 793
 794 Subclasses: None
 795
 796 Slots:
 797 @itemize
 798 @item ascent
 799
 800 @item descent
 801
 802 @item type
 803
 804 @end itemize
 805
 806 @node geometry
 807 @subsection geometry
 808 @Class geometry
 809
 810 Superclasses: @code{structure-object}
 811
 812 Subclasses: None
 813
 814 Slots:
 815 @itemize
 816 @item base-height
 817
 818 @item base-width
 819
 820 @item gravity
 821
 822 @item height-increment
 823
 824 @item max-aspect
 825
 826 @item max-height
 827
 828 @item max-width
 829
 830 @item min-aspect
 831
 832 @item min-height
 833
 834 @item min-width
 835
 836 @item width-increment
 837
 838 @end itemize
 839
 840 @node rectangle
 841 @subsection rectangle
 842 @Class rectangle
 843
 844 Superclasses: @code{structure-object}
 845
 846 Subclasses: None
 847
 848 Slots:
 849 @itemize
 850 @item height
 851
 852 @item width
 853
 854 @item x
 855
 856 @item y
 857
 858 @end itemize
 859
 860 @node gdk Opaque Boxeds
 861 @section gdk Opaque Boxeds
 862
 863 @menu
 864 @end menu
 865
 866 Reference of opaque boxeds in package GDK
 867
 868 @node gdk Enums
 869 @section gdk Enums
 870
 871 @menu
 872 * colorspace::
 873 * event-type::
 874 * font-type::
 875 * gdk-extension-mode::
 876 * gdk-window-type-hint::
 877 * grab-status::
 878 * gravity::
 879 * owner-change::
 880 * property-state::
 881 * scroll-direction::
 882 * setting-action::
 883 * visibility-state::
 884 * window-edge::
 885 @end menu
 886
 887 Reference of enums in package GDK
 888
 889 @node colorspace
 890 @subsection colorspace
 891 @Enum colorspace
 892 Values:
 893 @itemize
 894 @item :rgb
 895 @end itemize
 896
 897
 898 @node event-type
 899 @subsection event-type
 900 @Enum event-type
 901 Values:
 902 @itemize
 903 @item :nothing
 904 @item :delete
 905 @item :destroy
 906 @item :expose
 907 @item :motion-notify
 908 @item :button-press
 909 @item :2button-press
 910 @item :3button-press
 911 @item :button-release
 912 @item :key-press
 913 @item :key-release
 914 @item :enter-notify
 915 @item :leave-notify
 916 @item :focus-change
 917 @item :configure
 918 @item :map
 919 @item :unmap
 920 @item :property-notify
 921 @item :selection-clear
 922 @item :selection-request
 923 @item :selection-notify
 924 @item :proximity-in
 925 @item :proximity-out
 926 @item :drag-enter
 927 @item :drag-leave
 928 @item :drag-motion
 929 @item :drag-status
 930 @item :drop-start
 931 @item :drop-finished
 932 @item :client-event
 933 @item :visibility-notify
 934 @item :no-expose
 935 @item :scroll
 936 @item :window-state
 937 @item :setting
 938 @item :owner-change
 939 @item :grab-broken
 940 @item :damage
 941 @end itemize
 942
 943
 944 @node font-type
 945 @subsection font-type
 946 @Enum font-type
 947 Values:
 948 @itemize
 949 @item :font
 950 @item :fontset
 951 @end itemize
 952
 953
 954 @node gdk-extension-mode
 955 @subsection gdk-extension-mode
 956 @Enum gdk-extension-mode
 957 Values:
 958 @itemize
 959 @item :none
 960 @item :all
 961 @item :cursor
 962 @end itemize
 963
 964
 965 @node gdk-window-type-hint
 966 @subsection gdk-window-type-hint
 967 @Enum gdk-window-type-hint
 968 Values:
 969 @itemize
 970 @item :normal
 971 @item :dialog
 972 @item :menu
 973 @item :toolbar
 974 @item :splashscreen
 975 @item :utility
 976 @item :dock
 977 @item :desktop
 978 @item :dropdown-menu
 979 @item :popup-menu
 980 @item :tooltip
 981 @item :notification
 982 @item :combo
 983 @item :dnd
 984 @end itemize
 985
 986
 987 @node grab-status
 988 @subsection grab-status
 989 @Enum grab-status
 990 Values:
 991 @itemize
 992 @item :success
 993 @item :already-grabbed
 994 @item :invalid-time
 995 @item :not-viewable
 996 @item :frozen
 997 @end itemize
 998
 999
1000 @node gravity
1001 @subsection gravity
1002 @Enum gravity
1003 Values:
1004 @itemize
1005 @item :north-west
1006 @item :north
1007 @item :north-east
1008 @item :west
1009 @item :center
1010 @item :east
1011 @item :south-west
1012 @item :south
1013 @item :south-east
1014 @item :static
1015 @end itemize
1016
1017
1018 @node owner-change
1019 @subsection owner-change
1020 @Enum owner-change
1021 Values:
1022 @itemize
1023 @item :new-owner
1024 @item :destroy
1025 @item :close
1026 @end itemize
1027
1028
1029 @node property-state
1030 @subsection property-state
1031 @Enum property-state
1032 Values:
1033 @itemize
1034 @item :new-value
1035 @item :delete
1036 @end itemize
1037
1038
1039 @node scroll-direction
1040 @subsection scroll-direction
1041 @Enum scroll-direction
1042 Values:
1043 @itemize
1044 @item :up
1045 @item :down
1046 @item :left
1047 @item :right
1048 @end itemize
1049
1050
1051 @node setting-action
1052 @subsection setting-action
1053 @Enum setting-action
1054 Values:
1055 @itemize
1056 @item :new
1057 @item :changed
1058 @item :deleted
1059 @end itemize
1060
1061
1062 @node visibility-state
1063 @subsection visibility-state
1064 @Enum visibility-state
1065 Values:
1066 @itemize
1067 @item :unobscured
1068 @item :partial
1069 @item :fully-obscured
1070 @end itemize
1071
1072
1073 @node window-edge
1074 @subsection window-edge
1075 @Enum window-edge
1076 Values:
1077 @itemize
1078 @item :north-west
1079 @item :north
1080 @item :north-east
1081 @item :west
1082 @item :east
1083 @item :south-west
1084 @item :south
1085 @item :south-east
1086 @end itemize
1087
1088
1089 @node gdk Flags
1090 @section gdk Flags
1091
1092 @menu
1093 * event-mask::
1094 * window-hints::
1095 * window-state::
1096 @end menu
1097
1098 Reference of flags in package GDK
1099
1100 @node event-mask
1101 @subsection event-mask
1102 @Flags event-mask
1103 Values:
1104 @itemize
1105 @item :exposure-mask
1106 @item :pointer-motion-mask
1107 @item :pointer-motion-hint-mask
1108 @item :button-motion-mask
1109 @item :button1-motion-mask
1110 @item :button2-motion-mask
1111 @item :button3-motion-mask
1112 @item :button-press-mask
1113 @item :button-release-mask
1114 @item :key-press-mask
1115 @item :key-release-mask
1116 @item :enter-notify-mask
1117 @item :leave-notify-mask
1118 @item :focus-change-mask
1119 @item :structure-mask
1120 @item :property-change-mask
1121 @item :visibility-notify-mask
1122 @item :proximity-in-mask
1123 @item :proximity-out-mask
1124 @item :substructure-mask
1125 @item :scroll-mask
1126 @item :all-events-mask
1127 @end itemize
1128
1129
1130 @node window-hints
1131 @subsection window-hints
1132 @Flags window-hints
1133 Values:
1134 @itemize
1135 @item :pos
1136 @item :min-size
1137 @item :max-size
1138 @item :base-size
1139 @item :aspect
1140 @item :resize-inc
1141 @item :win-gravity
1142 @item :user-pos
1143 @item :user-size
1144 @end itemize
1145
1146
1147 @node window-state
1148 @subsection window-state
1149 @Flags window-state
1150 Values:
1151 @itemize
1152 @item :withdrawn
1153 @item :iconified
1154 @item :maximized
1155 @item :sticky
1156 @item :fullscreen
1157 @item :above
1158 @item :below
1159 @end itemize
1160
1161