get_window_attrget_window_attrGetWindowAttrGetWindowAttr (Operator)

Name

get_window_attrget_window_attrGetWindowAttrGetWindowAttr — Get window characteristics.

Signature

get_window_attr( : : AttributeName : AttributeValue)

The operator get_window_attrget_window_attrGetWindowAttrGetWindowAttrGetWindowAttr can be used to read characteristics of graphics windows that were set using set_window_attrset_window_attrSetWindowAttrSetWindowAttrSetWindowAttr. The following parameters of a window may be queried:

'border_width': Width of the window border in pixels.
'border_color': Color of the window border.
'background_color': Background color of the window.
'window_title': Name of the window in the title bar.

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

AttributeNameAttributeNameAttributeNameAttributeNameattributeName (input_control) string → (string)

Name of the attribute that should be returned.

List of values: 'background_color'"background_color""background_color""background_color""background_color", 'border_color'"border_color""border_color""border_color""border_color", 'border_width'"border_width""border_width""border_width""border_width", 'window_title'"window_title""window_title""window_title""window_title"

AttributeValueAttributeValueAttributeValueAttributeValueattributeValue (output_control) string → (string / integer)

Attribute value.

Result

If the parameters are correct get_window_attrget_window_attrGetWindowAttrGetWindowAttrGetWindowAttr returns 2 (H_MSG_TRUE). If necessary an exception is raised.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow, set_drawset_drawSetDrawSetDrawSetDraw, set_colorset_colorSetColorSetColorSetColor, set_coloredset_coloredSetColoredSetColoredSetColored, set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth

Module

Foundation

Operators