ClassesClassesClassesClasses | | | | Operators

get_tshapeget_tshapeGetTshapeget_tshapeGetTshapeGetTshape (Operator)

Name

get_tshapeget_tshapeGetTshapeget_tshapeGetTshapeGetTshape — Get the shape of the text cursor.

Warning

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

Signature

get_tshape( : : WindowHandle : TextCursor)

Herror get_tshape(const Hlong WindowHandle, char* TextCursor)

Herror T_get_tshape(const Htuple WindowHandle, Htuple* TextCursor)

Herror get_tshape(const HTuple& WindowHandle, char* TextCursor)

HTuple HWindow::GetTshape() const

void GetTshape(const HTuple& WindowHandle, HTuple* TextCursor)

HString HWindow::GetTshape() const

void HOperatorSetX.GetTshape(
[in] VARIANT WindowHandle, [out] VARIANT* TextCursor)

BSTR HWindowX.GetTshape()

static void HOperatorSet.GetTshape(HTuple windowHandle, out HTuple textCursor)

string HWindow.GetTshape()

Description

get_tshapeget_tshapeGetTshapeget_tshapeGetTshapeGetTshape queries the shape of the text cursor for the output window. A new cursor shape is set by the operator set_tshapeset_tshapeSetTshapeset_tshapeSetTshapeSetTshape.

A text cursor marks the current position for text output (which can also be invisible). 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 (output_control)  string HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Name of the current text cursor.

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow, set_fontset_fontSetFontset_fontSetFontSetFont

Possible Successors

set_tshapeset_tshapeSetTshapeset_tshapeSetTshapeSetTshape, set_tpositionset_tpositionSetTpositionset_tpositionSetTpositionSetTposition, write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString, read_stringread_stringReadStringread_stringReadStringReadString, read_charread_charReadCharread_charReadCharReadChar

See also

set_tshapeset_tshapeSetTshapeset_tshapeSetTshapeSetTshape, query_tshapequery_tshapeQueryTshapequery_tshapeQueryTshapeQueryTshape, write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString, read_stringread_stringReadStringread_stringReadStringReadString

Module

Foundation


ClassesClassesClassesClasses | | | | Operators