steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

ui.gadgets.editors: cleanup docs for $slots.

master
John Benediktsson 2020-05-27 11:43:12 -07:00
parent c8afb239a0
commit f2189a32f4
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
basis/ui/gadgets/editors/editors-docs.factor
View File

@ -11,16 +11,16 @@ HELP: editor
{ $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> } "." { $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> } "."
$nl $nl
"Editors have the following slots:" "Editors have the following slots:"
{ $list { $slots
{ { $snippet "caret" } " - a " { $link model } " storing a line/column pair." } { "caret" { "a " { $link model } " storing a line/column pair." } }
{ { $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." } { "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." } }
{ { $snippet "focused?" } " - a boolean." } { "focused?" { "a boolean." } }
{ { $snippet "preedit-start" } " - a line/column pair or " { $link f } ". It represents the starting point of the string being edited by an input method." } { "preedit-start" { "a line/column pair or " { $link f } ". It represents the starting point of the string being edited by an input method." } }
{ { $snippet "preedit-end" } " - a line/column pair or " { $link f } ". It represents the end point of the string being edited by an input method." } { "preedit-end" { "a line/column pair or " { $link f } ". It represents the end point of the string being edited by an input method." } }
{ { $snippet "preedit-selected-start" } " - a line/column pair or " { $link f } ". It represents the starting point of the string being selected by an input method." } { "preedit-selected-start" { "a line/column pair or " { $link f } ". It represents the starting point of the string being selected by an input method." } }
{ { $snippet "preedit-selected-end" } " - a line/column pair or " { $link f } ". It represents the end point of the string being selected by an input method." } { "preedit-selected-end" { "a line/column pair or " { $link f } ". It represents the end point of the string being selected by an input method." } }
{ { $snippet "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." } { "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." } }
{ { $snippet "preedit-underlines" } " - an array or " { $link f } ". It stores underline attributes for its preedit area." } { "preedit-underlines" { "an array or " { $link f } ". It stores underline attributes for its preedit area." } }
} }
$nl $nl
" Slots that are prefixed with \"preedit-\" should not be modified directly. They are changed by the platform-dependent backend." " Slots that are prefixed with \"preedit-\" should not be modified directly. They are changed by the platform-dependent backend."