Skip to content

Latest commit

 

History

History
88 lines (39 loc) · 1.35 KB

texteditor.rst

File metadata and controls

88 lines (39 loc) · 1.35 KB

TextEditor

.. hoc:class:: TextEditor


    Syntax:
        ``e = new TextEditor()``

        ``e = new TextEditor(string)``

        ``e = new TextEditor(string, rows, columns)``


    Description:
        For editing or displaying multiline text. Default is 5 rows, 30 columns.

    .. warning::
        At this time no scroll bars or even much functionality. Mouse editing
        and emacs style works.




.. hoc:method:: TextEditor.text


    Syntax:
        ``string = e.text()``

        ``string = e.text(string)``


    Description:
        Returns the text of the TextEditor in a strdef. If arg exists, replaces
        the text by the string and returns the new text (string).




.. hoc:method:: TextEditor.readonly


    Syntax:
        ``boolean = e.readonly()``

        ``boolean = e.readonly(boolean)``


    Description:
        Returns 1 if the TextEditor in read only mode.
        Returns 0 if text entry by the user is allowed.
        Change the mode with the argument form using 0 or 1.




.. hoc:method:: TextEditor.map


    Syntax:
        ``e.map()``

        ``e.map(title)``

        ``e.map(title, left, bottom, width, height)``


    Description:
        Map the text editor onto the screen at indicated coordinates with
        indicated title bar