18
December 15, 1997
X Print Service Extension Library
18
X Print Service Extension Library
Release 6.4
X Version 11
XPBadSequence
The function was not called in the proper order with respect to the other X Print
Service Extension calls (for example,
XpGetDocumentData prior to XpStartJob).
2.2.7 Starting, Ending, and Canceling Pages
Use
XpStartPage to indicate the beginning of a print page.
void XpStartPage (display, window)
Display *display;
Window window;
display
Specifies a pointer to the Display structure; returned from XOpenDisplay.
window
Specifies the window ID.
XpStartPage signals the beginning of a new print page, with window serving as the drawable representing the
page. window is required to be a descendant of the root window of the current print context window, else a
BadWindow is generated. No generation of document data will occur for rendering operations against window
or its inferiors prior to
XpStartPage.
XpStartPage causes window to be mapped. See XpGetPageDimensions and XResizeWindow for details on resiz-
ing window to the size of the media selected prior to calling
XpStartPage. Within the XpStartPage and
XpEndPage sequence, attempts to resize, move or unmap window will yield undefined results. To resize or
move inferiors of window the standard semantics of ConfigureWindow apply, except that the contents of any
configured window may be discarded. An
Expose event will be generated if a window's contents are dis-
carded.
All changes to the
XPPageAttr attribute pool (see XpSetAttributes) must be made prior to calling XpStartPage,
after which an
XPBadSequence error will be generated if changes are attempted, until XpEndPage is called.
For clients selecting
XPPrintMask (see XpSelectInput), the event XPPrintNotify will be generated with its detail
field set to
XPStartPageNotify when the X Print Server has completed XpStartPage. If the event Expose is also
selected for (see
XSelectInput), the exposure events will be generated prior to XPPrintNotify.
The client need not wait for
XPStartPageNotify prior to calling any other X rendering routines.
XpStartPage can generate one of the following errors:
XPBadContext
A valid print context-id has not been set prior to making this call.
XPBadSequence
The function was not called in the proper order with respect to the other X Print
Service Extension calls; for example,
XpStartPage was called before XpStartJob or
was called for a type XPDocRaw document.
BadWindow
The value specified for window is not valid.
Use
XpEndPage to indicate the end of a print page.
void XpEndPage (display)
Display *display;
display
Specifies a pointer to the Display structure; returned from XOpenDisplay.
XpEndPage signals the end of a print page, and causes window to be unmapped. All resulting page data is
assembled and combined with data previously sent by
XpPutDocumentData. No generation of document data
will occur for rendering operations to the corresponding windows after
XpEndPage is called.
For clients selecting
XPPrintMask (see XpSelectInput), the event XPPrintNotify will be generated with its detail
field set to
XPEndPageNotify when the X Print Server has completed XpEndPage.
XpEndPage can generate an XPBadSequence error.