Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xpstartdoc(3xp) [debian man page]

XpStartDoc(3Xp) 						 XPRINT FUNCTIONS						   XpStartDoc(3Xp)

NAME

       XpStartDoc -  Indicates the beginning of a print document.

SYNOPSIS

	     cc [ flag... ] file... -lXp [ library... ]
	     #include <X11/extensions/Print.h>

       void XpStartDoc ( display, type )
	     Display *display;
	     XPDocumentType type;

ARGUMENTS

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

       type   Specifies the type of document. It can be either XPDocRaw or XPDocNormal.

DESCRIPTION

       XpStartDoc signals the beginning of a new print document.

       If  type is XPDocRaw, then the client will provide all the data for the resulting document using XpPutDocumentData; the X Print Server will
       not write any data into the resulting document. Calling XpStartPage in a XPDocRaw document will generate an XPBadSequence error.  For  more
       information, see XpPutDocumentData.

       If  type  is  XPDocNormal, then the X Print Server will generate document data, and depending on the DDX driver, can incorporate additional
       data from XpPutDocumentData into the output. For more information, see XpPutDocumentData.

       All changes to the XPDocAttr attribute pool (see XpSetAttributes) must be made prior to calling XpStartDoc, after  which  an  XPBadSequence
       will be generated if changes are attempted, until XpEndDoc is called.

       The  application  is  not required to call XpStartDoc and XpEndDoc in the process of printing. The "document" delineation may not be useful
       from the application's or spooler's perspective, hence is optional. If XpStartPage is called immediately after XpStartJob then a  synthetic
       XpStartDoc  with  XPDocNormal  will  be assumed by the X Print Server prior to XpStartPage (i.e. the XPStartDocNotify and XPStartPageNotify
       events will have the same sequence number). Likewise, if XpEndJob is called immediately after XpEndPage then a synthetic XpEndDoc  will	be
       assumed by the X Print Server prior to XpEndJob (i.e., the XPEndDocNotify and XPEndJobNotify events will have the same sequence number).

       For clients selecting XPPrintMask (see XpSelectInput), the event XPPrintNotify will be generated with its detail field set to XPStartDocNo-
       tify.

STRUCTURES

       The XPDocumentType values are defined in <X11/extensions/Print.h>:

	   #define   XPDocNormal     1	   /* Doc data handled by Xserver*/
	   #define   XPDocRaw	     2	   /* Doc data passed through Xserver*/

DIAGNOSTICS

       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 (example, XpEndDoc
		      prior to XpStartDoc).

       BadValue       The value specified for type is not valid.

FILES

       <X11/extensions/Print.h>
SEE ALSO

       XpEndDoc(3Xp),  XpEndJob(3Xp),  XpEndPage(3Xp), XpPutDocumentData(3Xp), XpSelectInput(3Xp), XpSetAttributes(3Xp), XpStartJob(3Xp), XpStart-
       Page(3Xp)

X Version 11							    libXp 1.0.0 						   XpStartDoc(3Xp)

Check Out this Related Man Page

XpStartPage(3Xp)						 XPRINT FUNCTIONS						  XpStartPage(3Xp)

NAME

       XpStartPage - Indicates the beginning of a print page.

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 XPStart-
       PageNotify 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.

SEE ALSO

       XpEndPage(3Xp), XpGetPageDimensions(3Xp), XpSelectInput(3Xp), XpSetAttributes(3Xp)

X Version 11							    libXp 1.0.0 						  XpStartPage(3Xp)
Man Page