basis/ui/gadgets/editors/editors-docs.factor

   1 USING: documents help.markup help.syntax ui.gadgets
   2 ui.gadgets.scrollers models strings ui.commands sequences
   3 ui.text colors fonts help.tips ;
   4 IN: ui.gadgets.editors
   5
   6 HELP: editor
   7 { $class-description "An editor is a control for editing a multi-line passage of text stored in a " { $link document } " model. Editors are crated by calling " { $link <editor> } "."
   8 $nl
   9 "Editors have the following slots:"
  10 { $list
  11     { { $snippet "font" } " - a " { $link font } "." }
  12     { { $snippet "color" } " - a " { $link color } "." }
  13     { { $snippet "caret-color" } " - a " { $link color } "." }
  14     { { $snippet "selection-color" } " - a " { $link color } "." }
  15     { { $snippet "caret" } " - a " { $link model } " storing a line/column pair." }
  16     { { $snippet "mark" } " - a " { $link model } " storing a line/column pair. If there is no selection, the mark is equal to the caret, otherwise the mark is located at the opposite end of the selection from the caret." }
  17     { { $snippet "focused?" } " - a boolean." }
  18 } } ;
  19
  20 HELP: <editor>
  21 { $values { "editor" "a new " { $link editor } } }
  22 { $description "Creates a new " { $link editor } " with an empty document." } ;
  23
  24 { editor-caret editor-mark } related-words
  25
  26 HELP: editor-caret
  27 { $values { "editor" editor } { "loc" "a pair of integers" } }
  28 { $description "Outputs the current caret location as a line/column number pair." } ;
  29
  30 HELP: editor-mark
  31 { $values { "editor" editor } { "loc" "a pair of integers" } }
  32 { $description "Outputs the current mark location as a line/column number pair." } ;
  33
  34 HELP: change-caret
  35 { $values { "editor" editor } { "quot" { $quotation ( loc document -- newloc ) } } }
  36 { $description "Applies a quotation to the current caret location and moves the caret to the location output by the quotation." } ;
  37
  38 { change-caret change-caret&mark mark>caret } related-words
  39
  40 HELP: mark>caret
  41 { $values { "editor" editor } }
  42 { $description "Moves the mark to the caret location, effectively deselecting any selected text." } ;
  43
  44 HELP: change-caret&mark
  45 { $values { "editor" editor } { "quot" { $quotation ( loc document -- newloc ) } } }
  46 { $description "Applies a quotation to the current caret location and moves the caret and the mark to the location output by the quotation." } ;
  47
  48 HELP: point>loc
  49 { $values { "point" "a pair of integers" } { "editor" editor } { "loc" "a pair of integers" } }
  50 { $description "Converts a point to a line/column number pair." } ;
  51
  52 HELP: scroll>caret
  53 { $values { "editor" editor } }
  54 { $description "Ensures that the caret becomes visible in a " { $link scroller } " containing the editor. Does nothing if no parent of " { $snippet "gadget" } " is a " { $link scroller } "." } ;
  55
  56 HELP: remove-selection
  57 { $values { "editor" editor } }
  58 { $description "Removes currently selected text from the editor's " { $link document } "." } ;
  59
  60 HELP: <model-field>
  61 { $values { "model" model } { "gadget" editor } }
  62 { $description "Creates an editor gadget which targets the specified model. The model must contain a string, or another item with a defined " { $link length } ", as this will be checked during layout." } ;
  63
  64 HELP: <action-field>
  65 { $values { "quot" "a quotation ( string -- )" } { "gadget" editor } }
  66 { $description "Creates an editor gadget with a blank model. Whenever a value is entered into the editor and Return pressed, the value is pushed on the stack as a string and the specified quotation is called. Note that the quotation cannot update the value in the field. " } ;
  67
  68
  69 HELP: editor-string
  70 { $values { "editor" editor } { "string" string } }
  71 { $description "Outputs the contents of the editor's " { $link document } " as a string. Lines are separated by " { $snippet "\\n" } "." } ;
  72
  73
  74
  75 HELP: set-editor-string
  76 { $values { "string" string } { "editor" editor } }
  77 { $description "Sets the contents of the editor's " { $link document } " to a string,  which may use either " { $snippet "\\n" } ", " { $snippet "\\r\\n" } " or " { $snippet "\\r" } " line separators." } ;
  78
  79 ARTICLE: "gadgets-editors-selection" "The caret and mark"
  80 "If there is no selection, the caret and the mark are at the same location; otherwise the mark delimits the end-point of the selection opposite the caret."
  81 { $subsections
  82     editor-caret
  83     editor-mark
  84     change-caret
  85     change-caret&mark
  86     mark>caret
  87 }
  88 "Getting the selected text:"
  89 { $subsections
  90     gadget-selection?
  91     gadget-selection
  92 }
  93 "Removing selected text:"
  94 { $subsections remove-selection }
  95 "Scrolling to the caret location:"
  96 { $subsections scroll>caret }
  97 "Use " { $link user-input* } " to change selected text." ;
  98
  99 ARTICLE: "gadgets-editors-contents" "Getting and setting editor contents"
 100 { $subsections
 101     editor-string
 102     set-editor-string
 103     clear-editor
 104 } ;
 105
 106 ARTICLE: "gadgets-editors-commands" "Editor gadget commands"
 107 { $command-map editor "editing" }
 108 { $command-map editor "caret-motion" }
 109 { $command-map editor "selection" }
 110 { $command-map editor "clipboard" }
 111 { $command-map multiline-editor "multiline" } ;
 112
 113 ARTICLE: "ui.gadgets.editors" "Editor gadgets"
 114 "The " { $vocab-link "ui.gadgets.editors" } " vocabulary implements editor gadgets. An editor edits a passage of text. Editors display a " { $link document } ". Editors are built from and inherit all features of " { $link "ui.gadgets.line-support" } "."
 115 { $subsections "gadgets-editors-commands" }
 116 "Editors:"
 117 { $subsections
 118     editor
 119     <editor>
 120     "gadgets-editors-contents"
 121     "gadgets-editors-selection"
 122 }
 123 "Multiline editors:"
 124 { $subsections <multiline-editor> }
 125 "Fields:"
 126 { $subsections
 127     <model-field>
 128     <action-field>
 129 }
 130 "Editors edit " { $emphasis "documents" } ":"
 131 { $subsections "documents" } ;
 132
 133 TIP: "Editor gadgets support undo and redo; press " { $command editor "editing" com-undo } " and " { $command editor "editing" com-redo } "." ;
 134
 135 TIP: "Learn the keyboard shortcuts used in " { $link "ui.gadgets.editors" } "." ;
 136
 137 ABOUT: "ui.gadgets.editors"