DXmPrintWgtAugmentList(3X) — Subroutines

NAME

DXmPrintWgtAugmentList − Defines additional print formats and lets you add new options to the print widget option menus.

SYNOPSIS

unsigned long int DXmPrintWgtAugmentList(
        Widget pw,
        int list,
        XtPointer data );

PARAMETERS

pwThe print widget.

listThe print formats or options, indicated by the following values:

Value	Description
DXmFILE_BURST_SHEET	Specifies the availability and frequency of printed File Burst Sheets.
DXmFILE_END_SHEET	Specifies the availability and frequency of printed File End Sheets.
DXmFILE_START_SHEET	Specifies the availability and frequency of printed File Start Sheets.
DXmINPUT_TRAY	Specifies the input tray holding the sheet to be used for the print job.
DXmMESSAGE_LOG	Specifies what is to be done with error messages generated during the print operation.
DXmOUTPUT_TRAY	Specifies the output tray in which the sheet is to be placed.
DXmPAGE_SIZE	Specifies the size of the print image.
DXmPRINT_FORMAT	Specifies the print format.
DXmSHEET_SIZE	Specifies the size of the sheet.
DXmSIDES	Specifies how many sides of the sheet will be printed.

dataOne of the following data structures:

•DXmPrintFormatStruct, which has the following structure:

typedef struct _DXmPrintFormatStruct
{
     XmString   ui_string;
     XmString   os_string;
     XmString   var_string;
} DXmPrintFormatStruct;

ui_string
Specifies the label displayed in the user interface.

os_string
Specifies a string that identifies the print format to the operating system.

var_string
Specifies the UNIX environment variable that identifies the print format.

•DXmPrintOptionMenuStruct, which has the following structure:

typedef struct _DXmPrintOptionMenuStruct {
XmString ui_string;
XmString os_string;
} DXmPrintOptionMenuStruct;

ui_string
Specifies the label displayed in the user interface.

os_string
Specifies a string that identifies the print option for the operating system.

DESCRIPTION

The DXmPrintWgtAugmentList routine defines additional print formats and lets you add new options to the print widget option menus. Note that the return value (an integer) is not required when adding print formats. However, the Intrinsics routines XtGetValues and XtSetValues use that integer when subsequent calls are made on the option menus.

RETURN VALUES

An integer that represents either the number of print formats known to the print widget or the identifier of a new option added to the print widget option menu, depending on the operation performed. A Null return indicates that the addition of a print format or option was unsuccessful.

Museum