set_window_attrset_window_attrSetWindowAttrset_window_attrSetWindowAttrSetWindowAttr (Operator)

Name

set_window_attrset_window_attrSetWindowAttrset_window_attrSetWindowAttrSetWindowAttr — Set window characteristics.

Signature

set_window_attr( : : AttributeName, AttributeValue : )

You may use set_window_attrset_window_attrSetWindowAttrset_window_attrSetWindowAttrSetWindowAttr to set specific characteristics of graphics windows. With it you may modify the following default parameters of a window:

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

Attention

You have to call set_window_attrset_window_attrSetWindowAttrset_window_attrSetWindowAttrSetWindowAttr before calling open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow.

Parallelization

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

AttributeNameAttributeNameAttributeNameAttributeNameAttributeNameattributeName (input_control) string → (string)

Name of the attribute that should be modified.

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

AttributeValueAttributeValueAttributeValueAttributeValueAttributeValueattributeValue (input_control) string → (string / integer)

Value of the attribute that should be set.

List of values: 0, 1, 2, 'MyName'"MyName""MyName""MyName""MyName""MyName", 'black'"black""black""black""black""black", 'default'"default""default""default""default""default", 'white'"white""white""white""white""white"

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow, set_drawset_drawSetDrawset_drawSetDrawSetDraw, set_colorset_colorSetColorset_colorSetColorSetColor, set_coloredset_coloredSetColoredset_coloredSetColoredSetColored, set_line_widthset_line_widthSetLineWidthset_line_widthSetLineWidthSetLineWidth

Module

Foundation

Operators