PtSetParentWidget()

Set the current parent widget

Synopsis:

PtWidget_t *PtSetParentWidget( PtWidget_t *widget );

Description:

This function sets the current parent widget. Some widget classes (for example, windows, lists and menus) call this function when they're created.

Note:

Widgets that belong to the PtContainer class become the current parent widget when created. If you're creating multiple PtContainer-class widgets, you must ensure that each one is placed in the correct container.

To do this, either call PtSetParentWidget() or specify the appropriate widget in the parent argument to PtCreateWidget().

If the widget argument is NULL and you then call PtCreateWidget() with a NULL parent argument, the new widget has no parent.

Returns:

A pointer to the previous parent widget, or NULL if there is none.

Examples:

See PtWidgetChildBack().

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No

See also:

PtCreateWidget(), PtFindGuardian(), PtGetParent(), PtGetParentWidget(), PtReParentWidget(), PtValidParent(), PtWidgetParent()

"Ordering widgets" in the Creating Widgets in Application Code chapter of the Photon Programmer's Guide