FreeBSD Manual Pages
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 pre- vents normal processing of events. It provides feedback to the user that the application is busy and that she should not try to interact with it normally. The WorkingBox is designed to provide more sophisticated ``work- ing'' dialogs than is possible with the Motif XmCreateWorkingDialog() func- tion (which simply creates an XmMessageBox widget 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 Xm- Scale widget that can be used to provide feedback on the progress of what ever task the application is performing, and optionally displays an XmPush- Button widget that the user can use to abort the task. RESOURCES XmtWorkingBox inherits the resources of the XmBulletinBoard class, and de- fines 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 Working- Box, if XmtNshowButton is True. XmtNbuttonWidget A read-only resource that may be queried to get a handle to the Xm- PushButton 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 re- source is a String, not an XmString. It is converted internally to an XmString with the function XmtCreateXmString(), and so may in- clude 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 Working- Box, if XmtNshowScale is True. XmtNscaleMax The maximum value to be displayed by the XmScale child of the Work- ingBox. XmtNscaleMin The minimum value to be displayed by the XmScale child of the Work- ingBox. XmtNscaleValue The value to be displayed by the XmScale child of the WorkingBox. XmtNscaleWidget A read-only resource that can be queried to get a handle to the Xm- Scale 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 dialog. 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://man.freebsd.org/cgi/man.cgi?query=XmtWorkingBox&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>