Enum ScrollStyle 

pub enum ScrollStyle {
    Direction2D(MoveDir2D, ScrollSize, Count),
    CursorPos(MovePosition, Axis),
    LinePos(MovePosition, Count),
}

This represents the way in which the viewport should be scrolled.

Variants

Direction2D(MoveDir2D, ScrollSize, Count)

Scroll the viewport in MoveDir2D direction by ScrollSize units, n times.

Example: Using action!

use editor_types::prelude::*;
use editor_types::{action, Action};

let scroll: Action = action!("scroll -s (dir2d -d up -z half-page)");
let style = ScrollStyle::Direction2D(MoveDir2D::Up, ScrollSize::HalfPage, Count::Contextual);
assert_eq!(scroll, Action::Scroll(style));

See the documentation for ScrollSize for how to construct each of its variants with action.

CursorPos(MovePosition, Axis)

Scroll the viewport so that the cursor is placed at MovePosition relative to Axis.

Example: Using action!

use editor_types::prelude::*;
use editor_types::{action, Action};

let scroll: Action = action!("scroll -s (cursor-pos -p end -x vertical)");
let style = ScrollStyle::CursorPos(MovePosition::End, Axis::Vertical);
assert_eq!(scroll, Action::Scroll(style));

See the documentation for Axis and MovePosition for how to construct each of their variants with action.

LinePos(MovePosition, Count)

Scroll the viewport so that the n^th line is at MovePosition on the screen.

Example: Using action!

use editor_types::prelude::*;
use editor_types::{action, Action};

let scroll: Action = action!("scroll -s (line-pos -p end -c 1)");
let style = ScrollStyle::LinePos(MovePosition::End, 1.into());
assert_eq!(scroll, Action::Scroll(style));

See the documentation for MovePosition for how to construct each of its variants with action.

Trait Implementations

impl Clone for ScrollStyle

fn clone(&self) -> ScrollStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollStyle

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

Formats the value using the given formatter.

impl PartialEq for ScrollStyle

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

impl StructuralPartialEq for ScrollStyle