---

PtWidgetAbove()

Get the widget that's above a given widget in a family hierarchy

Synopsis:

PtWidget_t * PtWidgetAbove( PtWidget_t *root, 
                            PtWidget_t *widget );

Arguments:

root

A pointer to the highest widget that you want to consider in the widget family hierarchy.

widget

A pointer to the widget for which you want to find a widget above.

Description:

This function returns a pointer to the widget that's in front of widget, provided the returned widget isn't any higher in the widget family hierarchy than root.

PtWidgetAbove() skips any disjoint widgets that it finds as it traverses the hierarchy.

Returns:

A pointer to the widget above, or NULL if there isn't one. If widget is the same as root, the function returns the first child of root, or NULL if root has no children.

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No

See also:

PtWidgetBrotherBehind(), PtWidgetBrotherInFront(), PtWidgetChildBack(), PtWidgetChildFront(), PtWidgetFamily(), PtWidgetParent(), PtWidgetTree(), PtWidgetTreeTraverse() in the Photon Library Reference

---