Functional specification
35
CDE/Motif PST
CDEnext
SYNOPSIS
#include <X11/extensions/Print.h>
void XpStartPage (
Display
*display
,
Window
window,
Bool
exposures
)
void XpEndPage (
Display
*display
)
void XpCancelPage (
Display
*display
)
ARGUMENTS
display
Specifies a pointer to the
Display
structure; returned from
XOpenDisplay
.
window
Specifies the window ID (a top level print window).
exposures
Boolean that specifies if exposure events should be generated per the below
discussion.
RETURN VALUE
None.
DESCRIPTION
XpStartPage
signals the beginning of a new print page, with
window
serving as the drawable
representing the page.
window
is required to be a top level window, else a
BadWindow
is generated. No
generation of document data will occur for rendering operations against
window
or its inferiors prior to
XpStartPage
or after
XpEndPage
.
XpStartPage
causes
window
to be resized to the size of the media selected - the actual "printable area"
may be smaller than the media size (see
XpGetPageDimensions
). Then
XpStartPage
causes the
windows in the
window
hierarchy to be cleared to their background with the same constraints as
XClearArea(display
,
window
,
0
,
0
,
0
,
0
,
exposures
)
, and exposure events to be generated for
each window if
exposures
if
True
and the client has elected to receive
Expose
events using
XSelectInput
.
Within the
XpStartPage
and
XpEndPage
sequence, attempts to resize, move or unmap
window
will
yield undefined results. Attempts to resize or move inferiors of
window
will be done with the same
contraits as
ConfigureNotify
, except that the contents of any configured window may be lost; an
Expose
event will be generated if a window's contents are lost.
XpEndPage
signals the end of a print page. All resulting page data is assembled and combined with data
previously sent by
XpPutDocumentData
.