Skip to main content

TextSpec

Struct TextSpec 

Source
pub struct TextSpec { /* private fields */ }
Expand description

A sticky-note text annotation (/Subtype /Text).

use kurbo::Rect;
use peniko::Color;
use pdfrum_edit::{AnnotSpec, TextSpec};

let spec: AnnotSpec = TextSpec::new(Rect::new(0.0, 0.0, 20.0, 20.0), Color::from_rgb8(255, 255, 0))
    .icon("Note")
    .open(true)
    .into();

Implementations§

Source§

impl TextSpec

Source

pub fn new(rect: Rect, color: Color) -> Self

A sticky note at rect, /Comment icon, pop-up closed.

Source

pub fn icon(self, icon: impl Into<Name>) -> Self

Sets the icon name (/Name), such as Note or Help.

Source

pub fn open(self, open: bool) -> Self

Sets whether the pop-up starts open (/Open).

Source§

impl TextSpec

Source

pub fn contents(self, contents: impl Into<String>) -> Self

A sticky-note annotation.

Sets /Contents.

Source

pub fn author(self, author: impl Into<String>) -> AnnotWrite

A sticky-note annotation.

Sets /T, the author.

Source

pub fn name(self, name: impl Into<String>) -> AnnotWrite

A sticky-note annotation.

Sets /NM, the annotation’s unique name.

Source

pub fn modified(self, modified: impl Into<String>) -> AnnotWrite

A sticky-note annotation.

Sets /M, the modification date.

Source

pub fn flags(self, flags: AnnotFlags) -> AnnotWrite

A sticky-note annotation.

Sets /F, the annotation flags.

Source

pub fn meta(self, meta: AnnotMeta) -> AnnotWrite

A sticky-note annotation.

Sets every metadata field at once.

Trait Implementations§

Source§

impl Clone for TextSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TextSpec

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl From<TextSpec> for AnnotWrite

Source§

fn from(builder: TextSpec) -> Self

Converts to this type from the input type.
Source§

impl From<TextSpec> for AnnotSpec

Source§

fn from(b: TextSpec) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for TextSpec

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TextSpec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

Source§

fn to_owned_obj(&self, data: FontData<'_>) -> U

Convert this type into T, using the provided data to resolve any offsets.
Source§

impl<U, T> ToOwnedTable<U> for T
where U: FromTableRef<T>,

Source§

fn to_owned_table(&self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.