Struct pdf::TextObject

pub struct TextObject<'a> {
    // some fields omitted
}

A text object is where text is put on the canvas.

A TextObject should never be created directly by the user. Instead, the text method on a Canvas object should be called. It will create a TextObject and call a callback, before terminating the text object properly.

Example

let serif = canvas.get_font(BuiltinFont::Times_Roman);
// t will be a TextObject
try!(canvas.text(|t| {
    try!(t.set_font(&serif, 14.0));
    try!(t.set_leading(18.0));
    try!(t.pos(10.0, 300.0));
    try!(t.show("Some lines of text in what might look like a"));
    try!(t.show_line("paragraph of three lines. Lorem ipsum dolor"));
    try!(t.show_line("sit amet. Blahonga."));
    Ok(())
}));

Methods

impl<'a> TextObject<'a>

fn new(output: &'a mut Write) -> TextObject

See Canvas::text. User code is not supposed to call this constructor.

fn set_font(&mut self, font: &FontRef, size: f32) -> Result<()>

Set the font and font-size to be used by the following text operations.

fn set_leading(&mut self, leading: f32) -> Result<()>

Set leading, the vertical distance from a line of text to the next. This is important for the show_line method.

fn set_rise(&mut self, rise: f32) -> Result<()>

Set the rise above the baseline for coming text. Calling set_rise again with a zero argument will get back to the old baseline.

fn set_char_spacing(&mut self, a_c: f32) -> Result<()>

Set the amount of extra space between characters, in 1/1000 text unit.

fn set_word_spacing(&mut self, a_w: f32) -> Result<()>

Set the amount of extra space between words, in 1/1000 text unit.

fn set_stroke_color(&mut self, color: Color) -> Result<()>

Set color for stroking operations.

fn set_fill_color(&mut self, color: Color) -> Result<()>

Set color for non-stroking operations.

fn set_stroke_gray(&mut self, gray: u8) -> Result<()>

Set gray level for stroking operations

fn set_fill_gray(&mut self, gray: u8) -> Result<()>

Set gray level for non-stroking operations

fn pos(&mut self, x: f32, y: f32) -> Result<()>

Move text position.

The first time pos is called in a TextObject, (x, y) refers to the same point as for Canvas::move_to, after that, the point is relative to the earlier pos.

fn show(&mut self, text: &str) -> Result<()>

Show a text.

fn show_j(&mut self, text: &str, offset: i32) -> Result<()>

TODO This method should have a better name, and take any combination of strings as integers as arguments.

fn show_line(&mut self, text: &str) -> Result<()>

Show a text as a line. See also set_leading.

fn gsave(&mut self) -> Result<()>

Push the graphics state on a stack.

fn grestore(&mut self) -> Result<()>

Pop a graphics state from the gsave stack and restore it.