Enum BreakValue 

pub enum BreakValue {
    Auto,
    Always,
    Page,
    Column,
    EvenPage,
    OddPage,
}

Break-before and break-after property values

Controls forced page/column breaks before or after an element. Based on XSL-FO 1.1 specification.

Examples

use fop_layout::layout::BreakValue;

let break_val = BreakValue::Page;
assert!(break_val.forces_break());

let auto = BreakValue::Auto;
assert!(!auto.forces_break());

Variants

Auto

auto - no forced break

Always

always - force break (deprecated, use page)

Page

page - force page break

Column

column - force column break

EvenPage

even-page - force break to next even-numbered page

OddPage

odd-page - force break to next odd-numbered page

Implementations

impl BreakValue

pub fn from_property_value(value: &PropertyValue) -> Self

Create a BreakValue from a property value

pub fn forces_break(&self) -> bool

Check if this value forces a break

pub fn forces_page_break(&self) -> bool

Check if this forces a page break (not column)

pub fn requires_even_page(&self) -> bool

Check if this requires an even page

pub fn requires_odd_page(&self) -> bool

Check if this requires an odd page

Trait Implementations

impl Clone for BreakValue

fn clone(&self) -> BreakValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BreakValue

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

Formats the value using the given formatter.

impl Default for BreakValue

fn default() -> BreakValue

Returns the “default value” for a type.

impl Display for BreakValue

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

Formats the value using the given formatter.

impl PartialEq for BreakValue

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BreakValue

impl Eq for BreakValue

impl StructuralPartialEq for BreakValue