Struct ZoomModel 

pub struct ZoomModel { /* private fields */ }

The scale of one app’s content: the levels it steps through, where Ctrl+0 returns to, and the factor it shows now.

A window zooms its whole content (WindowZoom, the theme’s UI scale). A widget or an app whose content has a size of its own — a photograph, a PDF page, a board — keeps a ZoomModel instead: the levels and bounds are its own (a picture fits a frame and magnifies to 8×; a page is 25 %–1600 %), and the rules are this module’s, so Ctrl+=, Ctrl+- and Ctrl+0 mean the same thing everywhere and every app states its level the same way.

use tilo_ui::content_zoom::{ZoomModel, ZoomStep};
let mut model = ZoomModel::stepping([1.0, 2.0, 4.0], 1.0);
assert_eq!(model.step(ZoomStep::In), 2.0);
assert_eq!(model.label("Fit to window"), "200%");
assert_eq!(model.step(ZoomStep::Reset), 1.0);
assert_eq!(model.label("Fit to window"), "Fit to window");

Implementations

impl ZoomModel

pub fn standard() -> ZoomModel

The toolkit’s levels (LEVELS): the window’s own content zoom, and the default for content with no scale of its own.

pub fn stepping(levels: impl IntoIterator<Item = f32>, reset: f32) -> ZoomModel

levels as an app’s content steps through them, with reset where Ctrl+0 goes. Levels are sorted, and a level that is not a finite positive factor is dropped; a model with no usable level keeps the toolkit’s.

pub fn default_factor(&self) -> f32

The factor the content shows at its own size: what Ctrl+0 returns to (100 % for a page, a picture fitted to its frame).

pub fn levels(&self) -> &[f32]

The levels, ascending.

pub fn factor(&self) -> f32

The factor the content shows now.

pub fn percent(&self) -> f64

The factor as a whole percentage of the content’s own size.

pub fn is_default(&self) -> bool

Whether the content shows at its own size.

pub fn step(&mut self, step: ZoomStep) -> f32

Take step, between this model’s levels, and answer the factor the content shows now.

pub fn set(&mut self, factor: f32) -> f32

Adopt factor as what the content shows (a wheel notch, a pinch, a fit computed from the frame), left inside what the levels allow.

pub fn adopt(&mut self, factor: f32) -> f32

Adopt factor as what the content shows, without clamping: the value came from the content itself (a wheel notch, a fit it computed), so the model reports what is on screen even when that is outside its own levels.

pub fn min(&self) -> Option<f32>

The smallest factor the levels allow.

pub fn max(&self) -> Option<f32>

The largest factor the levels allow.

pub fn can_step(&self, step: ZoomStep) -> bool

Whether step would change the factor: in below the largest, out above the smallest, and reset unless already at the default.

pub fn step_of(&self, step: ZoomStep) -> f32

What step would make the factor, without taking it.

pub fn label(&self, default_label: &str) -> String

What a control says about the level: default_label (“Fit to window”) while the content shows at its own size, else the percentage (“120%”).

Trait Implementations

impl Clone for ZoomModel

fn clone(&self) -> ZoomModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZoomModel

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

Formats the value using the given formatter.

impl Default for ZoomModel

fn default() -> ZoomModel

Returns the “default value” for a type.

impl PartialEq for ZoomModel

fn eq(&self, other: &ZoomModel) -> 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 StructuralPartialEq for ZoomModel