gtksourceview.SourcePrintJob.set_config

    def set_config(config)

The set_config() method 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 gnomeprint.Config

gtksourceview.SourcePrintJob.get_config

    def get_config()

The get_config() method gets the current gnomeprint.Config 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.

gtksourceview.SourcePrintJob.set_buffer

    def set_buffer(buffer)

The set_buffer() method sets the gtksourceview.SourceBuffer 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 passing the parameter <methodparam>buffer</methodparam> at the constructor.

gtksourceview.SourcePrintJob.get_buffer

    def get_buffer()

The get_buffer() method gets the gtksourceview.SourceBuffer the print job would print. The returned object reference (if non None) is owned by the job object and should not be unreferenced

gtksourceview.SourcePrintJob.setup_from_view

    def setup_from_view(view)

The setup_from_view() method is a 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.

gtksourceview.SourcePrintJob.set_tabs_width

    def set_tabs_width(tabs_width)

The set_tabs_width() method 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.

gtksourceview.SourcePrintJob.get_tabs_width

    def get_tabs_width()

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

gtksourceview.SourcePrintJob.set_wrap_mode

    def set_wrap_mode(wrap)

The set_wrap_mode() method sets the wrap mode for lines of text larger than the printable width. See GtkWrapMode for a definition of the possible values.

gtksourceview.SourcePrintJob.get_wrap_mode

    def get_wrap_mode()

The get_tabs_width() method determines the wrapping style for text lines wider than the printable width. The default is no wrapping.

gtksourceview.SourcePrintJob.set_highlight

    def set_highlight(highlight)

The set_highlight() method sets whether the printed text will be highlighted according to the buffer rules. Both color and font style are applied.

gtksourceview.SourcePrintJob.get_highlight

    def get_highlight()

The get_tabs_width() method 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.

gtksourceview.SourcePrintJob.set_font_desc

    def set_font_desc(desc)

The set_font_desc() method sets the default font for the printed text.

gtksourceview.SourcePrintJob.get_font_desc

    def get_font_desc()

The get_font_desc() method 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".

gtksourceview.SourcePrintJob.set_font

    def set_font(font_name)

The set_font() method 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")

gtksourceview.SourcePrintJob.get_font

    def get_font()

The get_font() method 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".

gtksourceview.SourcePrintJob.set_numbers_font_desc

    def set_numbers_font_desc(desc)

The set_numbers_font_desc() method sets the font for printing line numbers on the left margin. If None is supplied, the default font (i.e. the one being used for the text) will be used instead.

gtksourceview.SourcePrintJob.get_numbers_font_desc

    def get_numbers_font_desc()

The get_font_desc() method determines the font to be used for the line numbers. This function might return None if a specific font for numbers has not been set.

gtksourceview.SourcePrintJob.set_numbers_font

    def set_numbers_font(font_name)

The set_font() method sets the font for printing line numbers on the left margin. If None is supplied, the default font (i.e. the one being used for the text) will be used instead.

gtksourceview.SourcePrintJob.get_numbers_font

    def get_numbers_font()

The get_numbers_font() method 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". This function might return None if a specific font for numbers has not been set.

gtksourceview.SourcePrintJob.set_print_numbers

    def set_print_numbers(interval)

The set_print_numbers() method 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).

gtksourceview.SourcePrintJob.get_print_numbers

    def get_print_numbers()

The get_font_desc() method 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).

gtksourceview.SourcePrintJob.set_text_margins

    def set_text_margins(top, bottom, left, right)

The set_text_margins() method 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.

gtksourceview.SourcePrintJob.get_text_margins

    def get_text_margins()

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

gtksourceview.SourcePrintJob.print

    def print()

The print() method produces a GnomePrintJob with the printed document. The whole contents of the configured gtksourceview.SourceBuffer are printed. The returned job is already closed and ready to be previewed (using gnomeprint.ui.JobPreview) 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.

gtksourceview.SourcePrintJob.print_range

    def print_range()

The print_range() method is similar to print, except you can specify a range of text to print. The passed GtkTextIter values might be out of order.

gtksourceview.SourcePrintJob.print_range_async

    def print_range_async()

The print_range_async() method 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 get_print_job. You may cancel the job with cancel

gtksourceview.SourcePrintJob.cancel

    def cancel()

The cancel() method 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 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.

gtksourceview.SourcePrintJob.get_print_job

    def get_print_job()

The get_font_desc() method gets a reference to the GnomePrintJob which the job is printing or has recently finished printing. You need to unref the returned object.

gtksourceview.SourcePrintJob.get_page

    def get_page()

The get_page() method determines the currently printing page number. This function is only valid while printing (either synchronously or asynchronously).

gtksourceview.SourcePrintJob.get_page_count

    def get_page_count()

The get_page_count() method 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 print_range_async has returned.

gtksourceview.SourcePrintJob.get_print_context

    def get_print_context()

The get_print_context() method 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 set_text_margins in a handler for the "begin-page" signal.

gtksourceview.SourcePrintJob.set_print_header

    def set_print_header(setting)

The set_print_header() method 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 set_header_format.

gtksourceview.SourcePrintJob.get_print_header

    def get_print_header()

The get_print_header() method 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 set_header_format.

gtksourceview.SourcePrintJob.set_print_footer

    def set_print_footer(setting)

The set_print_footer() method sets whether you want to print a footer in each page. The default header consists of three pieces of text and an optional line separator, configurable with set_footer_format.

gtksourceview.SourcePrintJob.get_print_footer

    def get_print_footer()

The get_print_footer() method determines if a footer 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 set_header_format.

gtksourceview.SourcePrintJob.set_header_footer_font_desc

    def set_header_footer_font_desc(desc)

The set_header_footer_font_desc() method sets the font for printing headers and footers. If None is supplied, the default font (i.e. the one being used for the text) will be used instead.

gtksourceview.SourcePrintJob.get_header_footer_font_desc

    def get_header_footer_font_desc()

The get_header_footer_font_desc() method determines the font to be used for the header and footer. This function might return None if a specific font has not been set.

gtksourceview.SourcePrintJob.set_header_footer_font

    def set_header_footer_font(font_name)

The set_header_footer_font() method sets the font for printing headers and footers. If None is supplied, the default font (i.e. the one being used for the text) will be used instead.

gtksourceview.SourcePrintJob.get_header_footer_font

    def get_header_footer_font()

The get_header_footer_font_desc() method 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 None if a specific font has not been set.

gtksourceview.SourcePrintJob.set_header_format

    def set_header_format(left, center, right, separator)

The set_header_format() method sets time() 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 time() 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 None 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.

gtksourceview.SourcePrintJob.set_footer_format

    def set_footer_format(left, center, right, separator)

The set_footer_format() method sets time() like footer 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 time() 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 None 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_footer.

The "begin-page" gtksourceprintjob.SourcePrintJob Signal

    def callback(sourceprintjob, user_param1, ...)

The "begin-page" signal is emitted when 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" gtksourceprintjob.SourcePrintJob Signal

    def callback(sourceprintjob, user_param1, ...)

The "finished" signal is 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.