SYNOPSIS

      cc [ flag... ] file... -lXp [ library... ]

      #include <X11/extensions/Print.h>

void XpStartPage ( display, window )

      Display *display;

      Window window;
     

ARGUMENTS

display

Specifies a pointer to the Display structure; returned from XOpenDisplay.

window

Specifies the window ID.

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 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 resizing 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 discarded.

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.

DIAGNOSTICS

BadWindow

The value specified for window is not valid.

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.