DECwindows Extensions to Motif

Document revision date: 10 November 2000

DECwindows Extensions to Motif

Contents

Index

typedef struct { int reason; XEvent *event; } XmAnyCallbackStruct;

Callback Field Descriptions

reason
An integer set to the callback reason. See the Callback Reasons section for the values that are valid for this widget.
event
A pointer to the X event structure describing the event that generated this callback.

Callback Reasons

XmCR_MAP
The help window was just mapped.
XmCR_UNMAP
The help window was just unmapped.

Description

The DXmCreateHelpDialog routine creates a help widget that includes its own dialog box. The help widget is a modeless widget that enables the application to display appropriate user assistance information in response to a user request. When the user requests help, the help widget displays an initial help topic, then gives the user the ability to view additional help topics.
The DXmNfirstTopic resource allows the application to provide context-sensitive help by selecting a specific topic based on implicit or explicit cues from the user.
After the widget has been created, you can change the help topic by specifying a new DXmNfirstTopic (using the Intrinsic routine XtSetValues), and then managing the widget (using the Intrinsic routine XtManageChild) to display the help window. (See the X Window System Toolkit manual for more information about using the Intrinsic routines.)
When the user exits from a help session, the widget is automatically unmanaged.
See the DECwindows Motif Guide to Application Programming for a complete description of the help widget.

Geometry Management The help widget does not support children. Resizing The help widget sizes itself at creation, based on XmNrows and XmNcols.

DXmCreatePrintBox

Creates the print widget without a dialog box.

Widget Class Hierarchy

Core Resource Set
\
Composite Resource Set
\
Constraint Resource Set
\
XmManager Resource Set
\
XmBulletinBoard Resource Set
\
DXmPrintBox Resource Set

Format

Widget DXmCreatePrintBox(parent, name, arglist, argcount) Widget parent; char *name; Arglist arglist; int argcount;

Return Value

The identifier (widget ID) of the created print widget.

Arguments

parent
The identifier (widget ID) of the parent widget.
name
The name of the created widget.
arglist
The application argument list.
argcount
An integer that represents the number of arguments in the application argument list.

Description

The DXmCreatePrintBox routine uses the same arguments and resources as the DXmCreatePrintDialog routine to create a print widget, but does not include a dialog box. Refer to the DXmCreatePrintDialog routine for a complete description.

DXmCreatePrintDialog

Creates the print widget with a dialog box.

Widget Class Hierarchy

Core Resource Set
\
Composite Resource Set
\
Constraint Resource Set
\
XmManager Resource Set
\
XmBulletinBoard Resource Set
\
DXmPrintDialog Resource Set

Format

Widget DXmCreatePrintDialog(parent, name, arglist, argcount) Widget parent; char *name; Arglist arglist; int argcount;

Resource Information You can set the following widget-specific resources in the arglist:

Boolean DXmNautoPagination; XmString DXmNdefaultPrinter; Boolean DXmNdeleteFile; Boolean DXmNdoubleSpacing; int DXmNfileBurstSheet; int DXmNfileEndSheet; int DXmNfileNameCount; XmStringTable DXmNfileNameList; int DXmNfileStartSheet; Boolean DXmNheader; Boolean DXmNholdJob; int DXmNinputTray; XmString DXmNjobName; XmString DXmNlayupDefinition; int DXmNmessageLog; Boolean DXmNnotify; int DXmNnumberCopies; int DXmNnumberUp; XmString DXmNoperatorMessage; XmString DXmNoptionsDialogTitle; int DXmNorientation; int DXmNoutputTray; XmString DXmNpageRangeFrom; XmString DXmNpageRangeTo; int DXmNpageSize; Boolean DXmNpassAll; XmString DXmNprintAfter; int DXmNprinterCount; XmString DXmNprinterChoice; XmString DXmNprinterFormChoice; XmStringTable DXmNprinterFormList; int DXmNprinterFormCount; XmStringTable DXmNprinterList; XmString DXmNprintFormatChoice; int DXmNprintFormatCount; XmStringTable DXmNprintFormatList; int DXmNpriority; XmString DXmNsetup; int DXmNsheetCount; int DXmNsheetSize; int DXmNsides; XmString DXmNstartSheetComment; unsigned long DXmNsuppressOptionsMask; Boolean DXmNunmanageOnCancel; Boolean DXmNunmanageOnOk; XtCallbackList XmNcancelCallback; XtCallbackList XmNokCallback;

Return Value

The identifier (widget ID) of the created print widget.

Arguments

parent
The identifier (widget ID) of the parent widget.
name
The name of the created widget.
arglist
The application argument list.
argcount
An integer that represents the number of arguments in the application argument list.

