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

   1 USING: help.markup help.syntax ui.commands ui.gadgets.slots
   2 ui.gadgets.editors kernel ;
   3 IN: ui.tools.inspector
   4
   5 ARTICLE: "ui-inspector-edit" "Editing slot values in the inspector"
   6 "Slot values can be edited in the inspector. Clicking the ellipsis to the left of the slot's textual representation displays a slot editor gadget. A text representation of the object can be edited in the slot editor. The parser is used to turn the text representation back into an object. Keep in mind that some structure is lost in the conversion; see " { $link "prettyprint-limitations" } "."
   7 $nl
   8 "The slot editor's text editing commands are standard; see " { $link "ui.gadgets.editors" } "."
   9 $nl
  10 "The slot editor has a toolbar containing various commands."
  11 { $command-map slot-editor "toolbar" } ;
  12
  13 ARTICLE: "ui-inspector" "UI inspector"
  14 "The graphical inspector provides functionality similar to the terminal inspector (see " { $link "inspector" } "), adding in-place editing of slot values."
  15 $nl
  16 "To display an object in the UI inspector, right-click a presentation and choose " { $strong "Inspector" } " from the menu that appears. The inspector can also be opened from the listener using a word:"
  17 { $subsection inspector }
  18 "The inspector embeds a table gadget, which supports keyboard navigation; see " { $link "ui.gadgets.tables" } ". It also provides a few other commands:"
  19 { $command-map inspector-gadget "toolbar" }
  20 { $command-map inspector-gadget "multi-touch" }
  21 "The UI inspector is an instance of " { $link inspector-gadget } "."
  22 { $subsection "ui-inspector-edit" } ;
  23
  24 HELP: inspector
  25 { $values { "obj" object } }
  26 { $description "Opens a new inspector window displaying the slots of " { $snippet "obj" } "." } ;
  27
  28 ABOUT: "ui-inspector"