PtProgressFirstSegment()

Get the first segment of a progress bar

Synopsis:

int PtProgressFirstSegment(PtWidget_t *widget,
                           short *start,
                           short *end );

Description:

This function gets the coordinates (x for a horizontal bar, y for a vertical one) of the first segment of the PtProgress pointed to by widget.

The coordinates are stored in the space pointed to by start and end, taking into account whether or not the progress bar is inverted (i.e. the starting coordinate is always less than or equal to the end coordinate).

After calling this function, you can call PtProgressNextSegment() to get the coordinates of succeeding segments.

Returns:

0: Success.
Pt_PROGRESS_NO_MORE_SEGMENTS: No segment was found.

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No

See also:

PtProgress, PtProgressEntireSegment(), PtProgressNextSegment(), PtProgressTextRect()