Struct zng::scroll::cmd::ScrollToRequest

pub struct ScrollToRequest {
    pub target: ScrollToTarget,
    pub mode: ScrollToMode,
    pub zoom: Option<Factor>,
}

Parameters for the SCROLL_TO_CMD.

Fields

target: ScrollToTarget

Area that will be scrolled into view.

mode: ScrollToMode

How much the scroll position will change to showcase the target widget.

zoom: Option<Factor>

Optional zoom scale target.

If set the offsets and scale will animate so that the mode is fulfilled when this zoom factor is reached. If not set the scroll will happen in the current zoom scale.

Note that the viewport size can change due to a scrollbar visibility changing, this size change is not accounted for when calculating minimal.

Implementations

impl ScrollToRequest

pub fn to_param(self) -> CommandParam

Pack the request into a command parameter.

pub fn from_param(p: &CommandParam) -> Option<ScrollToRequest>

Extract a clone of the request from the command parameter if it is of a compatible type.

pub fn from_args(args: &CommandArgs) -> Option<ScrollToRequest>

Extract a clone of the request from CommandArgs::param if it is set to a compatible type and stop-propagation was not requested for the event and the command was enabled when it was send.

Trait Implementations

impl Clone for ScrollToRequest

fn clone(&self) -> ScrollToRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollToRequest

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

Formats the value using the given formatter.

impl PartialEq for ScrollToRequest

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