formatcontinuehook
formatcontinuehook
Function prototype:
hook (pageno, doc)
Synopsis
Use with:
add_hook(hookname, func[, prepend])
remove_hook(hookname, func)
where hookname is formatcontinuehook.
This hook is called after formatting has completed, but before print processing or previewing is initiated. It allows you to modify the document and request additional formatting passes.
|
|
This hook function should not use the preview, format, or print commands.
|
Arguments
• pageno is the ordinal page number of the last page formatted.
• doc is the document being formatted.
Return Values
This hook function should return one of the following values:
• 0 — no more formatting is necessary; continue with normal post-format processing (e.g. initiate printing, update preview window)
• 1 — perform one additional formatting pass (after which this hook will be called again)
• 2 — perform as many additional formatting passes as necessary for final output (after which this hook will be called again)
• 3 — perform additional formatting passes using the
-onepass|allpasses modifier on the original
formatting command to determine how many to do (after which this hook will be called again)
The output of the additional passes will reflect any changes made to the document by the hook function.
Related Topics
