NAME

SYNOPSIS

Include File:

#include <Xmt/Progress.h>

Constructor:

XmtCreateProgress()

Class Name:

XmtProgress

Class Pointer:

xmtProgressWidgetClass

Class Hierarchy:

Core → XmPrimitive → XmtProgress

DESCRIPTION

It can be used to display the progress, or percentage completion, of a task; it can also be used for other visually similar indicators, such as thermometers, gauges, or similar items.

The display normally sweeps from left to right, or bottom to top, for the linear displays; for the circular displays, it sweeps in a counter-clockwise direction from the vertical. However, the XmtNreverse resource, if set, will cause it to sweep in the opposite direction.

The stepped display will have a shadow around each step, unless the XmPrimitive XmNshadowThickness resource is zero. Each step is filled when the progress value reaches or exceeds that point.

If desired, the widget can display the current percentage value or an arbitrary label centered within itself.

The convenience routines XmtProgressSet(), XmtProgressGet, and XmtProgressClear allow quick and efficent access to the widget's value setting.

RESOURCES

Cli inherits the resources of the XmPrimitive class, overriding the default of XmNtraversalOn to False, and XmNhighlightThickess to 0, and defines the following new resources:

XmtNfillColor

The color used for the filled portion of the widget. This defaults to the Motif select color.

XmtNfontList

The font used to display the percentage or label. In Motif 2.0 and later, this is an obsolete resource; XmtNrenderTable should be used instead. This defaults to the Motif default font.

XmtNlabelBoxed

Whether the label should be displayed filled with the background color. Note that this usually produces poor results if XmtNlabelXOR is true. This defaults to False.

XmtNlabelString

If non-NULL and XmtNshowPercent is False, this label string is displayed centered in the widget. This defaults to NULL.

XmtNlabelXOR

Draw the label, or percentage, using XOR, so that it appears inverted against the background or fill color. This defaults to False.

XmtNmargin

The margin between the edge of the widget and the percentage display. This defaults to 2.

XmtNorientation

The orientation of the display, when XmtNstyle is XmtPROGRESS_CONTINUOUS or XmtPROGRESS_STEPPED. It can be XmVERTICAL or XmHORIZONTAL, and defaults to XmHORIZONTAL.

XmtNrenderTable

For Motif 2.0 and later, this is the font rendition table for the label or percentage display.

XmtNreverse

Reverse the direction of the display. For horizontal continuous or stepped displays, display from right to left; for vertical continuous or stepped, display from bottom to top. For circular displays, sweep in a clockwise direction. This defaults to False.

XmtNshowPercent

Whether or not the widget display the current percentage setting. If this resource is True, then the widget will display the current percentage, as an integer, in the center of the widget. If False, then the widget will display the XmtNlabelString, if set, or nothing. This defaults to True for the XmtPROGRESS_CONTINUOUS and XmtPROGRESS_CIRCLE styles, and False for the XmtPROGRESS_STEPPED style.

XmtNstepSpacing

When the widget is in stepped mode, this is the spacing between each step block, not including the shadow, if any. This defaults to 2.

XmtNstepWidth

When the widget is in stepped mode, this is the size of the steps, in the direction of the current orientation. If set to 0 (the default), the widget computes the step width so that the steps are approximately square.

If the steps, with the spacing, are not an exact multiple of the widget's interior width, then the last step will be shorted as necessary.

XmtNstyle

The display style of the Progress widget. This can be:

XmtNvalue

The current value. This ranges from 0 to XmtPROGRESS_MAX; it is in 1/100ths of a percent (so that 1% is 100).

CALLBACKS

The Progress widget has no callbacks.

TRANSLATIONS

The Progress widget inherits an unmodified set of the XmPrimitive widget translations.

SEE ALSO