Enum ScrollToMode

pub enum ScrollToMode {
    Minimal {
        margin: SideOffsets,
    },
    Center {
        widget_point: Point,
        scroll_point: Point,
    },
}

Defines how much the SCROLL_TO_CMD will scroll to showcase the target widget.

Variants

Minimal

Scroll will change only just enough so that the widget inner rect is fully visible with the optional extra margin offsets.

Fields

margin: SideOffsets

Extra margin added so that the widget is touching the scroll edge.

Center

Scroll so that the point relative to the widget inner rectangle is at the same screen point on the scroll viewport.

Fields

widget_point: Point

A point relative to the target widget inner size.

scroll_point: Point

A point relative to the scroll viewport.

Implementations

impl ScrollToMode

pub fn minimal(margin: impl Into<SideOffsets>) -> Self

New Minimal mode.

pub fn minimal_rect(rect: impl Into<Rect>) -> Self

New Minimal mode.

The minimal scroll needed so that rect in the content widget is fully visible.

pub fn center() -> Self

New Center mode using the center points of widget and scroll.

pub fn center_points( widget_point: impl Into<Point>, scroll_point: impl Into<Point>, ) -> Self

New Center mode.

Trait Implementations

impl Clone for ScrollToMode

fn clone(&self) -> ScrollToMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollToMode

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

Formats the value using the given formatter.

impl Default for ScrollToMode

fn default() -> Self

Minimal with margin 10.

impl<'de> Deserialize<'de> for ScrollToMode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoVar<Option<ScrollToMode>> for ScrollToMode

type Var = LocalVar<Option<ScrollToMode>>

Variable type that will wrap the T value.

fn into_var(self) -> Self::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 ScrollToMode

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl IntoValue<Option<ScrollToMode>> for ScrollToMode

impl StructuralPartialEq for ScrollToMode