Gtk2::S...positor(3)

📦
version 0.12 · 2 versions
, in fedora 43

💖 NAME 💖

Gtk2::SourceView2::PrintCompositor — bestie, this is the little icon that takes your GtkSourceBuffer and turns it into actual printed pages. Fr fr, it's your glow-up machine for paper. 🖨️✨

(It lives in the User Contributed Perl Documentation, which is giving very much "the cool older sibling of the docs folder." 🫶)

🌸 HIERARCHY 🌸

Okay so family tree time, and the lineage is giving main character:

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

Your compositor is a Glib::Object at heart. Periodt. 💅

✨ METHODS ✨

🎀 Constructors (how you make one)

  • printcompositor = Gtk2::SourceView2::PrintCompositor->new ($buffer) — spin up a brand new compositor straight from a buffer. Yes, you gotta hand it a buffer, no buffer no compositor, that's the vibe check.
    • $buffer (Gtk2::SourceView2::Buffer)
  • printcompositor = Gtk2::SourceView2::PrintCompositor->new_from_view ($view) — same energy, but you're building it from a view instead. Pick your fighter. 🦋
    • $view (Gtk2::SourceView2::View)

🖋️ Body font (the actual text, the moment)

  • string = $compositor->get_body_font_name — tells you what font the body text is currently serving.
  • $compositor->set_body_font_name ($font_name) — sets it. Slay.
    • $font_name (string)

📏 Bottom margin

  • double = $compositor->get_bottom_margin ($unit) — how much space is chillin' at the bottom, measured in whatever unit you ask for.
    • $unit (Gtk2::Unit)
  • $compositor->set_bottom_margin ($margin, $unit) — set the bottom breathing room. Two args, no drama.
    • $margin (double)
    • $unit (Gtk2::Unit)

🧺 Buffer

  • buffer = $compositor->get_buffer — hands you back the buffer this compositor is printing. No args, just vibes. 🍓

🖨️ Drawing pages

  • $compositor->draw_page ($context, $page_nr) — literally draws one page. Give it the print context and which page number you want.
    • $context (Gtk2::PrintContext)
    • $page_nr (integer)
  • string = $compositor->get_footer_font_name — what font is the page footer rocking?
  • $compositor->set_footer_font_name ($font_name) — set the footer font. Heads up: this one takes a string or undef, so undef is a valid mood here.
    • $font_name (string or undef)
  • $compositor->set_footer_format ($separator, $left, $center, $right) — lays out your footer into left / center / right slots. Very "three-part harmony."
    • $separator (boolean)
    • $left (string or undef)
    • $center (string or undef)
    • $right (string or undef)

👑 Header font

  • string = $compositor->get_header_font_name — the header's font situation, revealed.
  • $compositor->set_header_font_name ($font_name) — set it. Again: string or undef, undef is allowed, she's flexible.
    • $font_name (string or undef)

💅 Header format

  • $compositor->set_header_format ($separator, $left, $center, $right) — same three-slot layout energy, but for the header up top.
    • $separator (boolean)
    • $left (string or undef)
    • $center (string or undef)
    • $right (string or undef)

🌈 Syntax highlighting

  • boolean = $compositor->get_highlight_syntax — is the syntax highlighting turned on? yes/no bestie.
  • $compositor->set_highlight_syntax ($highlight) — flip it on or off.
    • $highlight (boolean)

📐 Left margin

  • double = $compositor->get_left_margin ($unit) — the left-side gap, in your chosen unit.
    • $unit (Gtk2::Unit)
  • $compositor->set_left_margin ($margin, $unit) — set that left gap.
    • $margin (double)
    • $unit (Gtk2::Unit)

🔢 Line numbers font

  • string = $compositor->get_line_numbers_font_name — what font are the line numbers using?
  • $compositor->set_line_numbers_font_name ($font_name) — set it. Yep, string or undef again.
    • $font_name (string or undef)

📄 Pages & pagination

  • integer = $compositor->get_n_pages — how many pages we talkin'?
  • boolean = $compositor->paginate ($context) — do the whole pagination thing. Give it a print context, get back a boolean.
    • $context (Gtk2::PrintContext)
  • double = $compositor->get_pagination_progress — how far along the pagination is. It's giving progress bar. 📊
  • boolean = $compositor->get_print_footer — is the footer even printing?
  • $compositor->set_print_footer ($print) — turn the footer printing on or off.
    • $print (boolean)
  • boolean = $compositor->get_print_header — is the header printing?
  • $compositor->set_print_header ($print) — toggle the header printing.
    • $print (boolean)
  • integer = $compositor->get_print_line_numbers — what interval are printed line numbers on?
  • $compositor->set_print_line_numbers ($interval) — set that interval. Set it to 0 and you get no numbers at all, iconic minimalism.
    • $interval (integer)

📐 Right margin

  • double = $compositor->get_right_margin ($unit) — right-side gap, your unit of choice.
    • $unit (Gtk2::Unit)
  • $compositor->set_right_margin ($margin, $unit) — set the right gap.
    • $margin (double)
    • $unit (Gtk2::Unit)

⚙️ Tab width

  • integer = $compositor->get_tab_width — how wide a tab is.
  • $compositor->set_tab_width ($width) — set how wide a tab is.
    • $width (integer)

📐 Top margin

  • double = $compositor->get_top_margin ($unit) — top gap, in your unit.
    • $unit (Gtk2::Unit)
  • $compositor->set_top_margin ($margin, $unit) — set the top gap.
    • $margin (double)
    • $unit (Gtk2::Unit)

🌀 Wrap mode

  • wrapmode = $compositor->get_wrap_mode — how are lines wrapping right now?
  • $compositor->set_wrap_mode ($wrap_mode) — set the wrapping behaviour.
    • $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. Note the construct-only tag, so this one's set at construction time, no take-backsies.
  • '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. Default is true, because obviously. ✨
  • '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). Read-only, she observes, she does not participate.
  • '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

Go read those next bestie, they're literally the rest of the lore. 📚

Copyright (C) 2009 by Emmanuel Rodriguez

and that's the whole page, mwah 💋 This was documented as part of the User Contributed Perl Documentation, written by the lovely perl v5.42.0, dated 2025-07-25. Go print something gorgeous, you absolute legend. 🎀💖🦋✨

📦 where this page comes from