GtkSourcePrintJob

typedef struct _GtkSourcePrintJob GtkSourcePrintJob;

gtk_source_print_job_new ()

GtkSourcePrintJob* gtk_source_print_job_new (GnomePrintConfig *config);

Creates a new print job object, initially setting the print configuration.

gtk_source_print_job_new_with_buffer ()

GtkSourcePrintJob* gtk_source_print_job_new_with_buffer
                                            (GnomePrintConfig *config,
                                             GtkSourceBuffer *buffer);

Creates a new print job to print buffer.

gtk_source_print_job_set_config ()

void        gtk_source_print_job_set_config (GtkSourcePrintJob *job,
                                             GnomePrintConfig *config);

Sets the print configuration for the job. If you don't set a configuration object for the print job, when needed one will be created with gnome_print_config_default().

gtk_source_print_job_get_config ()

GnomePrintConfig* gtk_source_print_job_get_config
                                            (GtkSourcePrintJob *job);

Gets the current GnomePrintConfig the print job will use. If not previously set, this will create a default configuration and return it. The returned object reference is owned by the print job.

gtk_source_print_job_set_buffer ()

void        gtk_source_print_job_set_buffer (GtkSourcePrintJob *job,
                                             GtkSourceBuffer *buffer);

Sets the GtkSourceBuffer the print job will print. You need to specify a buffer to print, either by the use of this function or by creating the print job with gtk_source_print_job_new_with_buffer().

gtk_source_print_job_get_buffer ()

GtkSourceBuffer* gtk_source_print_job_get_buffer
                                            (GtkSourcePrintJob *job);

Gets the GtkSourceBuffer the print job would print. The returned object reference (if non NULL) is owned by the job object and should not be unreferenced.

gtk_source_print_job_setup_from_view ()

void        gtk_source_print_job_setup_from_view
                                            (GtkSourcePrintJob *job,
                                             GtkSourceView *view);

Convenience function to set several configuration options at once, so that the printed output matches view. The options set are buffer (if not set already), tabs width, highlighting, wrap mode and default font.

gtk_source_print_job_set_tabs_width ()

void        gtk_source_print_job_set_tabs_width
                                            (GtkSourcePrintJob *job,
                                             guint tabs_width);

Sets the width (in equivalent spaces) of tabulations for the printed text. The width in printing units will be calculated as the width of a string containing tabs_width spaces of the default font. Tabulation stops are set for the full width of printed text.

gtk_source_print_job_get_tabs_width ()

guint       gtk_source_print_job_get_tabs_width
                                            (GtkSourcePrintJob *job);

Determines the configured width (in equivalent spaces) of tabulations. The default value is 8.

gtk_source_print_job_set_wrap_mode ()

void        gtk_source_print_job_set_wrap_mode
                                            (GtkSourcePrintJob *job,
                                             GtkWrapMode wrap);

Sets the wrap mode for lines of text larger than the printable width. See GtkWrapMode for a definition of the possible values.

gtk_source_print_job_get_wrap_mode ()

GtkWrapMode gtk_source_print_job_get_wrap_mode
                                            (GtkSourcePrintJob *job);

Determines the wrapping style for text lines wider than the printable width. The default is no wrapping.

gtk_source_print_job_set_highlight ()

void        gtk_source_print_job_set_highlight
                                            (GtkSourcePrintJob *job,
                                             gboolean highlight);

Sets whether the printed text will be highlighted according to the buffer rules. Both color and font style are applied.

gtk_source_print_job_get_highlight ()

gboolean    gtk_source_print_job_get_highlight
                                            (GtkSourcePrintJob *job);

Determines if the job is configured to print the text highlighted with colors and font styles. Note that highlighting will happen only if the buffer to print has highlighting activated.

gtk_source_print_job_set_font_desc ()

void        gtk_source_print_job_set_font_desc
                                            (GtkSourcePrintJob *job,
                                             PangoFontDescription *desc);

Sets the default font for the printed text.

gtk_source_print_job_set_font ()

void        gtk_source_print_job_set_font   (GtkSourcePrintJob *job,
                                             const gchar *font_name);

Sets the default font for the printed text. font_name should be a full font name GnomePrint can understand (e.g. "Monospace Regular 10.0").

Note that font_name is a GnomeFont name not a Pango font description string. This function is deprecated since GnomeFont is no longer used when implementing printing for GtkSourceView; you should use gtk_source_print_job_set_font_desc() instead.

