Create a new GtkSource.PrintCompositor

Parameters:

Object properties

Create a new GtkSource.PrintCompositor

Parameters:

GtkSource.Buffer buffer Required (not null)

Returns:

GtkSource.PrintCompositor

Create a new GtkSource.PrintCompositor

Parameters:

GtkSource.View view Required (not null)

Returns:

GtkSource.PrintCompositor

Draw page page_nr for printing on the the Cairo context encapsuled in context. This method has been designed to be called in the handler of the GtkPrintOperation::draw_page signal as shown in the following example: // Signal handler for the GtkPrintOperation::draw_page signal static void draw_page (GtkPrintOperation *operation, GtkPrintContext *context, gint page_nr, gpointer user_data) { GtkSourcePrintCompositor *compositor; compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data); gtk_source_print_compositor_draw_page (compositor, context, page_nr); }

Parameters:

Gtk.PrintContext context Required (not null)

drawing the page for printing.

Number page_nr Required (not null)

Returns:

none

Returns the name of the font used to print the text body. The returned string must be freed with g_free(). text body.

Returns:

String

Gets the bottom margin in units of unit.

Parameters:

Gtk.Unit unit Required (not null)

Returns:

Number

Gets the GtkSourceBuffer associated with the compositor. The returned object reference is owned by the compositor object and should not be unreferenced.

Returns:

GtkSource.Buffer the GtkSourceBuffer associated with the compositor.

Returns the name of the font used to print the page footer. The returned string must be freed with g_free(). the page footer.

Returns:

String

Returns the name of the font used to print the page header. The returned string must be freed with g_free(). the page header.

Returns:

String

Determines whether the printed text will be highlighted according to the buffer rules. Note that highlighting will happen only if the buffer to print has highlighting activated.

Returns:

Boolean

Gets the left margin in units of unit.

Parameters:

Gtk.Unit unit Required (not null)

Returns:

Number

Returns the name of the font used to print line numbers on the left margin. The returned string must be freed with g_free(). line numbers on the left margin.

Returns:

String

Returns the number of pages in the document or -1 if the document has not been completely paginated. document has not been completely paginated.

Returns:

Number

Returns the current fraction of the document pagination that has been completed.

Returns:

Number

Determines if a footer is set to be printed for each page. A footer will be printed if this function returns TRUE and some format strings have been specified with gtk_source_print_compositor_set_footer_format().

Returns:

Boolean

Determines if a header is set to be printed for each page. A header will be printed if this function returns TRUE and some format strings have been specified with gtk_source_print_compositor_set_header_format().

Returns:

Boolean

Returns the interval used for line number printing. If the value is 0, no line numbers will be printed. The default value is 1 (i.e. numbers printed in all lines).

Returns:

Number

Gets the right margin in units of unit.

Parameters:

Gtk.Unit unit Required (not null)

Returns:

Number

Returns the width of tabulation in characters for printed text.

Returns:

Number

Gets the top margin in units of unit.

Parameters:

Gtk.Unit unit Required (not null)

Returns:

Number

Gets the line wrapping mode for the printed text.

Returns:

Gtk.WrapMode

Paginate the document associated with the compositor. In order to support non-blocking pagination, document is paginated in small chunks. Each time gtk_source_print_compositor_paginate() is invoked, a chunk of the document is paginated. To paginate the entire document, gtk_source_print_compositor_paginate() must be invoked multiple times. It returns TRUE if the document has been completely paginated, otherwise it returns FALSE. This method has been designed to be invoked in the handler of the GtkPrintOperation::paginate signal, as shown in the following example: // Signal handler for the GtkPrintOperation::paginate signal static gboolean paginate (GtkPrintOperation *operation, GtkPrintContext *context, gpointer user_data) { GtkSourcePrintCompositor *compositor; compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data); if (gtk_source_print_compositor_paginate (compositor, context)) { gint n_pages; n_pages = gtk_source_print_compositor_get_n_pages (compositor); gtk_print_operation_set_n_pages (operation, n_pages); return TRUE; } return FALSE; } If you don't need to do pagination in chunks, you can simply do it all in the GtkPrintOperation::begin-print handler, and set the number of pages from there, like in the following example: // Signal handler for the GtkPrintOperation::begin-print signal static void begin_print (GtkPrintOperation *operation, GtkPrintContext *context, gpointer user_data) { GtkSourcePrintCompositor *compositor; gint n_pages; compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data); while (!gtk_source_print_compositor_paginate (compositor, context)); n_pages = gtk_source_print_compositor_get_n_pages (compositor); gtk_print_operation_set_n_pages (operation, n_pages); }

