PtContainerHold()

Prevent repairs to a container widget and its children

Synopsis:

int PtContainerHold( PtWidget_t *container_widget );

Description:

This function prevents repairs to the specified container widget and to all its children. Repairs aren't made until the application makes a corresponding call to PtContainerRelease().

When the widgets are eventually released, they aren't repaired separately. Instead, only the container parent widget is repaired. As a result, the children are all repaired simultaneously.

PtContainerHold() and PtContainerRelease() increment/decrement the flux count for the specified container widget. This count is different from the global hold count, which is used by PtHold() and PtRelease() to hold all widgets.

Returns:

The container widget's current hold count.

Examples:

See PtClearWidget().

Classification:

Photon

See also:

PtContainerRelease(), PtFlush(), PtHold(), PtRelease()