editor
Factor handbook » UI framework » Building user interfaces » Pre-made UI gadgets » Editor gadgets

Prev:	Editor gadget commands
Next:	<editor> ( -- editor )

Vocabulary
ui.gadgets.editors

Class description
An editor is a control for editing a multi-line passage of text stored in a document model. Editors are created by calling <editor>.

Editors have the following slots:

caret	a model storing a line/column pair.
mark	a 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.
focused?	a boolean.
preedit-start	a line/column pair or f. It represents the starting point of the string being edited by an input method.
preedit-end	a line/column pair or f. It represents the end point of the string being edited by an input method.
preedit-selected-start	a line/column pair or f. It represents the starting point of the string being selected by an input method.
preedit-selected-end	a line/column pair or f. It represents the end point of the string being selected by an input method.
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-underlines	an array or f. It stores underline attributes for its preedit area.

Slots that are prefixed with "preedit-" should not be modified directly. They are changed by the platform-dependent backend.

See also
line-gadget

Definition

USING: ui.gadgets.line-support ;

IN: ui.gadgets.editors

TUPLE: editor < line-gadget
    caret mark caret-shape focused? blink blink-timer
    default-text preedit-start preedit-end
    preedit-selected-start preedit-selected-end
    preedit-selection-mode? preedit-underlines ;

Methods

USING: accessors ui.baseline-alignment ui.gadgets.editors
ui.text ;

M: editor baseline font>> font-metrics ascent>> ;


USING: accessors ui.baseline-alignment ui.gadgets.editors
ui.text ;

M: editor cap-height font>> font-metrics cap-height>> ;


USING: kernel ui.backend.gtk2.input-methods ui.gadgets.editors ;

M: editor cursor-loc&dim [ caret-loc ] [ caret-dim ] bi ;


USING: kernel sequences ui.backend.gtk2.input-methods
ui.gadgets.editors ;

M: editor cursor-surrounding
    dup editor-caret first2 [ swap editor-line ] dip ;


USING: kernel ui.backend.gtk2.input-methods ui.gadgets.editors ;

M: editor delete-cursor-surrounding 3drop ;


USING: kernel namespaces ui.gadgets.editors
ui.gadgets.editors.private ui.gadgets.line-support ui.render ;

M: editor draw-gadget*
    dup draw-default-text? [
        [ draw-default-text ] [ draw-caret ]
        [ draw-preedit-underlines ] tri
    ] [
        dup compute-selection selected-lines [
            [ draw-lines ] [ draw-caret ]
            [ draw-preedit-underlines ] tri
        ] with-variable
    ] if ;


USING: assocs kernel namespaces ui.gadgets.editors
ui.gadgets.editors.private ui.gadgets.line-support ;

M: editor draw-line
    [ selected-lines get at ] dip over
    [ draw-selected-line ] [ nip draw-unselected-line ] if ;


USING: accessors documents kernel ui.gadgets ui.gadgets.editors
ui.gadgets.editors.private ;

M: editor gadget-selection
    [ selection-start/end ] [ model>> ] bi doc-range ;


USING: kernel ui.gadgets ui.gadgets.editors
ui.gadgets.editors.private ;

M: editor gadget-selection? selection-start/end = not ;


USING: make ui.gadgets ui.gadgets.editors ;

M: editor gadget-text* editor-string % ;


USING: accessors kernel namespaces timers ui.gadgets
ui.gadgets.editors ui.gadgets.editors.private ;

M: editor graft*
    [ dup caret>> activate-editor-model ]
    [ dup mark>> activate-editor-model ] [
        [ [ blink-caret ] curry blink-interval get dup <timer> ]
        keep blink-timer<<
    ] tri ;


USING: accessors combinators kernel models ui.gadgets.editors
ui.gadgets.editors.private ;

M: editor model-changed
    {
        { [ 2dup model>> eq? ] [ contents-changed ] }
        { [ 2dup caret>> eq? ] [ nip caret/mark-changed ] }
        { [ 2dup mark>> eq? ] [ nip caret/mark-changed ] }
    } cond ;


USING: accessors ui.gadgets ui.gadgets.editors ;

M: editor preedit? preedit-start>> ;


USING: accessors generic kernel math.vectors ui.gadgets
ui.gadgets.editors ui.gadgets.editors.private ui.text ;

M: editor pref-dim*
    [ M\ editor pref-dim* (call-next-method) ] keep
    [ font>> ] keep dup draw-default-text?
    [ default-text>> ] [ control-value ] if text-dim { 1 0 } v+
    vmax ;


USING: kernel ui.backend.gtk2.input-methods ui.gadgets.editors ;

M: editor support-input-methods? drop t ;


USING: kernel ui.backend.cocoa.input-methods ui.gadgets.editors
;

M: editor support-input-methods? drop t ;


USING: accessors documents kernel ui.gadgets ui.gadgets.editors
ui.gadgets.editors.private ;

M: editor temp-im-input
    [ selection-start/end ] [ model>> ] bi set-doc-range* t ;


USING: accessors kernel ui.gadgets ui.gadgets.editors
ui.gadgets.editors.private ;

M: editor ungraft*
    [ [ stop-blinking ] [ f >>blink-timer drop ] bi ]
    [ dup caret>> deactivate-editor-model ]
    [ dup mark>> deactivate-editor-model ] tri ;


USING: accessors documents kernel ui.gadgets ui.gadgets.editors
ui.gadgets.editors.private ;

M: editor user-input*
    [ selection-start/end ] [ model>> ] bi set-doc-range t ;