basis/ui/backend/gtk/gtk-docs.factor

   1 USING: alien byte-arrays gdk.ffi gtk.ffi help.markup help.syntax
   2 kernel strings ui.backend.x11.keys ;
   3 IN: ui.backend.gtk
   4
   5 HELP: configure-im
   6 { $values { "win" GtkWindow } { "im" GtkIMContext } }
   7 { $description "Configures the input methods of the window. Must only be run after the window has been realized." }
   8 { $see-also gtk_widget_realize } ;
   9
  10 HELP: icon-data
  11 { $var-description "Contains a " { $link byte-array } " or " { $link f } " which is the data for the icon to be used for gtk windows. The variable is updated to contain a vocab-specific icon when deploying. See " { $link "vocabs.icons" } " and 'tools.deploy.shaker.strip-gtk-icon'." } ;
  12
  13 HELP: key-sym
  14 { $values
  15   { "keyval" GdkEventKey }
  16   { "string/f" { $maybe string } }
  17   { "action?" boolean }
  18 } { $description "Gets the key symbol and action indicator from a " { $link GdkEventKey } " struct. If 'action?' is " { $link t } ", then the key is one of the special keys in " { $link codes } "." } ;
  19
  20 HELP: on-configure
  21 { $values
  22   { "window" alien }
  23   { "event" alien }
  24   { "user-data" alien }
  25   { "?" boolean }
  26 }
  27 { $description "Handles a configure event (" { $link GdkEventConfigure } ") sent from the windowing system. If the world has been sent the on-map event from gtk then it is updated, otherwise nothing happens. Resizing the window causes the world to be relayouted, but moving the window does not." } ;
  28
  29 ARTICLE: "ui.backend.gtk" "Gtk-based UI backend"
  30 "GDK Event handlers:"
  31 { $list
  32   { "Focus events:"
  33     { $subsections
  34       on-focus-in
  35       on-focus-out
  36       on-leave
  37     }
  38   }
  39   { "IM events:"
  40     { $subsections
  41       im-on-destroy
  42       im-on-focus-in
  43       im-on-focus-out
  44       im-on-key-event
  45       on-commit
  46       on-delete-surrounding
  47       on-retrieve-surrounding
  48     }
  49   }
  50   { "Keyboard events:"
  51     { $subsections
  52       on-key-press/release
  53     }
  54   }
  55   { "Mouse events:"
  56     { $subsections
  57       on-button-press
  58       on-button-release
  59       on-motion
  60       on-scroll
  61     }
  62   }
  63   { "Window sizing and visibility events:"
  64     { $subsections
  65       on-configure
  66       on-delete
  67       on-expose
  68       on-map
  69     }
  70   }
  71 } ;
  72
  73 ABOUT: "ui.backend.gtk"