Skip to content

get_window_attrGetWindowAttrGetWindowAttrget_window_attrget_window_attr🔗

Short description🔗

get_window_attrGetWindowAttrGetWindowAttrget_window_attrget_window_attr — Get window characteristics.

Signature🔗

get_window_attr( string AttributeName, out string AttributeValue )void GetWindowAttr( const HTuple& AttributeName, HTuple* AttributeValue )static void HOperatorSet.GetWindowAttr( HTuple attributeName, out HTuple attributeValue )def get_window_attr( attribute_name: str ) -> Union[str, int]

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

Herror T_get_window_attr( const Htuple AttributeName, Htuple* AttributeValue )

static HTuple HSystem::GetWindowAttr( const HString& AttributeName )

static HTuple HSystem::GetWindowAttr( const char* AttributeName )

static HTuple HSystem::GetWindowAttr( const wchar_t* AttributeName ) (Windows only)

static HTuple HSystem.GetWindowAttr( string attributeName )

Description🔗

The operator get_window_attrGetWindowAttr can be used to read characteristics of graphics windows that were set using set_window_attrSetWindowAttr. 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🔗

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🔗

AttributeNameattributeNameattribute_name (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the attribute that should be returned.

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

AttributeValueattributeValueattribute_value (output_control) string → (string / integer)HTuple (HString / Hlong)HTuple (string / int / long)Union[str, int]Htuple (char* / Hlong)

Attribute value.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

open_windowOpenWindow, set_drawSetDraw, set_colorSetColor, set_coloredSetColored, set_line_widthSetLineWidth

See also

open_windowOpenWindow, set_window_attrSetWindowAttr

Module🔗

Foundation