Widget::WidgetVisible

Defined in: C4Widgets.h

Returns a boolean value indicating whether a widget is visible.

Prototype

bool WidgetVisible(void) const;

Description

The WidgetVisible function returns true if the widget is visible and false if it is hidden. Calling the WidgetVisible function is equivalent to calling the Widget::GetWidgetState function and testing that the kWidgetHidden state is not set.

A widget that is hidden is not rendered and does not receive input events.

A widget may be implicitly hidden due to one of its predecessors in the widget tree having the hidden state. In this case, the WidgetVisibleVisible function can still return true if the widget itself is not hidden, but the widget will still be invisible. You can quickly determine whether a widget is either explicitly or implicitly hidden by calling the Widget::GetGlobalWidgetState function and testing the kWidgetHidden state.