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

   1 USING: colors documents fonts help.markup help.syntax help.tips models
   2 sequences strings ui.commands ui.gadgets ui.gadgets.line-support
   3 ui.gadgets.scrollers ;
   4 IN: ui.gadgets.editors
   5
   6 HELP: <multiline-editor>
   7 { $values { "editor" multiline-editor } }
   8 { $description "Creates a new multi-line editor gadget." } ;
   9
  10 HELP: editor
  11 { $class-description "An editor is a control for editing a multi-line passage of text stored in a " { $link document } " model. Editors are created by calling " { $link <editor> } "."
  12 $nl
  13 "Editors have the following slots:"
  14 { $slots
  15     { "caret" { "a " { $link model } " storing a line/column pair." } }
  16     { "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     { "focused?" { "a boolean." } }
  18     { "preedit-start" { "a line/column pair or " { $link f } ". It represents the starting point of the string being edited by an input method." } }
  19     { "preedit-end" { "a line/column pair or " { $link f } ". It represents the end point of the string being edited by an input method." } }
  20     { "preedit-selected-start" { "a line/column pair or " { $link f } ". It represents the starting point of the string being selected by an input method." } }
  21     { "preedit-selected-end" { "a line/column pair or " { $link f } ". It represents the end point of the string being selected by an input method." } }
  22     { "preedit-selection-mode?" { "a boolean. It means the mode of selecting convertion canditate word. The caret in an editor is not drawn if it is true." } }
  23     { "preedit-underlines" { "an array or " { $link f } ". It stores underline attributes for its preedit area." } }
  24 }
  25 $nl
  26 " Slots that are prefixed with \"preedit-\" should not be modified directly. They are changed by the platform-dependent backend."
  27 }
  28 { $see-also line-gadget } ;
  29
  30 HELP: <editor>
  31 { $values { "editor" "a new " { $link editor } } }
  32 { $description "Creates a new " { $link editor } " with an empty document." } ;
  33
  34 { editor-caret editor-mark } related-words
  35
  36 HELP: caret-style
  37 { $description "Caret styles available:"
  38 { $table
  39   { "Value" "Shape" }
  40   { { $link +line+ } "line (default)" }
  41   { { $link +box+ } "box" }
  42   { { $link +filled+ } "filled box" }
  43 }
  44 }
  45 { $references "Set desired caret style in your .factor-rc file" "rc-files" } ;
  46
  47 HELP: editor-caret
  48 { $values { "editor" editor } { "loc" "a pair of integers" } }
  49 { $description "Outputs the current caret location as a line/column number pair." } ;
  50
  51 HELP: editor-mark
  52 { $values { "editor" editor } { "loc" "a pair of integers" } }
  53 { $description "Outputs the current mark location as a line/column number pair." } ;
  54
  55 HELP: change-caret
  56 { $values { "editor" editor } { "quot" { $quotation ( loc document -- newloc ) } } }
  57 { $description "Applies a quotation to the current caret location and moves the caret to the location output by the quotation." } ;
  58
  59 { change-caret change-caret&mark mark>caret } related-words
  60
  61 HELP: mark>caret
  62 { $values { "editor" editor } }
  63 { $description "Moves the mark to the caret location, effectively deselecting any selected text." } ;
  64
  65 HELP: change-caret&mark
  66 { $values { "editor" editor } { "quot" { $quotation ( loc document -- newloc ) } } }
  67 { $description "Applies a quotation to the current caret location and moves the caret and the mark to the location output by the quotation." } ;
  68
  69 HELP: point>loc
  70 { $values { "point" "a pair of integers" } { "editor" editor } { "loc" "a pair of integers" } }
  71 { $description "Converts a point to a line/column number pair." } ;
  72
  73 HELP: scroll>caret
  74 { $values { "editor" editor } }
  75 { $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 } "." } ;
  76
  77 HELP: remove-selection
  78 { $values { "editor" editor } }
  79 { $description "Removes currently selected text from the editor's " { $link document } "." } ;
  80
  81 HELP: <model-field>
  82 { $values { "model" model } { "gadget" editor } }
  83 { $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." } ;
  84
  85 HELP: <action-field>
  86 { $values { "quot" { $quotation ( string -- ) } } { "gadget" editor } }
  87 { $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." } ;
  88
  89
  90 HELP: editor-string
  91 { $values { "editor" editor } { "string" string } }
  92 { $description "Outputs the contents of the editor's " { $link document } " as a string. Lines are separated by " { $snippet "\\n" } "." } ;
  93
  94
  95
  96 HELP: set-editor-string
  97 { $values { "string" string } { "editor" editor } }
  98 { $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." } ;
  99
 100 ARTICLE: "gadgets-editors-selection" "The caret and mark"
 101 "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."
 102 { $subsections
 103     editor-caret
 104     editor-mark
 105     change-caret
 106     change-caret&mark
 107     mark>caret
 108 }
 109 "Getting the selected text:"
 110 { $subsections
 111     gadget-selection?
 112     gadget-selection
 113 }
 114 "Removing selected text:"
 115 { $subsections remove-selection }
 116 "Scrolling to the caret location:"
 117 { $subsections scroll>caret }
 118 "Use " { $link user-input* } " to change selected text." ;
 119
 120 ARTICLE: "gadgets-editors-contents" "Getting and setting editor contents"
 121 { $subsections
 122     editor-string
 123     set-editor-string
 124     clear-editor
 125 } ;
 126
 127 ARTICLE: "gadgets-editors-commands" "Editor gadget commands"
 128 { $command-map editor "editing" }
 129 { $command-map editor "caret-motion" }
 130 { $command-map editor "selection" }
 131 { $command-map editor "clipboard" }
 132 { $command-map multiline-editor "multiline" } ;
 133
 134 ARTICLE: "ui.gadgets.editors" "Editor gadgets"
 135 "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" } "."
 136 { $subsections "gadgets-editors-commands" }
 137 "Editors:"
 138 { $subsections
 139     editor
 140     <editor>
 141     "gadgets-editors-contents"
 142     "gadgets-editors-selection"
 143 }
 144 "Multiline editors:"
 145 { $subsections <multiline-editor> }
 146 "Fields:"
 147 { $subsections
 148     <model-field>
 149     <action-field>
 150 }
 151 "Editors edit " { $emphasis "documents" } ":"
 152 { $subsections "documents" } ;
 153
 154 TIP: "Editor gadgets support undo and redo; press " { $command editor "editing" com-undo } " and " { $command editor "editing" com-redo } "." ;
 155
 156 TIP: "Learn the keyboard shortcuts used in " { $link "ui.gadgets.editors" } "." ;
 157
 158 ABOUT: "ui.gadgets.editors"