Struct Scrollbar 

pub struct Scrollbar { /* private fields */ }

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

Implementations

impl Scrollbar

pub fn new<H>(scroll_handle: &H) -> Scrollbar

where H: ScrollbarHandle + Clone,

Create a new scrollbar.

This will have both vertical and horizontal scrollbars.

pub fn horizontal<H>(scroll_handle: &H) -> Scrollbar

where H: ScrollbarHandle + Clone,

Create with horizontal scrollbar.

pub fn vertical<H>(scroll_handle: &H) -> Scrollbar

where H: ScrollbarHandle + Clone,

Create with vertical scrollbar.

pub fn id(self, id: impl Into<ElementId>) -> Scrollbar

Set a specific element id, default is the Location::caller.

NOTE: In most cases, you don’t need to set a specific id for scrollbar.

pub fn mode(self, mode: ScrollbarMode) -> Scrollbar

Set the scrollbar show mode ScrollbarMode.

If unset, the current application theme projection is used.

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

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

Default will sync the content_size from scroll_handle.

pub fn viewport_bounds(self, bounds: Bounds<Pixels>) -> Scrollbar

Override the viewport bounds that this scrollbar overlays.

Most scroll containers should rely on the bounds reported by their scroll handle. Custom-painted viewports, such as the text editor, can use this when their visible bounds differ from the handle’s layout bounds.

pub fn viewport_from_layout(self) -> Scrollbar

Use the scrollbar element’s layout bounds as its viewport.

This is useful for composite widgets whose scrollbar viewport excludes fixed headers or columns and is therefore defined by a positioned overlay container rather than by the underlying scroll handle.

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

Set scrollbar axis.

pub fn styles( self, build: impl FnOnce(ScrollbarStyles) -> ScrollbarStyles, ) -> Scrollbar

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, <Scrollbar as Element>::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 <Scrollbar as Element>::RequestLayoutState, window: &mut Window, cx: &mut App, ) -> <Scrollbar as Element>::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 <Scrollbar as Element>::RequestLayoutState, prepaint: &mut <Scrollbar as Element>::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 a11y_role(&self) -> Option<Role>

Returns the accessible role for this element, if any. Elements that return None are not included in the accessibility tree.

fn write_a11y_info(&self, _node: &mut Node)

Write accessibility properties to the given node. Called only when a11y_role() returns Some.

fn a11y_synthetic_children( &mut self, _prepaint: &mut Self::PrepaintState, _builder: &mut A11ySubtreeBuilder<'_>, )

Add synthetic child nodes to an Element that has an .id() and a .role().

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) -> <Scrollbar as IntoElement>::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.