Microline/man/XmLProgress.3x

   1 .\" ***** BEGIN LICENSE BLOCK *****
   2 .\" Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3 .\"
   4 .\" The contents of this file are subject to the Mozilla Public License Version
   5 .\" 1.1 (the "License"); you may not use this file except in compliance with
   6 .\" the License. You may obtain a copy of the License at
   7 .\" http://www.mozilla.org/MPL/
   8 .\"
   9 .\" Software distributed under the License is distributed on an "AS IS" basis,
  10 .\" WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11 .\" for the specific language governing rights and limitations under the
  12 .\" License.
  13 .\"
  14 .\" The Original Code is the Microline Widget Library, originally made available under the NPL by Neuron Data <http://www.neurondata.com>.
  15 .\"
  16 .\" The Initial Developer of the Original Code is
  17 .\" Netscape Communications Corporation.
  18 .\" Portions created by the Initial Developer are Copyright (C) 1998
  19 .\" the Initial Developer. All Rights Reserved.
  20 .\"
  21 .\" Contributor(s):
  22 .\"
  23 .\" Alternatively, the contents of this file may be used under the terms of
  24 .\" either the GNU General Public License Version 2 or later (the "GPL"), or
  25 .\" the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26 .\" in which case the provisions of the GPL or the LGPL are applicable instead
  27 .\" of those above. If you wish to allow use of your version of this file only
  28 .\" under the terms of either the GPL or the LGPL, and not to allow others to
  29 .\" use your version of this file under the terms of the MPL, indicate your
  30 .\" decision by deleting the provisions above and replace them with the notice
  31 .\" and other provisions required by the GPL or the LGPL. If you do not delete
  32 .\" the provisions above, a recipient may use your version of this file under
  33 .\" the terms of any one of the MPL, the GPL or the LGPL.
  34 .\"
  35 .\" In addition, as a special exception to the GNU GPL, the copyright holders
  36 .\" give permission to link the code of this program with the Motif and Open
  37 .\" Motif libraries (or with modified versions of these that use the same
  38 .\" license), and distribute linked combinations including the two. You
  39 .\" must obey the GNU General Public License in all respects for all of
  40 .\" the code used other than linking with Motif/Open Motif. If you modify
  41 .\" this file, you may extend this exception to your version of the file,
  42 .\" but you are not obligated to do so. If you do not wish to do so,
  43 .\" delete this exception statement from your version.
  44 .\"
  45 .\" ***** END LICENSE BLOCK *****
  46 .TH XmLProgress 3X "R1" "XML1" "XML"
  47 .SH NAME
  48 XmLFolder
  49 .SH SYNOPSIS
  50 #include <XmL/Progress.h>
  51 .LP
  52 .SH DESCRIPTION
  53 A progress bar which can be used to chart completion of a task.
  54 Along with a Progress meter, this widget may optionally display text with
  55 percentage completion and elapsed and estimated time to completion.
  56 .SS Class Information
  57 Progress inherits from XmPrimitive and Core. Its class pointer
  58 is xmlProgressWidgetClass.  Its class name is XmLProgress.
  59 .SS New Resources
  60
  61 .nf
  62 .ft B
  63 Name                 Class
  64  Type                 Default           Access
  65 .ft P
  66 XmNcompleteValue     XmCCompleteValue
  67  int                  100               CSG
  68 XmNfontList          XmCFontList
  69  XmFontList           fixed             CSG
  70 XmNmeterStyle        XmCMeterStyle
  71  unsigned char        XmMETER_BAR       CSG
  72 XmNnumBoxes          XmCNumBoxes
  73  int                  10                CSG
  74 XmNshowPercentage    XmCShowPercentage
  75  Boolean              True              CSG
  76 XmNshowTime          XmCShowTime
  77  Boolean              False             CSG
  78 XmNvalue             XmCValue
  79  int                  0                 CSG
  80 .fi
  81 .IP XmNcompleteValue
  82 Defines the maximum value of the XmNvalue resource. When
  83 the XmNvalue resource reaches this number, the Progress bar
  84 will show 100% complete. This value is used to determine the
  85 percentage to complete and to estimate time to completion.
  86 .IP XmNfontList
  87 The font list used for drawing the percentage complete and estimated time.
  88 .IP XmNmeterStyle
  89 The style of the meter to draw. Possible values:
  90
  91 .nf
  92      XmMETER_BAR     /* standard bar meter */
  93      XmMETER_BOXES   /* shadowed boxes meter */
  94 .fi
  95
  96 Only the XmMETER_BAR style can display the percentage complete
  97 indicator and optional and estimated time to completion.
  98 .IP XmNnumBoxes
  99 When XmNmeterStyle is XmMETER_BOXES, this resource defines
 100 the number of boxes to display in the meter.
 101 .IP XmNshowPercentage
 102 If set to True, text will be shown centered in the widget
 103 displaying the current percentage complete. The percentage
 104 complete is calculated by dividing the XmNvalue by the XmNcompleteValue.
 105 .IP XmNshowTime
 106 If set to True, the widget will display the elapsed time in the
 107 left of the widget and the estimated time remaining on the right.
 108 The estimated time remaining is calculated using the XmNvalue,
 109 the XmNcompleteValue and the start time. The start time is the
 110 last time the XmNvalue was set to 0. No estimated time is shown
 111 when XmNvalue is 0 or when it is equal to the XmNcompleteValue.
 112 If set to False, only a percentage complete indicator will be shown.
 113 .IP XmNvalue
 114 A value from 0 to the XmNcompleteValue which defines how much
 115 progress has taken place. When this value is set to 0, the current
 116 time is stored as the start time for calculating estimated
 117 time to completion.
 118 .SS Inherited Resources
 119 Progress inherits the resources shown below
 120
 121 .nf
 122 .ft B
 123 Resource              From        Resource                      From
 124 .ft P
 125 XmNaccelerators       Core        XmNhighlightPixmap            Primitive
 126 XmNancestorSensitive  Core        XmNhighlightThickness         Primitive
 127 XmNbackground         Core        XmNinitialResourcesPersistent Core
 128 XmNbackgroundPixmap   Core        XmNmappedWhenManaged          Core
 129 XmNborderColor        Core        XmNnavagationType             Primitive
 130 XmNborderPixmap       Core        XmNscreen                     Core
 131 XmNborderWidth        Core        XmNsensitive                  Core
 132 XmNbottomShadowColor  Primitive   XmNshadowThickness            Primitive
 133 XmNbottomShadowPixmap Primitive   XmNtopShadowColor             Primitive
 134 XmNcolormap           Core        XmNtopShadowPixmap            Primitive
 135 XmNdepth              Core        XmNtranslations               Core
 136 XmNdestroyCallback    Core        XmNtraversalOn                Primitive
 137 XmNforeground         Primitive   XmNunitType                   Primitive
 138 XmNheight             Core        XmNuserData                   Primitive
 139 XmNhelpCallback       Primitive   XmNwidth                      Core
 140 XmNhighlightColor     Primitive   XmNx                          Core
 141 XmNhighlightOnEnter   Primitive   XmNy                          Core
 142 .fi
 143 .SH "SEE ALSO"
 144 XmLCreateProgress(3X)