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

PtWidgetAbove()

Identify position of widget in hierarchy relative to another widget

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 the widget in front of widget, provided the returned widget isn't any higher in the hierarchy than root.

Returns:

A pointer to the widget above, or root if there isn't one; NULL if widget is the same as root, or widget is NULL.

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


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