new_linenew_lineNewLineNewLine (Operator)

Name

new_linenew_lineNewLineNewLine — Set the position of the text cursor to the beginning of the next line.

Signature

Description

new_linenew_lineNewLineNewLineNewLine sets the position of the text cursor to the beginning of the next line. The new position depends on the current font. The left end of the baseline for writing the following text string (not considering descenders) is placed on this position.

If the next line does not fit into the window the content of the window is scrolled by the height of one line in the upper direction. In order to reach the correct new cursor position the font used in the next line must be set before new_linenew_lineNewLineNewLineNewLine is called. The position is changed by the output or input of text (write_stringwrite_stringWriteStringWriteStringWriteString, read_stringread_stringReadStringReadStringReadString) or by an explicit change of position by (set_tpositionset_tpositionSetTpositionSetTpositionSetTposition).

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Result

new_linenew_lineNewLineNewLineNewLine returns 2 (H_MSG_TRUE) if the window is valid. Otherwise an exception is raised.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow, set_fontset_fontSetFontSetFontSetFont, write_stringwrite_stringWriteStringWriteStringWriteString

Alternatives

get_tpositionget_tpositionGetTpositionGetTpositionGetTposition, get_string_extentsget_string_extentsGetStringExtentsGetStringExtentsGetStringExtents, set_tpositionset_tpositionSetTpositionSetTpositionSetTposition

See also

write_stringwrite_stringWriteStringWriteStringWriteString, set_fontset_fontSetFontSetFontSetFont

Module

Foundation