C4 Engine
C4 Engine API Documentation

Widget::GetWidgetState

Defined in:  C4Widgets.h
Returns the widget state.
Prototype

uint32 GetWidgetState(voidconst;

Description
The GetWidgetState function returns the 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.
A widget may be implicitly disabled or hidden due to one of its predecessors in the widget tree having the disabled or hidden state. The Widget::GetGlobalWidgetState function can be used to quickly determine whether this is the case.
See Also

Widget::SetWidgetState

Widget::GetGlobalWidgetState

Widget::WidgetEnabled

Widget::WidgetVisible