gtk_source_print_job_get_font_desc ()

PangoFontDescription* gtk_source_print_job_get_font_desc
                                            (GtkSourcePrintJob *job);

Determines the default font to be used for the printed text. The returned string is of the form "Fontfamily Style Size", for example "Monospace Regular 10.0". The returned value should be freed when no longer needed.

gtk_source_print_job_get_font ()

gchar*      gtk_source_print_job_get_font   (GtkSourcePrintJob *job);

Determines the default font to be used for the printed text. The returned string is of the form "Fontfamily Style Size", for example "Monospace Regular 10.0". The returned value should be freed when no longer needed.

Note that the result is a GnomeFont name not a Pango font description string. This function is deprecated since GnomeFont is no longer used when implementing printing for GtkSourceView; you should use gtk_source_print_job_get_font_desc() instead.

gtk_source_print_job_set_numbers_font_desc ()

void        gtk_source_print_job_set_numbers_font_desc
                                            (GtkSourcePrintJob *job,
                                             PangoFontDescription *desc);

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.

gtk_source_print_job_set_numbers_font ()

void        gtk_source_print_job_set_numbers_font
                                            (GtkSourcePrintJob *job,
                                             const gchar *font_name);

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.

Note that font_name is a GnomeFont name not a Pango font description string. This function is deprecated since GnomeFont is no longer used when implementing printing for GtkSourceView; you should use gtk_source_print_job_set_numbers_font_desc() instead.

gtk_source_print_job_get_numbers_font_desc ()

PangoFontDescription* gtk_source_print_job_get_numbers_font_desc
                                            (GtkSourcePrintJob *job);

Determines the font to be used for the line numbers. This function might return NULL if a specific font for numbers has not been set.

gtk_source_print_job_get_numbers_font ()

gchar*      gtk_source_print_job_get_numbers_font
                                            (GtkSourcePrintJob *job);

Determines the font to be used for the line numbers. The returned string is of the form "Fontfamily Style Size", for example "Monospace Regular 10.0". The returned value should be freed when no longer needed. This function might return NULL if a specific font for numbers has not been set.

Note that the result is a GnomeFont name not a Pango font description string. This function is deprecated since GnomeFont is no longer used when implementing printing for GtkSourceView; you should use gtk_source_print_job_get_numbers_font_desc() instead.

gtk_source_print_job_set_print_numbers ()

void        gtk_source_print_job_set_print_numbers
                                            (GtkSourcePrintJob *job,
                                             guint interval);

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).

gtk_source_print_job_get_print_numbers ()

guint       gtk_source_print_job_get_print_numbers
                                            (GtkSourcePrintJob *job);

Determines 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).

gtk_source_print_job_set_text_margins ()

void        gtk_source_print_job_set_text_margins
                                            (GtkSourcePrintJob *job,
                                             gdouble top,
                                             gdouble bottom,
                                             gdouble left,
                                             gdouble right);

Sets the four user margins for the print job. These margins are in addition to the document margins provided in the GnomePrintConfig and will not be used for headers, footers or line numbers (those are calculated separatedly). You can print in the space allocated by these margins by connecting to the "begin_page" signal. The space is around the printed text, and inside the margins specified in the GnomePrintConfig.

The margin numbers are given in device units. If any of the given values is less than 0, that particular margin is not altered by this function.

gtk_source_print_job_get_text_margins ()

void        gtk_source_print_job_get_text_margins
                                            (GtkSourcePrintJob *job,
                                             gdouble *top,
                                             gdouble *bottom,
                                             gdouble *left,
                                             gdouble *right);

Determines the user set margins for the job. This function retrieves the values previously set by gtk_source_print_job_set_text_margins(). The default for all four margins is 0. Any of the pointers can be NULL if you want to ignore that value.

gtk_source_print_job_print ()

GnomePrintJob* gtk_source_print_job_print   (GtkSourcePrintJob *job);

Produces a GnomePrintJob with the printed document. The whole contents of the configured GtkSourceBuffer are printed. The returned job is already closed and ready to be previewed (using gnome_print_job_preview_new()) or printed directly. The caller of this function owns a reference to the returned object, so job can be destroyed and the output will still be valid, or the document can be printed again with different settings.

gtk_source_print_job_print_range ()

