textedit

User-entered text in a patcher

Description

textedit provides for a user interface within a patcher which can collect typed-in text from the computer-keyboard.

Arguments

None.

Messages

bang Outputs the typed or stored contents of the textedit object's buffer.
int input [int] Sets the contents of the textedit object's buffer while causing no output.
float input [float] Sets the contents of the textedit object's buffer while causing no output.
list input-message [list] Sets the contents of the textedit object's buffer while causing no output as long as the list is comprised of numbers, otherwise, an error message is displayed.
(mouse) Clicking with the mouse on the textedit object (when the patcher window is locked) will cause the textedit object to send either the letter or word selected out its right outlet depending on the setting of the click mode (see the clickmode message).
(typing) When the textedit object is highlighted, typing enters text into the text display area and modifies its buffer, unless the object is set to read-only mode (see the readonly message). The ASCII value of the character typed is sent out the middle outlet.
append input-message [list] The word append, followed by a message, will append the message to the textedit object's buffer without causing any output.
clear Erases the contents of the textedit object's buffer.
enter Outputs the current text and takes the editing focus away from the object.
select Causes all text (if any) to be highlighted and sets the object to be the target of keyboard events if the object is not in read-only mode.
set input-message [list] The word set, followed by any message, sets the contents of the textedit object's buffer while causing no output.

Attributes

Name Type g/s Description
autoscroll int Toggles autoscrolling in the text display area. The message autoscroll 1 lets you scroll past the amount of text displayed in the textedit window when the number of lines is set to 1 and the word wrapping is disabled (see the wordwrap message) using either the cursor or by clicking and dragging in the textedit window. The default is 0 (autoscroll disabled).
def.:1
bgcolor float Sets the background color of the textedit object in RGBA format.
border float Sets the size, in pixels, of the border of the textedit object. The default is 1.
def.:2.
bordercolor float Sets the border color of the textedit object in RGBA format.
clickmode int Sets the way that the textedit object responds to mouse clicks in the text display area. The message clickmode 0 will send an individual character clicked on out the right outlet of the textedit object. Setting the object with the message clickmode 1 will send the word the user clicks on. The default is 0 (select characters).
def.:0
keymode int Sets the way that the textedit object responds to carriage returns while typing characters into its text display area. The message keymode 0 allows for text input, and displays carriage returns normally. Setting the object with the message keymode1 causes the carriage return to output the entire contents of the current buffer. The default is 0.
def.:0
lines int Sets the number of lines in the textedit object display.
def.:0
outputmode int Sets whether the textedit object outputs its contents as a message (0) or as a single symbol (1). The message outputmode 0 causes the output of the object to be sent out as messages. Setting the object with the message outputmode 1 will output the buffer contents as a single symbol. The default is 0 (output as messages).
def.:0
readonly int Toggles the read only mode of the textedit object. The message readonly 1 disables any user entry into the text box. Messages which operate on the current contents of the textedit buffer such as clear, append, or separator are not affected by the readonly message. The default is 0 (readonly mode off).
def.:0
rounded float Sets the rounding radius, in pixels, for the corners of the textedit object.
def.:8.
separator symbol Designates a symbol as a line separator. and treats it as a carriage return when the contents of the buffer are output. If the buffer contains the text "red green blue" and the object receives the message separator green, the next bang received by textedit will output red (carriage return) blue.
def.:nothing
tabmode int Toggles the ability to cause the tab key to output the entire contents of the current buffer. Tthe default is 1 (on).
def.:1
wordwrap int Sets the way that the textedit object displays messages which are longer than the textedit display area. The message wordwrap 0 (default) will enable text wrapping on word boundaries in the display area. The message clickmode 1 disables word-wrap.
def.:1

Information for box attributes common to all objects

Output

symbol: Out left outlet: The currently stored contents of the textedit object's buffer are output when the object receives a bang message. If the textedit message has been set to enter text on a carriage return using the keymode 1 message, a carriage return will also output the typed text and the buffer contents.
symbol: Out middle outlet: The ASCII value of the typed key.
symbol: Out right outlet: The word or letter in the textedit object's text box that the user has clicked on.

Examples

Collect text to store in a coll object

See Also

Name Description
dialog Open a dialog box for text entry
jit.cellblock Two-dimensional storage and viewing
text Format messages as a text file
Communications Tutorial 3: UDP Networking Communications Tutorial 3: UDP Networking