Resources

DXmNautoPagination
A Boolean value that, when True, indicates that autopagination (formatting the output into pages based on length or line count) is turned on. When False, autopagination is turned off. By default, the value of this resource changes when the user switches print formats. The default settings for the print formats are as follows:

Print Format Default

Default ¹ False

Text (ANSI Level 0) True

Line Printer (ANSI Level 1) True

Terminal True

ANSI2 (ANSI Level 2) False

ANSI (ANSI Level 3) False

PostScript False

ReGIS False

TEK (Tektronix) False

DDIF False

¹No data type specification is output.

Access is CSG.

DXmNdefaultPrinter

An XmString that allows you to specify a default printer. If you do not specify a default printer, SYS$PRINT is the default choice on OpenVMS systems. The PRINTER environment variable determines the default on UNIX systems. For Windows NT systems, LPT1: is the default. Access is CSG.

DXmNdeleteFile

A Boolean value that controls whether the file is deleted after it is printed. When True, the file is deleted. When False, the file is not deleted. The default is False. The user must have delete access to the file to delete it. Access is CSG.

DXmNdoubleSpacing

A Boolean value that controls the state of double-spacing. When True, double-spacing is turned on. When False, double-spacing is turned off. The default is False. Access is CSG.

DXmNfileBurstSheet

An integer value that allows you to control whether there will be a File Burst Sheet for your print job and how frequently it appears. The possible values are as follows.

Value	Description
DXmFILE_SHEET_DEFAULT	Indicates that you want the default for the queue on which the job is being printed.
DXmFILE_SHEET_NONE	Indicates that you do not want a burst page.
DXmFILE_SHEET_ONE	Indicates that you want only a single burst page that will precede the first file printed.
DXmFILE_SHEET_ALL	Indicates that you want the burst page to be printed before every file in the print job.

The default is DXmFILE_SHEET_DEFAULT, or 0. Access is CSG.

DXmNfileEndSheet

An integer value that allows you to control whether there will be a File End Sheet for your print job and how frequently it is printed. The possible values are as follows:

Value	Description
DXmFILE_SHEET_DEFAULT	Indicates that you want the default for the queue on which the job is being printed.
DXmFILE_SHEET_NONE	Indicates that you do not want a File End Sheet.
DXmFILE_SHEET_ONE	Indicates that you want only a single File End Sheet to follow the last file printed.
DXmFILE_SHEET_ALL	Indicates that you want the File End Sheet to be printed after every file in the print job.

The default is DXmFILE_SHEET_DEFAULT, or 0. Access is CSG.

DXmNfileNameCount

The number of files specified in the DXmNfileNameList resource, expressed as an integer value. The default is 0. Access is CSG.

DXmNfileNameList

An XmStringTable that enables the print widget to use the files specified by this resource to make assumptions about the print format of the files to be printed. If you set the DXmNfileNameList resource, you must also set the value of the DXmNfileNameCount resource. The default is Null. Access is CSG.

DXmNfileStartSheet

An integer value that allows you to control whether there will be a File Start Sheet for your print job and how frequently it is printed. The possible values are as follows:

Value	Description
DXmFILE_SHEET_DEFAULT	Indicates that you want the default for the queue on which the job is being printed.
DXmFILE_SHEET_NONE	Indicates that you do not want a File Start Sheet.
DXmFILE_SHEET_ONE	Indicates that you want only a single File Start Sheet that will precede the first file.
DXmFILE_SHEET_ALL	Indicates that you want the File Start Sheet to be printed before every file in the print job.

The default is DXmFILE_SHEET_DEFAULT, or 0. Access is CSG.

DXmNheader

A Boolean value that controls whether to print the header. When True, the header is printed. When False, the header is not printed. The default is False. Access is CSG.

DXmNholdJob

A Boolean value that controls whether the print job will finish without further manual intervention. If this resource is True, the print job is held in the print queue servicing the printer until it is manually released by queue management operations. The default is False. Access is CSG.

DXmNinputTray

An integer value that allows you to specify the input tray holding the medium to be used for the print job. The possible values for DXmNinputTray are as follows:

Value	Description
DXmINPUT_TRAY_DEFAULT	The default input tray is that which is specified for the queue.
DXmINPUT_TRAY_TOP	The top input tray is the source of the medium on which to print.
DXmINPUT_TRAY_MIDDLE	The middle input tray is the source of the medium on which to print.
DXmINPUT_TRAY_BOTTOM	The bottom input tray is the source of the medium on which to print.

The default is DXmINPUT_TRAY_DEFAULT, or 0. Access is CSG.

DXmNjobName