GnomePrintJob* gtk_source_print_job_print_range
                                            (GtkSourcePrintJob *job,
                                             const GtkTextIter *start,
                                             const GtkTextIter *end);

Similar to gtk_source_print_job_print(), except you can specify a range of text to print. The passed GtkTextIter values might be out of order.

gtk_source_print_job_print_range_async ()

gboolean    gtk_source_print_job_print_range_async
                                            (GtkSourcePrintJob *job,
                                             const GtkTextIter *start,
                                             const GtkTextIter *end);

Starts to print job asynchronously. This function will ready the job for printing and install an idle handler that will render one page at a time.

This function will not return immediatly, as only page rendering is done asynchronously. Text retrieval and paginating happens within this function. Also, if highlighting is enabled, the whole buffer needs to be highlighted first.

To get notification when the job has finished, you must connect to the "finished" signal. After this signal is emitted you can retrieve the resulting GnomePrintJob with gtk_source_print_job_get_print_job(). You may cancel the job with gtk_source_print_job_cancel().

gtk_source_print_job_cancel ()

void        gtk_source_print_job_cancel     (GtkSourcePrintJob *job);

Cancels an asynchronous printing operation. This will remove any pending print idle handler and unref the current GnomePrintJob.

Note that if you got a reference to the job's GnomePrintJob (using gtk_source_print_job_get_print_job()) it will not be destroyed (since you hold a reference to it), but it will not be closed either. If you wish to show or print the partially printed document you need to close it yourself.

This function has no effect when called from a non-asynchronous print operation.

gtk_source_print_job_get_print_job ()

GnomePrintJob* gtk_source_print_job_get_print_job
                                            (GtkSourcePrintJob *job);

Gets a reference to the GnomePrintJob which the job is printing or has recently finished printing. You need to unref the returned object.

You may call this function in the middle of an asynchronous printing operation, but the returned GnomePrintJob will not be closed until the last page is printed and the "finished" signal is emitted.

gtk_source_print_job_get_page ()

guint       gtk_source_print_job_get_page   (GtkSourcePrintJob *job);

Determines the currently printing page number. This function is only valid while printing (either synchronously or asynchronously).

gtk_source_print_job_get_page_count ()

guint       gtk_source_print_job_get_page_count
                                            (GtkSourcePrintJob *job);

Determines the total number of pages the job will print. The returned value is only meaninful after pagination has finished. In practice, for synchronous printing this means when "begin_page" is emitted, or after gtk_source_print_job_print_range_async() has returned.

gtk_source_print_job_get_print_context ()

GnomePrintContext* gtk_source_print_job_get_print_context
                                            (GtkSourcePrintJob *job);

Determines the GnomePrintContext of the current job. This function is only valid while printing. Normally you would use this function to print in the margins set by gtk_source_print_job_set_margins() in a handler for the "begin_page" signal.

gtk_source_print_job_set_print_header ()

void        gtk_source_print_job_set_print_header
                                            (GtkSourcePrintJob *job,
                                             gboolean setting);

Sets whether you want to print a header in each page. The default header consists of three pieces of text and an optional line separator, configurable with gtk_source_print_job_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.

gtk_source_print_job_get_print_header ()

gboolean    gtk_source_print_job_get_print_header
                                            (GtkSourcePrintJob *job);

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_job_set_header_format().

gtk_source_print_job_set_print_footer ()

void        gtk_source_print_job_set_print_footer
                                            (GtkSourcePrintJob *job,
                                             gboolean setting);

Sets whether you want to print a footer in each page. The default footer consists of three pieces of text and an optional line separator, configurable with gtk_source_print_job_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.

gtk_source_print_job_get_print_footer ()

gboolean    gtk_source_print_job_get_print_footer
                                            (GtkSourcePrintJob *job);

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_job_set_footer_format().

gtk_source_print_job_set_header_footer_font_desc ()

void        gtk_source_print_job_set_header_footer_font_desc
                                            (GtkSourcePrintJob *job,
                                             PangoFontDescription *desc);

Sets the font for printing headers and footers. If NULL is supplied, the default font (i.e. the one being used for the text) will be used instead.

gtk_source_print_job_set_header_footer_font ()

void        gtk_source_print_job_set_header_footer_font
                                            (GtkSourcePrintJob *job,
                                             const gchar *font_name);

Sets the font for printing headers and footers. If NULL is supplied, the default font (i.e. the one being used for the text) will be used instead.

