pub struct PullToRefresh { /* private fields */ }Expand description
A widget that allows the user to pull to refresh.
Implementations§
Source§impl PullToRefresh
impl PullToRefresh
Sourcepub fn new(loading: bool) -> Self
pub fn new(loading: bool) -> Self
Creates a new pull to refresh widget.
If loading is true, the widget will show the loading indicator.
Sourcepub fn min_refresh_distance(self, min_refresh_distance: f32) -> Self
pub fn min_refresh_distance(self, min_refresh_distance: f32) -> Self
Sets the minimum distance the user needs to drag to trigger a refresh.
Sourcepub fn id(self, id: Id) -> Self
pub fn id(self, id: Id) -> Self
You need to provide a id if you use multiple pull to refresh widgets at once.
Sourcepub fn can_refresh(self, can_refresh: bool) -> Self
pub fn can_refresh(self, can_refresh: bool) -> Self
If can_refresh is false, pulling will not trigger a refresh.
Sourcepub fn ui<T>(
self,
ui: &mut Ui,
content: impl FnOnce(&mut Ui) -> T,
) -> PullToRefreshResponse<T>
pub fn ui<T>( self, ui: &mut Ui, content: impl FnOnce(&mut Ui) -> T, ) -> PullToRefreshResponse<T>
Shows the pull to refresh widget.
Note: If you want to use the pull to refresh widget in a scroll area, use Self::scroll_area_ui.
You might want to disable text selection via egui::style::Interaction
to avoid conflicts with the drag gesture.
Sourcepub fn scroll_area_ui<T>(
self,
ui: &mut Ui,
content: impl FnOnce(&mut Ui) -> ScrollAreaOutput<T>,
) -> PullToRefreshResponse<ScrollAreaOutput<T>>
pub fn scroll_area_ui<T>( self, ui: &mut Ui, content: impl FnOnce(&mut Ui) -> ScrollAreaOutput<T>, ) -> PullToRefreshResponse<ScrollAreaOutput<T>>
Shows the pull to refresh widget, wrapping a egui::ScrollArea.
Pass the output of the scroll area to the content function.
Auto Trait Implementations§
impl Freeze for PullToRefresh
impl RefUnwindSafe for PullToRefresh
impl Send for PullToRefresh
impl Sync for PullToRefresh
impl Unpin for PullToRefresh
impl UnsafeUnpin for PullToRefresh
impl UnwindSafe for PullToRefresh
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more