A pointer to an XmString that identifies the print job name. If no job name is specified, the job name is derived from the name of the first file being printed. The default is Null. Access is CSG.

DXmNlayupDefinition

On OpenVMS systems, an XmString that allows you to enter a module name contained in the LPS$LAYUP:x.LUP library. This module, in conjunction with the DXmNnumberUp resource, controls how the image is deposited on the medium. The default is Null. Access is CSG.

DXmNmessageLog

An integer value that allows you to specify what is to be done with error messages that are created in the course of printing. The possible values for DXmNmessageLog are as follows:

Value	Description
DXmMESSAGE_LOG_DEFAULT	Accept whatever is specified for the print queue.
DXmMESSAGE_LOG_IGNORE	Nothing is done with the error messages.
DXmMESSAGE_LOG_PRINT	The error messages are written to the File End Sheet.
DXmMESSAGE_LOG_KEEP	The error messages are retained in a file.
DXmMESSAGE_LOG_KEEP_AND_PRINT	The error messages are written to the File End Sheet (or additional job error sheet) and are retained in a log file.

The default is DXmMESSAGE_LOG_DEFAULT, or 0. Access is CSG.

DXmNnotify

A Boolean value that determines whether the user is notified when the file is printed. When True, the user is notified. When False, the user is not notified. The default is True. Access is CSG.

DXmNnumberCopies

An integer value that determines the number of copies of the file to print. The allowable range is from 1 to 255 copies. The default is 0 (which means to use the system default). Access is CSG.

DXmNnumberUp

An integer value in the range of 0--100 that specifies how many logical images are to be printed on one side of a page. The default is 0 (one logical image, without any adjustments to how the image is deposited on the medium). Access is CSG.

DXmNoperatorMessage

An XmString that allows you to enter a text field to be displayed on the operator's console when the job first starts printing. DXmNoperatorMessage can be used to pass messages to the operator concerning the handling of the printed output. The default is Null. Access is CSG.

DXmNoptionsDialogTitle

Specifies the title for the secondary dialog box that lists additional print options. The default is "Print: Options". Access is CSG.

DXmNorientation

An integer value that determines the paper orientation (on printers that support this feature). The possible values for orientation are as follows:

Value	Description
DXmORIENTATION_DEFAULT	Allows you to accept the orientation that is defined for the print queue you have selected.
DXmORIENTATION_PORTRAIT	Allows you to force a portrait orientation to the resulting printout.
DXmORIENTATION_LANDSCAPE	Allows you to force a landscape orientation to the resulting printout.

The default is DXmORIENTATION_DEFAULT, or 0. Access is CSG.

DXmNoutputTray

An integer value that allows you to specify the output tray in which the medium is to be placed after the sheet is printed. The possible values for DXmNoutputTray are as follows:

Value	Description
DXmOUTPUT_TRAY_DEFAULT	The default output tray is that which is specified for the queue.
DXmOUTPUT_TRAY_TOP	Allows you to select the top output tray to receive the printed medium.
DXmOUTPUT_TRAY_SIDE	Allows you to select the side output tray to receive the printed medium.
DXmOUTPUT_TRAY_FACE_UP	Allows you to select the faceup output tray to receive the printed medium.
DXmOUTPUT_TRAY_UPPER	Allows you to select the upper output tray to receive the printed medium.
DXmOUTPUT_TRAY_LOWER	Allows you to select the lower output tray to receive the printed medium.

The default is DXmOUTPUT_TRAY_DEFAULT, or 0. Access is CSG.

DXmNpageRangeFrom

A pointer to an XmString that identifies the starting page of the file to print. The DXmNpageRangeFrom and DXmNpageRangeTo resources allow you to enter a range of pages to be printed if you chose not to print a file in its entirety. When using this resource, note the following:

If you want to start printing at the first page of the file, you may leave the DXmNpageRangeFrom resource blank (no value specified).
If you specify a value for the DXmNpageRangeTo resource, the DXmNpageRangeFrom resource must be less than or equal to that value.

The default is Null. Access is CSG.

DXmNpageRangeTo

A pointer to an XmString that identifies the last page of the file to print. The DXmNpageRangeFrom and DXmNpageRangeTo resources allow you to enter a range of pages to be printed if you chose not to print a file in its entirety.

The DXmNpageRangeTo resource may be left blank to print to the last page of the file. The default is Null. Access is CSG.

DXmNpageSize

An integer value that determines the logical (or virtual) size of the print image. The possible values for page size are as follows:

Value	Size in Inches	Size in MM
DXmSIZE_DEFAULT	Queue Default	Queue Default
DXmSIZE_LETTER	8.5 x 11	216 x 279
DXmSIZE_LEDGER	11 x 17	279 x 432
DXmSIZE_LEGAL	8.5 x 14	216 x 356
DXmSIZE_EXECUTIVE	7.5 x 10	191 x 254
DXmSIZE_A5	5.8 x 8.3	148 x 210
DXmSIZE_A4	8.3 x 11.7	210 x 297
DXmSIZE_A3	11.7 x 16.5	297 x 420
DXmSIZE_B5	7.2 x 10.1	176 x 250
DXmSIZE_B4	10.1 x 14.3	250 x 353
DXmSIZE_C4_ENVELOPE	9 x 12.8	229 x 324
DXmSIZE_C5_ENVELOPE	6.4 x 9	162 x 229
DXmSIZE_C56_ENVELOPE	4.3 x 8.7	110 x 220
DXmSIZE_10X13_ENVELOPE	10 x 13	254 x 330.2
DXmSIZE_9X12_ENVELOPE	9 x 12	228.6 x 304.8
DXmSIZE_BUSINESS_ENVELOPE	4.125 x 9.5	104.8 x 241.3

The default is DXmSIZE_DEFAULT. Access is CSG.

DXmNpassAll

A Boolean value that, when True, allows all control characters to be passed to the printer. By default, the value of this resource changes when the user switches print formats. The default settings for the print formats are as follows:

Print Format	Default
Default ¹	False
Text (ANSI Level 0)	False
Line Printer (ANSI Level 1)	False
Terminal	False
ANSI2 (ANSI Level 2)	True
ANSI (ANSI Level 3)	True
PostScript	False
ReGIS	False
TEK (Tektronix)	True
DDIF	True

¹No data type specification is output.

Access is CSG.

DXmNprintAfter

An XmString that allows you to enter a time and date when this print job first becomes eligible to be scheduled for printing. The XmString for the time and date must be the standard OpenVMS format DD-MMM-YYYY HH:MM, for example: 23-JUL-1991 17:30. For UNIX systems, see the at(1) reference page for information about date formats. The format for Windows NT is MM/DD/YY HH:MM[a|p], where a is for AM and p is for PM.

If this resource is not specified, the job becomes eligible for immediate print scheduling. The job also becomes eligible for immediate print scheduling if the user specifies this resource but specifies either nothing or "now" as the XmString. The default is "now". Access is CSG.

DXmNprinterChoice

An XmString that specifies the printer to use for the current print format. Applications usually use this resource to store information about a user's printer preference.

If you set this resource, the XmString must exactly match one of the print widget's supported printers, including the character set. The recommended approach is to not specify this resource when the print widget is first managed. Then, once the user has selected a print format, call the XtGetValues routine to obtain the value and then XtSetArg to set DXmNprinterChoice.

The print widget sets this resource as follows:

If the user selects a new print format, the printer queue box might be repopulated (assuming the user has set up the print queue logicals).
If the user has chosen this print format before and has already chosen a printer for this format, the print widget identifies this printer as the DXmNprinterChoice resource. The printer is automatically selected, regardless of the previous queue choice.
If the user has not previously selected this print format, the print widget determines whether there is a printer that matches the one defined by DXmNdefaultPrinter. If that printer is available, the print widget selects it; otherwise the print widget selects the first printer in the list.

The default is Null. Access is CSG.

DXmNprinterCount

The number of printers specified in the DXmNprinterList resource, expressed as an integer. If your application requires the value of this resource, call the XtGetValues routine to obtain the value.

You cannot set a value for this resource. (Access is G.) The default is 0.

DXmNprinterFormChoice

An XmString that specifies the printer form to use as the default. Use this resource when you want your application to record a user's printer preference.

Note that if you set this resource, the XmString must exactly match one of the operating system's supported printer forms. (Use the DXmCvtOSToCS routine to convert the string to an XmString.) Digital recommends that you do not specify this resource when the print widget is first managed. Instead, after the user has selected a printer form, call the Intrinsic routines XtGetValues to obtain the value and XtSetArg to set DXmNprinterFormChoice. The default is Null. Access is CSG.

DXmNprinterFormList

An XmStringTable list of the available printer forms. If your application requires the value of this resource, call the XtGetValues routine to obtain the value.

You cannot set a value for this resource. (Access is G.) The default is Null.

DXmNprinterFormCount

The number of printer forms specified in the DXmNprinterFormList resource, expressed as an integer value. If your application requires the value of this resource, call the XtGetValues routine to obtain the value.

You cannot set a value for this resource. (Access is G.) The default is 0.

DXmNprinterList

An XmStringTable that determines the names to appear in the Printer list box. If your application requires the value of this resource, call the XtGetValues routine to obtain the value.

Contents

Index

privacy and legal statement

5635PRO_005.HTML