HALCON Website / HALCON Operator Reference / Legacy / Graphics
ClassesClassesClassesClasses | | | | Operators

set_tshapeset_tshapeSetTshapeset_tshapeSetTshapeSetTshape (Operator)

Name

set_tshapeset_tshapeSetTshapeset_tshapeSetTshapeSetTshape — Set the shape of the text cursor.

Warning

set_tshapeset_tshapeSetTshapeset_tshapeSetTshapeSetTshape is obsolete and is only provided for reasons of backward compatibility.

Signature

set_tshape( : : WindowHandle, TextCursor : )

Herror set_tshape(const Hlong WindowHandle, const char* TextCursor)

Herror T_set_tshape(const Htuple WindowHandle, const Htuple TextCursor)

Herror set_tshape(const HTuple& WindowHandle, const HTuple& TextCursor)

void HWindow::SetTshape(const HTuple& TextCursor) const

void SetTshape(const HTuple& WindowHandle, const HTuple& TextCursor)

void HWindow::SetTshape(const HString& TextCursor) const

void HWindow::SetTshape(const char* TextCursor) const

void HOperatorSetX.SetTshape(
[in] VARIANT WindowHandle, [in] VARIANT TextCursor)

void HWindowX.SetTshape([in] BSTR TextCursor)

static void HOperatorSet.SetTshape(HTuple windowHandle, HTuple textCursor)

void HWindow.SetTshape(string textCursor)

Description

set_tshapeset_tshapeSetTshapeset_tshapeSetTshapeSetTshape sets the shape and the display mode of the text cursor of the output window.

A text cursor marks the current position for text output. It is different from the mouse cursor (although both will be called 'cursor', if the context makes misconceptions impossible). The available shapes for the text cursor can be queried with query_tshapequery_tshapeQueryTshapequery_tshapeQueryTshapeQueryTshape.

Parallelization

Parameters

WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window → HWindow, HTupleHTupleHTupleHWindowX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Window handle.

TextCursorTextCursorTextCursorTextCursorTextCursortextCursor (input_control)  string → HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Name of cursor shape.

Default value: 'invisible' "invisible" "invisible" "invisible" "invisible" "invisible"

Result

set_tshapeset_tshapeSetTshapeset_tshapeSetTshapeSetTshape returns 2 (H_MSG_TRUE) if the window is valid and the given cursor shape is defined for this window. Otherwise an exception is raised.

Possible Predecessors

open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow, query_tshapequery_tshapeQueryTshapequery_tshapeQueryTshapeQueryTshape, get_tshapeget_tshapeGetTshapeget_tshapeGetTshapeGetTshape

Possible Successors

write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString, read_stringread_stringReadStringread_stringReadStringReadString

See also

get_tshapeget_tshapeGetTshapeget_tshapeGetTshapeGetTshape, query_tshapequery_tshapeQueryTshapequery_tshapeQueryTshapeQueryTshape, write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString, read_stringread_stringReadStringread_stringReadStringReadString

Module

Foundation

ClassesClassesClassesClasses | | | | Operators
HALCON Operator Reference 13.0.4 Copyright © 1996-2019 MVTec Software GmbH