---
name: "Gtk2::SourceView2::PrintCompositor"
section: "3pm"
platform: "linux"
package: "libgtk2-sourceview2-perl"
version: "0.10-2+b3"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/Gtk2::SourceView2::PrintCompositor"
---

# Gtk2::SourceView2::PrintCompositor(3pm)

## NAME

Gtk2::SourceView2::PrintCompositor

## HIERARCHY

```
  Glib::Object
  +----Gtk2::SourceView2::PrintCompositor
```

## METHODS

### printcompositor = Gtk2::SourceView2::PrintCompositor-\>new ($buffer)

- •

  `$buffer` (Gtk2::SourceView2::Buffer)

### printcompositor = Gtk2::SourceView2::PrintCompositor-\>new\_from\_view ($view)

- •

  `$view` (Gtk2::SourceView2::View)

### string = $compositor-\>get\_body\_font\_name

### $compositor-\>set\_body\_font\_name ($font\_name)

- •

  `$font_name` (string)

### double = $compositor-\>get\_bottom\_margin ($unit)

- •

  `$unit` (Gtk2::Unit)

### $compositor-\>set\_bottom\_margin ($margin, $unit)

- •

  `$margin` (double)

- •

  `$unit` (Gtk2::Unit)

### buffer = $compositor-\>get\_buffer

### $compositor-\>draw\_page ($context, $page\_nr)

- •

  `$context` (Gtk2::PrintContext)

- •

  `$page_nr` (integer)

### string = $compositor-\>get\_footer\_font\_name

### $compositor-\>set\_footer\_font\_name ($font\_name)

- •

  `$font_name` (string or undef)

### $compositor-\>set\_footer\_format ($separator, $left, $center, $right)

- •

  `$separator` (boolean)

- •

  `$left` (string or undef)

- •

  `$center` (string or undef)

- •

  `$right` (string or undef)

### string = $compositor-\>get\_header\_font\_name

### $compositor-\>set\_header\_font\_name ($font\_name)

- •

  `$font_name` (string or undef)

### $compositor-\>set\_header\_format ($separator, $left, $center, $right)

- •

  `$separator` (boolean)

- •

  `$left` (string or undef)

- •

  `$center` (string or undef)

- •

  `$right` (string or undef)

### boolean = $compositor-\>get\_highlight\_syntax

### $compositor-\>set\_highlight\_syntax ($highlight)

- •

  `$highlight` (boolean)

### double = $compositor-\>get\_left\_margin ($unit)

- •

  `$unit` (Gtk2::Unit)

### $compositor-\>set\_left\_margin ($margin, $unit)

- •

  `$margin` (double)

- •

  `$unit` (Gtk2::Unit)

### string = $compositor-\>get\_line\_numbers\_font\_name

### $compositor-\>set\_line\_numbers\_font\_name ($font\_name)

- •

  `$font_name` (string or undef)

### integer = $compositor-\>get\_n\_pages

### boolean = $compositor-\>paginate ($context)

- •

  `$context` (Gtk2::PrintContext)

### double = $compositor-\>get\_pagination\_progress

### boolean = $compositor-\>get\_print\_footer

### $compositor-\>set\_print\_footer ($print)

- •

  `$print` (boolean)

### boolean = $compositor-\>get\_print\_header

### $compositor-\>set\_print\_header ($print)

- •

  `$print` (boolean)

### integer = $compositor-\>get\_print\_line\_numbers

### $compositor-\>set\_print\_line\_numbers ($interval)

- •

  `$interval` (integer)

### double = $compositor-\>get\_right\_margin ($unit)

- •

  `$unit` (Gtk2::Unit)

### $compositor-\>set\_right\_margin ($margin, $unit)

- •

  `$margin` (double)

- •

  `$unit` (Gtk2::Unit)

### integer = $compositor-\>get\_tab\_width

### $compositor-\>set\_tab\_width ($width)

- •

  `$width` (integer)

### double = $compositor-\>get\_top\_margin ($unit)

- •

  `$unit` (Gtk2::Unit)

### $compositor-\>set\_top\_margin ($margin, $unit)

- •

  `$margin` (double)

- •

  `$unit` (Gtk2::Unit)

### wrapmode = $compositor-\>get\_wrap\_mode

### $compositor-\>set\_wrap\_mode ($wrap\_mode)

- •

  `$wrap_mode` (Gtk2::WrapMode)

## PROPERTIES

- 'body-font-name' (string : default undef : readable / writable)

  Name of the font to use for the text body (e.g. "Monospace 10")

- 'buffer' (Gtk2::SourceView2::Buffer : default undef : readable / writable / construct-only)

  The GtkSourceBuffer object to print

- 'footer-font-name' (string : default undef : readable / writable)

  Name of the font to use for the page footer (e.g. "Monospace 10")

- 'header-font-name' (string : default undef : readable / writable)

  Name of the font to use for the page header (e.g. "Monospace 10")

- 'highlight-syntax' (boolean : default true : readable / writable)

  Whether to print the document with highlighted syntax

- 'line-numbers-font-name' (string : default undef : readable / writable)

  Name of the font to use for the line numbers (e.g. "Monospace 10")

- 'n-pages' (integer : default -1 : readable)

  The number of pages in the document (-1 means the document has not been completely paginated).

- 'print-footer' (boolean : default false : readable / writable)

  Whether to print a footer in each page

- 'print-header' (boolean : default false : readable / writable)

  Whether to print a header in each page

- 'print-line-numbers' (Glib::UInt : default 1 : readable / writable)

  Interval of printed line numbers (0 means no numbers)

- 'tab-width' (Glib::UInt : default 8 : readable / writable)

  Width of a tab character expressed in spaces

- 'wrap-mode' (Gtk2::WrapMode : default "none" : readable / writable)

  Whether to wrap lines never, at word boundaries, or at character boundaries.

## ENUMS AND FLAGS

### enum Gtk2::Unit

- •

  'pixel' / 'GTK\_UNIT\_PIXEL'

- •

  'points' / 'GTK\_UNIT\_POINTS'

- •

  'inch' / 'GTK\_UNIT\_INCH'

- •

  'mm' / 'GTK\_UNIT\_MM'

### enum Gtk2::WrapMode

- •

  'none' / 'GTK\_WRAP\_NONE'

- •

  'char' / 'GTK\_WRAP\_CHAR'

- •

  'word' / 'GTK\_WRAP\_WORD'

- •

  'word-char' / 'GTK\_WRAP\_WORD\_CHAR'

## SEE ALSO

Gtk2::SourceView2, Glib::Object

## COPYRIGHT

Copyright (C) 2009 by Emmanuel Rodriguez
