core/ui/backend.facts

   1 IN: gadgets
   2 USING: help strings ;
   3
   4 HELP: set-title
   5 { $values { "string" string } { "world" world } }
   6 { $description "Sets the title bar of the native window containing the world." }
   7 { $notes "This word should not be called directly by user code. Instead, change the " { $link world-title } " model; see " { $link "models" } "." } ;
   8
   9 HELP: open-window*
  10 { $values { "world" world } { "title" string } }
  11 { $description "Opens a native window containing the given world. This grafts the world by calling " { $link graft } ". Each world can only be displayed in one top-level window at a time." }
  12 { $notes "This word should not be called directly by user code. Instead, use " { $link open-window } " or " { $link open-titled-window } "." } ;
  13
  14 HELP: raise-window
  15 { $values { "world" world } }
  16 { $description "Makes the native window containing the given world the front-most window." }
  17 { $notes "To raise the window containing a specific gadget, use " { $link find-world } " to find the world containing the gadget first." } ;
  18
  19 HELP: select-gl-context
  20 { $values { "handle" "a backend-specific handle" } }
  21 { $description "Selects an OpenGL context to be the implicit destination for subsequent GL rendering calls. This word is called automatically by the UI before drawing a " { $link world } "." } ;
  22
  23 HELP: flush-gl-context
  24 { $values { "handle" "a backend-specific handle" } }
  25 { $description "Ensures all GL rendering calls made to an OpenGL context finish rendering to the screen. This word is called automatically by the UI after drawing a " { $link world } "." } ;
  26
  27 HELP: clipboard
  28 { $class-description "A mutable container for a single string implementing the " { $link "clipboard-protocol" } "." } ;
  29
  30 HELP: paste-clipboard
  31 { $values { "gadget" gadget } { "clipboard" "an object" } }
  32 { $contract "Arranges for the contents of the clipboard to be inserted into the gadget at some point in the near future via a call to " { $link user-input } ". The gadget must be a child of a grafted " { $link world } "." } ;
  33
  34 HELP: copy-clipboard
  35 { $values { "string" string } { "gadget" gadget } { "clipboard" "an object" } }
  36 { $contract "Arranges for the string to be copied to the clipboard on behalf of the gadget. The gadget must be a child of a grafted " { $link world } "." } ;
  37
  38 HELP: clipboard
  39 { $var-description "Global variable holding the system clipboard. By convention, text should only be copied to the clipboard via an explicit user action, for example by pressing " { $snippet "C+c" } "." } ;
  40
  41 HELP: selection
  42 { $var-description "Global variable holding the system selection. By convention, text should be copied to the selection as soon as it is selected by the user." } ;