Widget::SetWidgetState

Defined in: C4Widgets.h

Sets the widget state.

Prototype

virtual void SetWidgetState(uint32 state);

Parameters

state The new widget state.

Description

The SetWidgetState function sets the widget state to the value specified by the state parameter, 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 widget state should not normally be set directly, except by subclasses of Widget. Instead, functions such as Widget::EnableWidget, Widget::DisableWidget, Widget::ShowWidget, and Widget::HideWidget that set the state implicitly should be called.