Operator Reference

HALCON Operator Reference / Graphics / Window

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

get_window_attrget_window_attrGetWindowAttrGetWindowAttrget_window_attr (Operator)

get_window_attrget_window_attrGetWindowAttrGetWindowAttrget_window_attr — Get window characteristics.

Signature

get_window_attr( : : AttributeName : AttributeValue)

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

Herror T_get_window_attr(const Htuple AttributeName, Htuple* AttributeValue)

void GetWindowAttr(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 void HOperatorSet.GetWindowAttr(HTuple attributeName, out HTuple attributeValue)

static HTuple HSystem.GetWindowAttr(string attributeName)

def get_window_attr(attribute_name: str) -> Union[str, int]

Description

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

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

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"

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

Attribute value.

Result

If the parameters are correct get_window_attrget_window_attrGetWindowAttrGetWindowAttrget_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, set_window_attrset_window_attrSetWindowAttrSetWindowAttrset_window_attr

Module

Foundation

---

ClassesClasses | | Operators