PtDestroyWidget()

Remove a widget from the widget hierarchy

Synopsis:

int PtDestroyWidget( PtWidget_t *widget );

Description:

This function performs the following on the specified widget:

• unrealizes it, if necessary
• destroys its children
• removes it from the widget hierarchy
• adds the widget to the destroyed list

The widget's resources aren't freed until the return of PtEventHandler() or the next time PtSyncPhoton() is called.

Returns:

0

Successful completion.

-1

An error occurred.

Examples:

See PtWidgetChildBack().

Classification:

Photon

See also:

PtEventHandler(), PtSyncPhoton(), PtCreateWidget(), PtRealizeWidget(), PtUnrealizeWidget()