Widget::GetGlobalWidgetState

Defined in: C4Widgets.h

Returns the global widget state.

Prototype

uint32 GetGlobalWidgetState(void) const;

Description

The GetGlobalWidgetState function returns the global widget state, which can be a combination (through logical OR) of the following constants.

`kWidgetDisabled`	The widget is disabled and does not receive events.
`kWidgetHidden`	The widget is hidden and is not rendered.
`kWidgetHilited`	The widget is in the highlighted state.
`kWidgetCollapsed`	The widget is in the collapsed state.
`kWidgetBackground`	The widget is in the background state.
`kWidgetSelected`	The widget is selected in a list or table.
`kWidgetInactive`	The widget is inactive in a list or table.
`kWidgetFocus`	The widget currently has the keyboard focus.
`kWidgetClickable`	The widget is activated by default when a mouse down event occurs and is not handled by the specific widget subclass.

The global widget state is calculated by taking the logical OR of the states of the widget for which the GetGlobalWidgetState function is called and all of its predecessors in the widget tree. This is useful for determining whether a widget is hidden or disabled either by itself or due to one of its predecessors being hidden or disabled.