basis/ui/tools/listener/listener-docs.factor

   1 USING: help.markup help.syntax ui.commands ui.operations
   2 ui.gadgets.editors ui.gadgets.panes listener io words ;
   3 IN: ui.tools.listener
   4
   5 HELP: interactor
   6 { $class-description "An interactor is an " { $link editor } " intended to be used as the input component of a " { $link "ui-listener" } "."
   7 $nl
   8 "Interactors are created by calling " { $link <interactor> } "."
   9 $nl
  10 "Interactors implement the " { $link stream-readln } ", " { $link stream-read } " and " { $link read-quot } " generic words." } ;
  11
  12 ARTICLE: "ui-listener" "UI listener"
  13 "The graphical listener is based around the terminal listener (" { $link "listener" } ") and adds an input history, and word and vocabulary completion."
  14 { $command-map listener-gadget "toolbar" }
  15 { $command-map interactor "completion" }
  16 { $command-map interactor "interactor" }
  17 { $command-map listener-gadget "scrolling" }
  18 { $command-map listener-gadget "multi-touch" }
  19 { $heading "Word commands" }
  20 "These words operate on the word at the cursor."
  21 { $operations \ word }
  22 { $heading "Vocabulary commands" }
  23 "These words operate on the vocabulary at the cursor."
  24 { $operations \ word }
  25 { $command-map interactor "quotation" }
  26 { $heading "Editing commands" }
  27 "The text editing commands are standard; see " { $link "ui.gadgets.editors" } "."
  28 { $heading "Implementation" }
  29 "Listeners are instances of " { $link listener-gadget } ". The listener consists of an output area (instance of " { $link pane } ") and an input area (instance of " { $link interactor } "). Clickable presentations can also be printed to the listener; see " { $link "ui-presentations" } "." ;
  30
  31 ABOUT: "ui-listener"