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 ui.tools.listener.completion ui.tools.common help.tips
   4 tools.vocabs vocabs ;
   5 IN: ui.tools.listener
   6
   7 HELP: interactor
   8 { $class-description "An interactor is an " { $link editor } " intended to be used as the input component of a " { $link "ui-listener" } "."
   9 $nl
  10 "Interactors are created by calling " { $link <interactor> } "."
  11 $nl
  12 "Interactors implement the " { $link stream-readln } ", " { $link stream-read } " and " { $link read-quot } " generic words." } ;
  13
  14 ARTICLE: "ui-listener" "UI listener"
  15 "The graphical listener is based around the terminal listener (" { $link "listener" } ") and adds an input history, and word and vocabulary completion."
  16 { $command-map listener-gadget "toolbar" }
  17 { $command-map interactor "completion" }
  18 { $command-map interactor "interactor" }
  19 { $command-map listener-gadget "scrolling" }
  20 { $command-map listener-gadget "multi-touch" }
  21 { $heading "Word commands" }
  22 "These words operate on the word at the cursor."
  23 { $operations \ word }
  24 { $heading "Vocabulary commands" }
  25 "These words operate on the vocabulary at the cursor."
  26 { $operations T{ vocab-link f "kernel" } }
  27 { $command-map interactor "quotation" }
  28 { $heading "Editing commands" }
  29 "The text editing commands are standard; see " { $link "gadgets-editors-commands" } "."
  30 { $heading "Implementation" }
  31 "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" } "." ;
  32
  33 TIP: "You can read documentation by pressing F1." ;
  34
  35 TIP: "The listener tool remembers previous lines of input. Press " { $command interactor "completion" recall-previous } " and " { $command interactor "completion" recall-next } " to cycle through them." ;
  36
  37 TIP: "When you mouse over certain objects, a block border will appear. Left-clicking on such an object will perform the default operation. Right-clicking will show a menu with all operations." ;
  38
  39 TIP: "The status bar displays stack effects of recognized words as they are being typed in." ;
  40
  41 TIP: "Press " { $command interactor "completion" code-completion-popup } " to complete word, vocabulary and Unicode character names. The latter two features become available if the cursor is after a " { $link POSTPONE: USE: } ", " { $link POSTPONE: USING: } " or " { $link POSTPONE: CHAR: } "." ;
  42
  43 TIP: "If a word's vocabulary is loaded, but not in the search path, you can use restarts to add the vocabulary to the search path. Auto-use mode (" { $command listener-gadget "toolbar" com-auto-use } ") invokes restarts automatically if there is only one restart." ;
  44
  45 TIP: "Scroll the listener from the keyboard by pressing " { $command listener-gadget "scrolling" com-page-up } " and " { $command listener-gadget "scrolling" com-page-down } "." ;
  46
  47 TIP: "Press " { $command tool "common" refresh-all } " or run " { $link refresh-all } " to reload changed source files from disk. " ;
  48
  49 ABOUT: "ui-listener"