Operator Reference

HALCON Operator Reference / Graphics / Text

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

new_lineT_new_lineNewLineNewLinenew_line (Operator)

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

Signature

new_line( : : WindowHandle : )

Herror T_new_line(const Htuple WindowHandle)

void NewLine(const HTuple& WindowHandle)

void HWindow::NewLine() const

static void HOperatorSet.NewLine(HTuple windowHandle)

void HWindow.NewLine()

def new_line(window_handle: HHandle) -> None

Description

new_linenew_lineNewLineNewLinenew_line 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_lineNewLineNewLinenew_line is called. The position is changed by the output or input of text (write_stringwrite_stringWriteStringWriteStringwrite_string, read_stringread_stringReadStringReadStringread_string) or by an explicit change of position by (set_tpositionset_tpositionSetTpositionSetTpositionset_tposition).

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

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window, set_fontset_fontSetFontSetFontset_font, write_stringwrite_stringWriteStringWriteStringwrite_string

Alternatives

get_tpositionget_tpositionGetTpositionGetTpositionget_tposition, get_string_extentsget_string_extentsGetStringExtentsGetStringExtentsget_string_extents, set_tpositionset_tpositionSetTpositionSetTpositionset_tposition

See also

write_stringwrite_stringWriteStringWriteStringwrite_string, set_fontset_fontSetFontSetFontset_font

Module

Foundation

---

ClassesClasses | | Operators