Skip to main content

Area

Struct Area 

Source
pub struct Area {
    pub area_type: AreaType,
    pub geometry: Rect,
    pub traits: TraitSet,
    pub content: Option<AreaContent>,
    pub keep_constraint: Option<KeepConstraint>,
    pub break_before: Option<BreakValue>,
    pub break_after: Option<BreakValue>,
    pub widows: i32,
    pub orphans: i32,
}
Expand description

An area represents a rectangular region on a page

Fields§

§area_type: AreaType

Area type

§geometry: Rect

Position and size

§traits: TraitSet

Rendering traits (color, background, borders, etc.)

§content: Option<AreaContent>

Content (text or image data)

§keep_constraint: Option<KeepConstraint>

Keep constraints for page breaking

§break_before: Option<BreakValue>

Break-before property value

§break_after: Option<BreakValue>

Break-after property value

§widows: i32

Widows constraint - minimum lines at top of page after break

§orphans: i32

Orphans constraint - minimum lines at bottom of page before break

Implementations§

Source§

impl Area

Source

pub fn new(area_type: AreaType, geometry: Rect) -> Self

Create a new area

Source

pub fn text(geometry: Rect, content: String) -> Self

Create a text area

Source

pub fn viewport_with_image(geometry: Rect, image_data: Vec<u8>) -> Self

Create a viewport area for an image

Source

pub fn with_traits(self, traits: TraitSet) -> Self

Set the area’s traits

Source

pub fn with_keep_constraint(self, keep_constraint: KeepConstraint) -> Self

Set the area’s keep constraint

Source

pub fn with_break_before(self, break_before: BreakValue) -> Self

Set the area’s break-before value

Source

pub fn with_break_after(self, break_after: BreakValue) -> Self

Set the area’s break-after value

Source

pub fn with_widows(self, widows: i32) -> Self

Set the area’s widows constraint

Source

pub fn with_orphans(self, orphans: i32) -> Self

Set the area’s orphans constraint

Source

pub fn has_text(&self) -> bool

Check if this area contains text

Source

pub fn has_image_data(&self) -> bool

Check if this area contains image data

Source

pub fn text_content(&self) -> Option<&str>

Get text content if this is a text area

Source

pub fn image_data(&self) -> Option<&[u8]>

Get image data if this is an image area

Source

pub fn width(&self) -> Length

Get the area’s width

Source

pub fn height(&self) -> Length

Get the area’s height

Trait Implementations§

Source§

impl Clone for Area

Source§

fn clone(&self) -> Area

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Area

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Area

§

impl RefUnwindSafe for Area

§

impl Send for Area

§

impl Sync for Area

§

impl Unpin for Area

§

impl UnsafeUnpin for Area

§

impl UnwindSafe for Area

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.