Content

[Raku PDF Project] / [PDF-Content Module] / PDF::Content

class PDF::Content

PDF Content construction and manipulation

Description

implements a PDF graphics state machine for composition, or rendering:

Synposis

use lib 't';
use PDF::Content;
use PDF::Content::Canvas;
use PDFTiny;
my PDFTiny $pdf .= new;
my PDF::Content::Canvas $canvas = $pdf.add-page;
my PDF::Content $gfx .= new: :$canvas;
$gfx.use-font: $pdf.core-font('Courier'); # define /F1 font
$gfx.BeginText;
$gfx.Font = 'F1', 16;
$gfx.TextMove(10, 20);
$gfx.ShowText('Hello World');
$gfx.EndText;
say $gfx.Str;
# BT
#  /F1 16 Tf
#  10 20 Td
#  (Hello World) Tj
# ET

Methods

method graphics

method graphics(
    &meth
) returns Mu

Add a graphics block

method text

method text(
    &meth
) returns Mu

Add a text block

method mark

method mark(
    Str $t,
    &meth,
    |c
) returns PDF::Content::Tag

Add a marked content block

multi method tag

multi method tag(
    Str $tag,
    Bool :$mark,
    *%props
) returns PDF::Content::Tag

Add an empty content tag, optionally marked

multi method tag

multi method tag(
    Str $tag,
    &meth,
    Bool :$mark,
    *%props
) returns PDF::Content::Tag

Add tagged content, optionally marked

method load-image

method load-image(
    $spec
) returns PDF::Content::XObject

Open an image from a file-spec or data-uri

method inline-images

method inline-images() returns Seq

extract any inline images from the content stream. returns an array of XObject Images

method transform

method transform(
    |c
) returns Mu

perform a series of graphics transforms

method text-transform

method text-transform(
    |c
) returns Mu

perform a series of text transforms

multi method do

multi method do(
    PDF::Content::XObject $obj,
    List :$position where { ... } = Code.new,
    Str :$align is copy where { ... } = "left",
    Str :$valign is copy where { ... } = "bottom",
    Numeric :$width is copy,
    Numeric :$height is copy,
    Bool :$inline = Bool::False
) returns List

place an image, or form object

method use-pattern

method use-pattern(
    Hash $pat where { ... }
) returns Mu

ensure pattern is declared as a resource

multi method paint

multi method paint(
    &meth,
    *%o
) returns Mu

build a path, then fill and stroke it

multi sub make-font

multi sub make-font(
    PDF::Content::Font:D(Any):D $dict
) returns PDF::COS::Dict

associate a font dictionary with a font object

method text-box

method text-box(
    Any:D :$font where { ... } = Code.new,
    Numeric:D :$font-size = Code.new,
    *%opt
) returns PDF::Content::Text::Box

create a text box object for use in graphics .print() or .say() methods

method print

method print(
    Str:D $text,
    :$font! where { ... },
    *%opt
) returns List

output text leave the text position at the end of the current line

method text-position

method text-position() returns PDF::Content::Vector

get or set the current text position

multi method print

multi method print(
    PDF::Content::Text::Box $text-box,
    List :$position where { ... },
    Bool :$nl = Bool::False,
    Bool :$preserve = Bool::True
) returns List

print a text block object

method say

method say(
    $text = "",
    *%opt
) returns Mu

output text; move the text position down one line

multi method set-font

multi method set-font(
    Hash $font,
    Numeric $size = 16
) returns Mu

thin wrapper to $.op(SetFont, ...)

method font

method font() returns Array

Get or set the current font as (font-size)

multi method print

multi method print(
    Str $text,
    :$font = Code.new,
    |c
) returns List

print text to the content stream

method html-canvas

method html-canvas(
    &mark-up,
    |c
) returns Mu

add graphics using HTML Canvas 2D API

The HTML::Canvas::To::PDF Raku module must be installed to use this method

method draw

method draw(
    $html-canvas,
    :$renderer,
    |c
) returns Mu

render an HTML canvas

method base-coords

method base-coords(
    *@coords where { ... },
    :$user = Bool::True,
    :$text = Code.new
) returns Array

map transformed user coordinates to untransformed (default) coordinates

method user-coords

method user-coords(
    *@coords where { ... },
    :$user = Bool::True,
    :$text = Code.new
) returns Array

inverse of base-coords