class HT_Document_Info
HT_Document_Info distinguishes between individual
pages within a document. For example, a printer will need to
know the document name, page name, and copy number in order to collate
when the same page is sent down more than once for different copy.
Four boolean flags to start/end the document
and page allow the application to signal to the Heidi renderer stack if
the application is handling the start/end calls. HT_Document_Info
addresses the problem that in MFC applications, these start/end
calls are taken care of by default; whereas, in non-MFC applications the
Heidi renderer stack needs to be prompted to provide such a service.
HT_Document_Info is an optional parameter in
begin_picture:
Void begin_picture (HT_Document_Info * in)
See Also
begin_picture,
"Life
Cycle of a Driver" section of chapter 2, "Heidi Architecture, Introduction"
Access methods
copy_number
Determines to which copy the current page belongs.
document_name, set_document_name
The name of the print job.
end_document, set_end_document
Allows the driver to take care of the end document call.
end_page, set_end_page
Allows the driver to take care of the end page call.
page_name, set_page_name
The individual page name.
start_document, set_start_document
Allows the driver to take care of the start document
call.
start_page, set_start_page
Allows the driver to take care of the start page call.
HT_Document_Info::copy_number
Purpose
Determines to which copy the current page belongs.
Synopsis
copy_number (void) const
copy_number (int in)
Details
.
HT_Document_Info::document_name,
set_document_name
Purpose
The name of the print job.
Synopsis
document_name (void) const
set_document_name (HT_String const & in)
Details
.
HT_Document_Info::end_document,
set_end_document
Purpose
Allows the driver to take care of the end document call.
Synopsis
end_document (void) const
set_end_document (HT_Boolean in)
Details
.
HT_Document_Info::end_page,
set_end_page
Purpose
Allows the driver to take care of the end page call.
Synopsis
end_page (void) const
set_end_page (HT_Boolean in)
Details
.
HT_Document_Info::page_name,
set_page_name
Purpose
The individual page name.
Synopsis
page_name (void) const
set_page_name (HT_String const & in)
Details
.
HT_Document_Info::start_document,
set_start_document
Purpose
Allows the driver to take care of the start document
call.
Synopsis
start_document (void) const
set_start_document (HT_Boolean in)
Details
.
HT_Document_Info::start_page,
set_start_page
Purpose
Allows the driver to take care of the start page call.
Synopsis
start_page (void) const
set_start_page (HT_Boolean in)
Details