ClassesClasses | | Operators

set_tshapeset_tshapeSetTshapeSetTshape (Operator)

Name

set_tshapeset_tshapeSetTshapeSetTshape — Set the shape of the text cursor.

Warning

set_tshapeset_tshapeSetTshapeSetTshapeSetTshape 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)

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

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

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

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

void HWindow.SetTshape(string textCursor)

Description

set_tshapeset_tshapeSetTshapeSetTshapeSetTshape 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_tshapeQueryTshapeQueryTshapeQueryTshape.

Execution Information

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Window handle.

TextCursorTextCursorTextCursorTextCursortextCursor (input_control)  string HTupleHTupleHtuple (string) (string) (HString) (char*)

Name of cursor shape.

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

Result

set_tshapeset_tshapeSetTshapeSetTshapeSetTshape 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_windowOpenWindowOpenWindowOpenWindow, query_tshapequery_tshapeQueryTshapeQueryTshapeQueryTshape, get_tshapeget_tshapeGetTshapeGetTshapeGetTshape

Possible Successors

write_stringwrite_stringWriteStringWriteStringWriteString, read_stringread_stringReadStringReadStringReadString

See also

get_tshapeget_tshapeGetTshapeGetTshapeGetTshape, query_tshapequery_tshapeQueryTshapeQueryTshapeQueryTshape, write_stringwrite_stringWriteStringWriteStringWriteString, read_stringread_stringReadStringReadStringReadString

Module

Foundation


ClassesClasses | | Operators