Struct zng::scroll::cmd::ScrollRequest

pub struct ScrollRequest {
    pub alternate: bool,
    pub clamp: (f32, f32),
}

Parameters for the scroll and page commands.

Fields

alternate: bool

If the alt factor should be applied to the base scroll unit when scrolling.

clamp: (f32, f32)

Only scroll within this inclusive range. The range is normalized 0.0..=1.0, the default is (f32::MIN, f32::MAX).

Note that the commands are enabled and disabled for the full range, this parameter controls the range for the request only.

Implementations

impl ScrollRequest

pub fn to_param(self) -> CommandParam

Pack the request into a command parameter.

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

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

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

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.

Trait Implementations

impl Clone for ScrollRequest

fn clone(&self) -> ScrollRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollRequest

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

Formats the value using the given formatter.

impl Default for ScrollRequest

fn default() -> ScrollRequest

Returns the “default value” for a type.

impl From<bool> for ScrollRequest

fn from(alternate: bool) -> ScrollRequest

Converts to this type from the input type.

impl IntoVar<ScrollRequest> for bool

type Var = LocalVar<ScrollRequest>

Variable type that will wrap the T value.

fn into_var(self) -> <bool as IntoVar<ScrollRequest>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl PartialEq for ScrollRequest

fn eq(&self, other: &ScrollRequest) -> 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 IntoValue<ScrollRequest> for bool

impl StructuralPartialEq for ScrollRequest