Operator Reference

set_window_attrset_window_attrSetWindowAttrSetWindowAttrset_window_attr (Operator)

set_window_attrset_window_attrSetWindowAttrSetWindowAttrset_window_attr — Set window characteristics.

Signature

set_window_attr( : : AttributeName, AttributeValue : )

Herror set_window_attr(const char* AttributeName, const char* AttributeValue)

Herror T_set_window_attr(const Htuple AttributeName, const Htuple AttributeValue)

void SetWindowAttr(const HTuple& AttributeName, const HTuple& AttributeValue)

static void HSystem::SetWindowAttr(const HString& AttributeName, const HTuple& AttributeValue)

static void HSystem::SetWindowAttr(const HString& AttributeName, const HString& AttributeValue)

static void HSystem::SetWindowAttr(const char* AttributeName, const char* AttributeValue)

static void HSystem::SetWindowAttr(const wchar_t* AttributeName, const wchar_t* AttributeValue)   ( Windows only)

static void HOperatorSet.SetWindowAttr(HTuple attributeName, HTuple attributeValue)

static void HSystem.SetWindowAttr(string attributeName, HTuple attributeValue)

static void HSystem.SetWindowAttr(string attributeName, string attributeValue)

def set_window_attr(attribute_name: str, attribute_value: Union[str, int]) -> None

Description

You may use set_window_attrset_window_attrSetWindowAttrSetWindowAttrset_window_attr 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_attrSetWindowAttrSetWindowAttrset_window_attr before calling open_windowopen_windowOpenWindowOpenWindowopen_window.

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

AttributeNameAttributeNameAttributeNameattributeNameattribute_name (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of the attribute that should be modified.

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"

AttributeValueAttributeValueAttributeValueattributeValueattribute_value (input_control)  string HTupleUnion[str, int]HTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)

Value of the attribute that should be set.

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

Result

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

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window, set_drawset_drawSetDrawSetDrawset_draw, set_colorset_colorSetColorSetColorset_color, set_coloredset_coloredSetColoredSetColoredset_colored, set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width

See also

open_windowopen_windowOpenWindowOpenWindowopen_window, get_window_attrget_window_attrGetWindowAttrGetWindowAttrget_window_attr, set_window_paramset_window_paramSetWindowParamSetWindowParamset_window_param

Module

Foundation