Note that font_name is a GnomeFont name not a Pango font description string. This function is deprecated since GnomeFont is no longer used when implementing printing for GtkSourceView; you should use gtk_source_print_job_set_header_footer_font_desc() instead.

gtk_source_print_job_get_header_footer_font_desc ()

PangoFontDescription* gtk_source_print_job_get_header_footer_font_desc
                                            (GtkSourcePrintJob *job);

Determines the font to be used for the header and footer. This function might return NULL if a specific font has not been set.

gtk_source_print_job_get_header_footer_font ()

gchar*      gtk_source_print_job_get_header_footer_font
                                            (GtkSourcePrintJob *job);

Determines the font to be used for the header and footer. The returned string is of the form "Fontfamily Style Size", for example "Monospace Regular 10.0". The returned value should be freed when no longer needed. This function might return NULL if a specific font has not been set.

Note that the result is a GnomeFont name not a Pango font description string. This function is deprecated since GnomeFont is no longer used when implementing printing for GtkSourceView; you should use gtk_source_print_job_get_header_footer_font_desc() instead.

gtk_source_print_job_set_header_format ()

void        gtk_source_print_job_set_header_format
                                            (GtkSourcePrintJob *job,
                                             const gchar *left,
                                             const gchar *center,
                                             const gchar *right,
                                             gboolean separator);

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.

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 gtk_source_print_job_set_print_header().

gtk_source_print_job_set_footer_format ()

void        gtk_source_print_job_set_footer_format
                                            (GtkSourcePrintJob *job,
                                             const gchar *left,
                                             const gchar *center,
                                             const gchar *right,
                                             gboolean separator);

Like gtk_source_print_job_set_header_format(), but for the footer.

The "buffer" property

  "buffer"               GtkSourceBuffer       : Read / Write

GtkSourceBuffer object to print.

The "config" property

  "config"               GnomePrintConfig      : Read / Write

Configuration options for the print job.

The "font" property

  "font"                 gchararray            : Read / Write

GnomeFont name to use for the document text (deprecated).

Default value: NULL

The "font-desc" property

  "font-desc"            PangoFontDescription  : Read / Write

Font to use for the document text (e.g. "Monospace 10").

The "header-footer-font" property

  "header-footer-font"   gchararray            : Read / Write

GnomeFont name to use for the header and footer (deprecated).

Default value: NULL

The "header-footer-font-desc" property

  "header-footer-font-desc" PangoFontDescription  : Read / Write

Font to use for headers and footers (e.g. "Monospace 10").

The "highlight" property

  "highlight"            gboolean              : Read / Write

Whether to print the document with highlighted syntax.

Default value: TRUE

The "numbers-font" property

  "numbers-font"         gchararray            : Read / Write

GnomeFont name to use for the line numbers (deprecated).

Default value: NULL

The "numbers-font-desc" property

  "numbers-font-desc"    PangoFontDescription  : Read / Write

Font description to use for the line numbers.

The "print-footer" property

  "print-footer"         gboolean              : Read / Write

Whether to print a footer in each page.

Default value: FALSE

The "print-header" property

  "print-header"         gboolean              : Read / Write

Whether to print a header in each page.

Default value: FALSE

The "print-numbers" property

  "print-numbers"        guint                 : Read / Write

Interval of printed line numbers (0 means no numbers).

Allowed values: <= 100

Default value: 1

The "tabs-width" property

  "tabs-width"           guint                 : Read / Write

Width in equivalent space characters of tabs.

Allowed values: <= 100

Default value: 8

The "wrap-mode" property

  "wrap-mode"            GtkWrapMode           : Read / Write

Word wrapping mode.

Default value: GTK_WRAP_NONE

The "begin-page" signal

void        user_function                  (GtkSourcePrintJob *sourceprintjob,
                                            gpointer           user_data)           : Run last

Emitted whenever the sourceprintjob is about to print a new text page. You can connect to this signal to provide the user with feedback about the progress of printing, or to customize the printed page by for example, printing your own headers and footers.

The "finished" signal

void        user_function                  (GtkSourcePrintJob *sourceprintjob,
                                            gpointer           user_data)           : Run first

Emitted whenever an asynchronous print job has finished. You can connect to this signal to get notification when a job has finished printing. When it's emitted, the GnomePrintJob the sourceprintjob was producing has been closed and it can be either previewed or printed to the physical device.