Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
XmtWorkingBox(3)	   Library Functions Manual	      XmtWorkingBox(3)

NAME
       XmtWorkingBox - a widget	for ``please wait'' dialogs.

SYNOPSIS
       Include File:
	      #include _Xmt/WorkingBox.h_

       Constructor:
	      XmtCreateWorkingBox()
	      XmtCreateWorkingDialog()

       Class Name:
	      XmtWorkingBox

       Class Pointer:
	      xmtWorkingBoxWidgetClass

       Class Hierarchy:
	      Core -> XmManager	-> XmBulletinBoard -> XmtWorkingBox

DESCRIPTION
       The  XmtWorkingBox widget is a compound widget intended to be displayed
       when the	application must perform a lengthy computation or  other  task
       which prevents normal processing	of events. It provides feedback	to the
       user that the application is busy and that she should not try to	inter-
       act  with  it  normally.	The WorkingBox is designed to provide more so-
       phisticated ``working'' dialogs than is possible	with the Motif	XmCre-
       ateWorkingDialog()  function (which simply creates an XmMessageBox wid-
       get with	an hourglass icon). The	WorkingBox  widget  displays  its  own
       ``please	 wait''	icon, and a message, just like an XmMessageBox,	but it
       also optionally displays	a labeled XmScale widget that can be  used  to
       provide	feedback  on the progress of what ever task the	application is
       performing, and optionally displays an  XmPushButton  widget  that  the
       user can	use to abort the task.

       RESOURCES

       XmtWorkingBox  inherits the resources of	the XmBulletinBoard class, and
       defines the following new resources:

       +-----------------+------------+-----------------+--------+---------------+
       |Name		 | Type	      |	Class		| Access | Default	 |
       +-----------------+------------+-----------------+--------+---------------+
       |XmtNbuttonLabel	 | XtRString  |	XmtCButtonLabel	| CSG	 | "Stop"	 |
       +-----------------+------------+-----------------+--------+---------------+
       |XmtNbuttonWidget | XtRWidget  |	XtCReadOnly	| G	 | N.A.		 |
       +-----------------+------------+-----------------+--------+---------------+
       |XmtNicon	 | XtRPixmap  |	XmtCIcon	| CSG	 | None		 |
       +-----------------+------------+-----------------+--------+---------------+
       |XmtNmessage	 | XtRString  |	XmtCMessage	| CSG	 | NULL		 |
       +-----------------+------------+-----------------+--------+---------------+
       |XmtNscaleLabel	 | XtRString  |	XmtCScaleLabel	| CSG	 | "% Complete:" |
       +-----------------+------------+-----------------+--------+---------------+
       |XmtNscaleMax	 | XtRInt     |	XmtCScaleMax	| CSG	 | 100		 |
       +-----------------+------------+-----------------+--------+---------------+
       |XmtNscaleMin	 | XtRInt     |	XmtCScaleMin	| CSG	 | 0		 |
       +-----------------+------------+-----------------+--------+---------------+
       |XmtNscaleValue	 | XtRInt     |	XmtCScaleValue	| CSG	 | 0		 |
       +-----------------+------------+-----------------+--------+---------------+
       |XmtNscaleWidget	 | XtRWidget  |	XtCReadOnly	| G	 | N.A.		 |
       +-----------------+------------+-----------------+--------+---------------+
       |XmtNshowButton	 | XtRBoolean |	XmtCShowButton	| CSG	 | True		 |
       +-----------------+------------+-----------------+--------+---------------+
       |XmtNshowScale	 | XtRBoolean |	XmtCShowScale	| CSG	 | True		 |
       +-----------------+------------+-----------------+--------+---------------+
       XmtNbuttonLabel
	      The label	to appear in the  XmPushButton	widget	child  of  the
	      WorkingBox, if XmtNshowButton is True.

       XmtNbuttonWidget
	      A	 read-only resource that may be	queried	to get a handle	to the
	      XmPushButton child of the	WorkingBox.  This  widget  is  created
	      (but left	unmanaged) even	if XmtNshowButton is False.

       XmtNicon
	      The  pixmap to display in	the upper left of the widget.  If None
	      is specified, the	WorkingBox will	use its	default	 icon-a	 clock
	      face.

       XmtNmessage
	      The  message  string to appear in	the WorkingBox.	Note that this
	      resource is a String, not	an XmString. It	 is  converted	inter-
	      nally  to	an XmString with the function XmtCreateXmString(), and
	      so may include the newline character to begin a  new  line,  and
	      may  include  the	 ``@f''	 escape	 sequence to change fonts. See
	      XmtCreateXmString() for more information.

       XmtNscaleLabel
	      The label	to appear to the left of  the  XmScale	child  of  the
	      WorkingBox, if XmtNshowScale is True.

       XmtNscaleMax
	      The  maximum  value  to be displayed by the XmScale child	of the
	      WorkingBox.

       XmtNscaleMin
	      The minimum value	to be displayed	by the XmScale	child  of  the
	      WorkingBox.

       XmtNscaleValue
	      The  value  to be	displayed by the XmScale child of the Working-
	      Box.

       XmtNscaleWidget
	      A	read-only resource that	can be queried to get a	handle to  the
	      XmScale  child  of  the WorkingBox. The XmScale child is created
	      (but left	unmanaged) even	if XmtNshowScale is False.

       XmtNshowButton
	      Specifies	whether	the XmPushButton child should  be  visible  in
	      the dialog.

       XmtNshowScale
	      Specifies	whether	the XmScale child should be visible in the di-
	      alog.

       CALLBACKS
       The WorkingBox widget defines no	callback list resources.

       TRANSLATIONS
       The WorkingBox widget defines no	new translations or actions.

SEE ALSO
       Chapter 31, Busy	States and Background Work,
       XmtCreateWorkingBox(), XmtCreateWorkingDialog(),
       XmtDisplayBusyCursor(), XmtDisplayDefaultCursor(),
       XmtDisplayWorkingDialog(), XmtHideWorkingDialog(),
       XmtWaitUntilMapped(), XmtWorkingBoxHandleEvents(),
       XmtWorkingBoxSetScaleValue().

Xmt				  Motif	Tools		      XmtWorkingBox(3)

NAME | SYNOPSIS | DESCRIPTION | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=XmtWorkingBox&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help