Parameters:

Gtk.PrintContext context Required (not null)

are used by the the compositor to paginate the document.

Returns:

Boolean

Sets the default font for the printed text. string representation of a font description Pango can understand. (e.g. "Monospace 10"). See pango_font_description_from_string() for a description of the format of the string representation. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function.

Parameters:

String font_name Required (not null)

Returns:

none

Sets the bottom margin used by compositor.

Parameters:

Number margin Required (not null)

Gtk.Unit unit Required (not null)

Returns:

none

Sets the font for printing the page footer. If NULL is supplied, the default font (i.e. the one being used for the text) will be used instead. string representation of a font description Pango can understand. (e.g. "Monospace 10"). See pango_font_description_from_string() for a description of the format of the string representation. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function.

Parameters:

String font_name

the name of the font for the footer text, or NULL.

Returns:

none

Sets strftime like header format strings, to be printed on the left, center and right of the bottom of each page. The strings may include strftime(3) codes which will be expanded at print time. All strftime() codes are accepted, with the addition of N for the page number and Q for the page count. the footer from the document text. If NULL is given for any of the three arguments, that particular string will not be printed. For the footer to be printed, in addition to specifying format strings, you need to enable footer printing with gtk_source_print_compositor_set_print_footer(). This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function.

Parameters:

Boolean separator Required (not null)

String left

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

String center

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

String right

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

Returns:

none

Sets the font for printing the page header. If NULL is supplied, the default font (i.e. the one being used for the text) will be used instead. string representation of a font description Pango can understand. (e.g. "Monospace 10"). See pango_font_description_from_string() for a description of the format of the string representation. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function.

Parameters:

String font_name

the name of the font for header text, or NULL.

Returns:

none

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. All strftime() codes are accepted, with the addition of N for the page number and Q for the page count. 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 gtk_source_print_compositor_set_print_header(). This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function.

Parameters:

Boolean separator Required (not null)

String left

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

String center

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

String right

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

Returns:

none

Sets whether the printed text will be highlighted according to the buffer rules. Both color and font style are applied. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function.

Parameters:

Boolean highlight Required (not null)

Returns:

none

Sets the left margin used by compositor.

Parameters:

Number margin Required (not null)

Gtk.Unit unit Required (not null)

Returns:

none

Sets the font for printing line numbers on the left margin. If NULL is supplied, the default font (i.e. the one being used for the text) will be used instead. string representation of a font description Pango can understand. (e.g. "Monospace 10"). See pango_font_description_from_string() for a description of the format of the string representation. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function.

Parameters:

String font_name

the name of the font for line numbers, or NULL.

Returns:

none

Sets whether you want to print a footer in each page. The footer consists of three pieces of text and an optional line separator, configurable with gtk_source_print_compositor_set_footer_format(). Note that by default the footer format is unspecified, and if it's empty it will not be printed, regardless of this setting. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function.

Parameters:

Boolean print Required (not null)

Returns:

none

Sets whether you want to print a header in each page. The header consists of three pieces of text and an optional line separator, configurable with gtk_source_print_compositor_set_header_format(). Note that by default the header format is unspecified, and if it's empty it will not be printed, regardless of this setting. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function.

Parameters:

Boolean print Required (not null)

Returns:

none

Sets the interval for printed line numbers. If interval is 0 no numbers will be printed. If greater than 0, a number will be printed every interval lines (i.e. 1 will print all line numbers). Maximum accepted value for interval is 100. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function.

Parameters:

Number interval Required (not null)

Returns:

none

Sets the right margin used by compositor.

Parameters:

Number margin Required (not null)

Gtk.Unit unit Required (not null)

Returns:

none

Sets the width of tabulation in characters for printed text. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function.

Parameters:

Number width Required (not null)

Returns:

none

Sets the top margin used by compositor.

Parameters:

Number margin Required (not null)

Gtk.Unit unit Required (not null)

Returns:

none

Sets the line wrapping mode for the printed text. This function cannot be called anymore after the first call to the gtk_source_print_compositor_paginate() function.

Parameters:

Gtk.WrapMode wrap_mode Required (not null)

Returns:

none