PtProgress

A progress bar

Class hierarchy:

PtWidget → PtBasic → PtGauge → PtProgress

For more information, see the diagram of the widget hierarchy.

PhAB icon:

Public header:

<photon/PtProgress.h>

Description:

The PtProgress widget draws a progress bar and (optionally) the corresponding value.

Two styles of PtProgress bar.

The bar can be either a single bar, growing continuously as the value is changed, or it can consist of a number of divisions of equal size.

The following bits of the Pt_ARG_GAUGE_FLAGS resource defined by PtGauge are of particular interest to PtProgress:

Pt_GAUGE_INDETERMINATE

The current value is “unknown.”

Pt_GAUGE_LIVE

Alter the widget's appearance as time passes to indicate that although the value may not be changing, the application is still working.

Pt_GAUGE_INTERACTIVE

Let the user change the value of the gauge interactively at runtime (e.g. by dragging). When the value is changed in this manner, the widget's Pt_CB_GAUGE_VALUE_CHANGED callbacks are invoked.

New resources:

Pt_ARG_PROGRESS_BAR_COLOR

The color of the progress bar. See PgColor_t in the Photon Library Reference.

Pt_ARG_PROGRESS_DIVISIONS

The number of divisions (1 means continuous).

PtProgress doesn't use this resource, but any subclasses can.

Pt_ARG_PROGRESS_GAP

The gap (in pixels) between the progress bar and the text (if the text isn't on top of the bar).

PtProgress doesn't use this resource, but any subclasses can.

Pt_ARG_PROGRESS_SPACING

The spacing (in pixels) between divisions (see Pt_ARG_PROGRESS_DIVISIONS).

Inherited resources:

If the widget modifies an inherited resource, the “Default override” column indicates the new value. This modification affects any subclasses of the widget.

Convenience functions:

PtProgress defines the following convenience functions:

---

These functions are useful only if you create subclasses of PtProgress.

---

PtProgressEntireSegment()

Get the entire segment of a progress bar

PtProgressFirstSegment()

Get the first segment of a progress bar

PtProgressNextSegment()

Get the next segment of a progress bar

PtProgressTextRect()

Get the text area of a progress bar