set_header_format


Description:

[ Version ( since = "2.2" ) ]
public void set_header_format (bool separator, string? left, string? center, string? right)

Sets strftime like header format strings, to be printed on the left, center and right of the top of each page.

The strings may include strftime(3) codes which will be expanded at print time. A subset of strftime codes are accepted, see format for more details on the accepted format specifiers. Additionally the following format specifiers are accepted: - N: the page number - Q: the page count.

separator specifies if a solid line should be drawn to separate the header from the document text.

If null is given for any of the three arguments, that particular string will not be printed.

For the header to be printed, in addition to specifying format strings, you need to enable header printing with set_print_header.

This function cannot be called anymore after the first call to the paginate function.

Parameters:

this

a SourcePrintCompositor.

separator

true if you want a separator line to be printed.

left

a format string to print on the left of the header.

center

a format string to print on the center of the header.

right

a format string to print on the right of the header.