Struct Scrollbar 

pub struct Scrollbar { /* private fields */ }

Scrollbar control for scroll-area or a uniform-list.

Implementations

impl Scrollbar

pub fn both( state: &ScrollbarState, scroll_handle: &(impl ScrollHandleOffsetable + Clone + 'static), ) -> Self

Create with vertical and horizontal scrollbar.

pub fn horizontal( state: &ScrollbarState, scroll_handle: &(impl ScrollHandleOffsetable + Clone + 'static), ) -> Self

Create with horizontal scrollbar.

pub fn vertical( state: &ScrollbarState, scroll_handle: &(impl ScrollHandleOffsetable + Clone + 'static), ) -> Self

Create with vertical scrollbar.

pub fn uniform_scroll( state: &ScrollbarState, scroll_handle: &(impl ScrollHandleOffsetable + Clone + 'static), ) -> Self

Create vertical scrollbar for uniform list.

pub fn scroll_size(self, scroll_size: Size<Pixels>) -> Self

Set a special scroll size of the content area, default is None.

Default will sync the content_size from scroll_handle.

pub fn axis(self, axis: impl Into<ScrollbarAxis>) -> Self

Set scrollbar axis.

Trait Implementations

impl Element for Scrollbar

type RequestLayoutState = ()

The type of state returned from Element::request_layout. A mutable reference to this state is subsequently provided to Element::prepaint and Element::paint.

type PrepaintState = PrepaintState

The type of state returned from Element::prepaint. A mutable reference to this state is subsequently provided to Element::paint.

fn id(&self) -> Option<ElementId>

If this element has a unique identifier, return it here. This is used to track elements across frames, and will cause a GlobalElementId to be passed to the request_layout, prepaint, and paint methods.

fn source_location(&self) -> Option<&'static Location<'static>>

Source location where this element was constructed, used to disambiguate elements in the inspector and navigate to their source code.

fn request_layout( &mut self, _: Option<&GlobalElementId>, _: Option<&InspectorElementId>, window: &mut Window, cx: &mut App, ) -> (LayoutId, Self::RequestLayoutState)

Before an element can be painted, we need to know where it’s going to be and how big it is. Use this method to request a layout from Taffy and initialize the element’s state.

fn prepaint( &mut self, _: Option<&GlobalElementId>, _: Option<&InspectorElementId>, bounds: Bounds<Pixels>, _: &mut Self::RequestLayoutState, window: &mut Window, cx: &mut App, ) -> Self::PrepaintState

After laying out an element, we need to commit its bounds to the current frame for hitbox purposes. The state argument is the same state that was returned from Element::request_layout().

fn paint( &mut self, _: Option<&GlobalElementId>, _: Option<&InspectorElementId>, _: Bounds<Pixels>, _: &mut Self::RequestLayoutState, prepaint: &mut Self::PrepaintState, window: &mut Window, cx: &mut App, )

Once layout has been completed, this method will be called to paint the element to the screen. The state argument is the same state that was returned from Element::request_layout().

fn into_any(self) -> AnyElement

Convert this element into a dynamically-typed AnyElement.

impl IntoElement for Scrollbar

type Element = Scrollbar

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.