PtDestroyWidget()

Remove a widget from the widget family hierarchy

Synopsis:

int PtDestroyWidget( PtWidget_t *widget );

Library:

ph

Description:

This function performs the following on the specified widget:

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

The widget's resources aren't freed until the return of PtEventHandler().

Returns:

0

Success.

-1

An error occurred.

Examples:

See PtWidgetChildBack().

Classification:

Photon

See also:

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

"Widget life cycle" in the Introduction to the Photon Programmer's Guide