PtHold()

Prevent visible repair of all widgets

Synopsis:

int PtHold( void );

Description:

This function prevents visible repair of all widgets until the application makes a corresponding call to PtRelease().

A global hold count is incremented when PtHold() is called, and decremented when PtRelease() is called. When the hold count reaches 0, the widgets are repaired.

A global hold count of 0 simply means that the application doesn't want to prevent widgets from repairing themselves. The widgets manage their own damage repair and may not take immediate action even if the count is 0.

Each damaged widget that has been held by PtHold() and then released by PtRelease() is repaired separately.

PtHold() and PtRelease() affect all widgets while PtContainerHold() and PtContainerRelease() prevent only child widgets of a container from being repaired.

Returns:

The new value of the global hold count.

Examples:

See PtClearWidget().

Classification:

Photon

See also:

PtContainerHold(), PtContainerRelease(), PtFlush(), PtRelease()