[Previous] [Contents] [Index] [Next]

PtFindGuardian()

Find the widget responsible for another widget's actions

Synopsis:

PtWidget_t *PtFindGuardian( PtWidget_t *child, 
                            int superior_only );

Description:

This function returns the widget that's responsible for the child's actions. This is either the child's natural parent or, if the child is Pt_PROCREATED, the widget that the child is a subordinate of (its superior widget).

If the superior_only value is nonzero, this function returns only a pointer to a superior widget as a guardian. If the child hasn't been procreated, the function returns NULL. (Only procreated widgets have superiors.)

Returns:

A pointer to the child widget's legal guardian, or NULL if the child widget has no guardian.

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PtGetParent(), PtValidParent(), PtWidgetParent()

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


[Previous] [Contents] [Index] [Next]