.\" (c) Copyright 1994, 1995, Microline Software, Inc. ALL RIGHTS RESERVED
.\"
.\" THIS SOFTWARE IS FURNISHED UNDER A LICENSE AND MAY BE COPIED AND USED
.\" ONLY IN ACCORDANCE WITH THE TERMS OF THAT LICENSE AND WITH THE INCLUSION
.\" OF THE ABOVE COPYRIGHT NOTICE. THIS SOFTWARE AND DOCUMENTATION, AND ITS
.\" COPYRIGHTS ARE OWNED BY MICROLINE SOFTWARE AND ARE PROTECTED BY UNITED
.\" STATES COPYRIGHT LAWS AND INTERNATIONAL TREATY PROVISIONS.
.\"
.\" THE INFORMATION IN THIS SOFTWARE IS SUBJECT TO CHANGE WITHOUT NOTICE
.\" AND SHOULD NOT BE CONSTRUED AS A COMMITMENT BY MICROLINE SOFTWARE.
.\"
.\" THIS SOFTWARE AND REFERENCE MATERIALS ARE PROVIDED "AS IS" WITHOUT
.\" WARRANTY AS TO THEIR PERFORMANCE, MERCHANTABILITY, FITNESS FOR ANY
.\" PARTICULAR PURPOSE, OR AGAINST INFRINGEMENT. MICROLINE SOFTWARE
.\" ASSUMES NO RESPONSIBILITY FOR THE USE OR INABILITY TO USE THIS
.\" SOFTWARE.
.\"
.\" MICROLINE SOFTWARE SHALL NOT BE LIABLE FOR INDIRECT, SPECIAL OR
.\" CONSEQUENTIAL DAMAGES RESULTING FROM THE USE OF THIS PRODUCT. SOME
.\" STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR
.\" CONSEQUENTIAL DAMAGES, SO THE ABOVE LIMITATIONS MIGHT NOT APPLY TO
.\" YOU.
.\"
.\" MICROLINE SOFTWARE SHALL HAVE NO LIABILITY OR RESPONSIBILITY FOR SOFTWARE
.\" ALTERED, MODIFIED, OR CONVERTED BY YOU OR A THIRD PARTY, DAMAGES
.\" RESULTING FROM ACCIDENT, ABUSE OR MISAPPLICATION, OR FOR PROBLEMS DUE
.\" TO THE MALFUNCTION OF YOUR EQUIPMENT OR SOFTWARE NOT SUPPLIED BY
.\" MICROLINE SOFTWARE.
.\"
.\" U.S. GOVERNMENT RESTRICTED RIGHTS
.\" This Software and documentation are provided with RESTRICTED RIGHTS.
.\" Use, duplication or disclosure by the Government is subject to
.\" restrictions as set forth in subparagraph (c)(1) of the Rights in
.\" Technical Data and Computer Software Clause at DFARS 252.227-7013 or
.\" subparagraphs (c)(1)(ii) and (2) of Commercial Computer Software -
.\" Restricted Rights at 48 CFR 52.227-19, as applicable, supplier is
.\" Microline Software, 41 Sutter St Suite 1374, San Francisco, CA 94104.
.\"
.TH XmLProgress 3X "R1" "XML1" "XML"
.SH NAME
XmLFolder
.SH SYNOPSIS
#include <XmL/Progress.h>
.LP
.SH DESCRIPTION
A progress bar which can be used to chart completion of a task.
Along with a progress meter, this widget may optionally display text with
percentage completion and elapsed and estimated time to completion.
.SS Class Information
Progress inherits from XmPrimitive and Core. Its class pointer
is xmlProgressWidgetClass. Its class name is XmLProgress.
.SS New Resources
.nf
.ft B
Name Class
Type Default Access
.ft P
XmNcompleteValue XmCCompleteValue
int 100 CSG
XmNfontList XmCFontList
XmFontList fixed CSG
XmNmeterStyle XmCMeterStyle
unsigned char XmMETER_BAR CSG
XmNnumBoxes XmCNumBoxes
int 10 CSG
XmNshowPercentage XmCShowPercentage
Boolean True CSG
XmNshowTime XmCShowTime
Boolean False CSG
XmNvalue XmCValue
int 0 CSG
.fi
.IP XmNcompleteValue
Defines the maximum value of the XmNvalue resource. When
the XmNvalue resource reaches this number, the progress bar
will show 100% complete. This value is used to determine the
percentage to complete and to estimate time to completion.
.IP XmNfontList
The font list used for drawing the percentage complete and estimated time.
.IP XmNmeterStyle
The style of the meter to draw. Possible values:
.nf
XmMETER_BAR /* standard bar meter */
XmMETER_BOXES /* shadowed boxes meter */
.fi
Only the XmMETER_BAR style can display the percentage complete
indicator and optional and estimated time to completion.
.IP XmNnumBoxes
When XmNmeterStyle is XmMETER_BOXES, this resource defines
the number of boxes to display in the meter.
.IP XmNshowPercentage
If set to True, text will be shown centered in the widget
displaying the current percentage complete. The percentage
complete is calculated by dividing the XmNvalue by the XmNcompleteValue.
.IP XmNshowTime
If set to True, the widget will display the elapsed time in the
left of the widget and the estimated time remaining on the right.
The estimated time remaining is calculated using the XmNvalue,
the XmNcompleteValue and the start time. The start time is the
last time the XmNvalue was set to 0. No estimated time is shown
when XmNvalue is 0 or when it is equal to the XmNcompleteValue.
If set to False, only a percentage complete indicator will be shown.
.IP XmNvalue
A value from 0 to the XmNcompleteValue which defines how much
progress has taken place. When this value is set to 0, the current
time is stored as the start time for calculating estimated
time to completion.
.SS Inherited Resources
Progress inherits the resources shown below
.nf
.ft B
Resource From Resource From
.ft P
XmNaccelerators Core XmNhighlightPixmap Primitive
XmNancestorSensitive Core XmNhighlightThickness Primitive
XmNbackground Core XmNinitialResourcesPersistent Core
XmNbackgroundPixmap Core XmNmappedWhenManaged Core
XmNborderColor Core XmNnavagationType Primitive
XmNborderPixmap Core XmNscreen Core
XmNborderWidth Core XmNsensitive Core
XmNbottomShadowColor Primitive XmNshadowThickness Primitive
XmNbottomShadowPixmap Primitive XmNtopShadowColor Primitive
XmNcolormap Core XmNtopShadowPixmap Primitive
XmNdepth Core XmNtranslations Core
XmNdestroyCallback Core XmNtraversalOn Primitive
XmNforeground Primitive XmNunitType Primitive
XmNheight Core XmNuserData Primitive
XmNhelpCallback Primitive XmNwidth Core
XmNhighlightColor Primitive XmNx Core
XmNhighlightOnEnter Primitive XmNy Core
.fi
.SH "SEE ALSO"
XmLCreateProgress(3X)