Skip to content

new_lineNewLineNewLinenew_lineT_new_line🔗

Short description🔗

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

Signature🔗

new_line( window WindowHandle )void NewLine( const HTuple& WindowHandle )static void HOperatorSet.NewLine( HTuple windowHandle )def new_line( window_handle: HHandle ) -> None

Herror T_new_line( const Htuple WindowHandle )

void HWindow::NewLine( ) const

void HWindow.NewLine( )

Description🔗

new_lineNewLine 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_lineNewLine is called. The position is changed by the output or input of text (write_stringWriteString, read_stringReadString) or by an explicit change of position by (set_tpositionSetTposition).

Execution information🔗

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🔗

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

open_windowOpenWindow, set_fontSetFont, write_stringWriteString

Alternatives

get_tpositionGetTposition, get_string_extentsGetStringExtents, set_tpositionSetTposition

See also

write_stringWriteString, set_fontSetFont

Module🔗

Foundation