[−][src]Struct cursive::views::ScrollView
Wraps a view in a scrollable area.
Implementations
impl<V> ScrollView<V>[src]
pub fn new(inner: V) -> ScrollView<V>[src]
Creates a new ScrollView around view.
pub fn content_viewport(&self) -> Rect[src]
Returns the viewport in the inner content.
pub fn inner_size(&self) -> XY<usize>[src]
Returns the size of the content view, as it was on the last layout phase.
This is only the size the content thinks it has, and may be larger
than the actual size used by this ScrollView.
pub fn is_at_top(&self) -> bool[src]
Returns true if the top row of the content is in view.
pub fn is_at_bottom(&self) -> bool[src]
Returns true if the bottom row of the content is in view.
pub fn is_at_left_edge(&self) -> bool[src]
Return true if the left-most column of the content is in view.
pub fn is_at_right_edge(&self) -> bool[src]
Return true if the right-most column of the content is in view.
pub fn set_scroll_strategy(&mut self, strategy: ScrollStrategy) -> EventResult[src]
Defines the way scrolling is adjusted on content or size change.
The scroll strategy defines how the scrolling position is adjusted when the size of the view or the content change.
It is reset to ScrollStrategy::KeepRow whenever the user scrolls
manually.
pub fn scroll_strategy(self, strategy: ScrollStrategy) -> ScrollView<V>[src]
Defines the way scrolling is adjusted on content or size change.
Chainable variant.
pub fn set_show_scrollbars(&mut self, show_scrollbars: bool)[src]
Control whether scroll bars are visibile.
Defaults to true.
pub fn show_scrollbars(self, show_scrollbars: bool) -> ScrollView<V>[src]
Control whether scroll bars are visibile.
Chainable variant
pub fn set_offset<S>(&mut self, offset: S) -> EventResult where
S: Into<XY<usize>>, [src]
S: Into<XY<usize>>,
Sets the scroll offset to the given value
pub fn set_scroll_y(&mut self, enabled: bool) -> EventResult[src]
Controls whether this view can scroll vertically.
Defaults to true.
pub fn set_scroll_x(&mut self, enabled: bool) -> EventResult[src]
Controls whether this view can scroll horizontally.
Defaults to false.
pub fn scroll_y(self, enabled: bool) -> ScrollView<V>[src]
Controls whether this view can scroll vertically.
Defaults to true.
Chainable variant.
pub fn scroll_x(self, enabled: bool) -> ScrollView<V>[src]
Controls whether this view can scroll horizontally.
Defaults to false.
Chainable variant.
pub fn scroll_to_top(&mut self) -> EventResult[src]
Programmatically scroll to the top of the view.
pub fn scroll_to_bottom(&mut self) -> EventResult[src]
Programmatically scroll to the bottom of the view.
pub fn scroll_to_left(&mut self) -> EventResult[src]
Programmatically scroll to the leftmost side of the view.
pub fn scroll_to_right(&mut self) -> EventResult[src]
Programmatically scroll to the rightmost side of the view.
pub fn scroll_to_important_area(&mut self) -> EventResult where
V: View, [src]
V: View,
Programmatically scroll until the child's important area is in view.
pub fn into_inner(self) -> V[src]
Returns the wrapped view.
pub fn set_on_scroll_inner<F>(&mut self, on_scroll: F) where
F: FnMut(&mut ScrollView<V>, Rect) -> EventResult + 'static, [src]
F: FnMut(&mut ScrollView<V>, Rect) -> EventResult + 'static,
Sets a callback to be run whenever scrolling happens.
This lets the callback access the ScrollView itself (and its child)
if necessary.
If you just need to run a callback on &mut Cursive, consider
set_on_scroll.
pub fn set_on_scroll<F>(&mut self, on_scroll: F) where
F: FnMut(&mut Cursive, Rect) + 'static, [src]
F: FnMut(&mut Cursive, Rect) + 'static,
Sets a callback to be run whenever scrolling happens.
pub fn set_on_scroll_change_inner<F>(&mut self, on_scroll: F) where
F: FnMut(&mut ScrollView<V>, Rect) -> EventResult + 'static,
V: 'static, [src]
F: FnMut(&mut ScrollView<V>, Rect) -> EventResult + 'static,
V: 'static,
Sets a callback to be run whenever the scroll offset changes.
pub fn set_on_scroll_change<F>(&mut self, on_scroll: F) where
F: FnMut(&mut Cursive, Rect) + 'static,
V: 'static, [src]
F: FnMut(&mut Cursive, Rect) + 'static,
V: 'static,
Sets a callback to be run whenever the scroll offset changes.
pub fn on_scroll_inner<F>(self, on_scroll: F) -> ScrollView<V> where
F: Fn(&mut ScrollView<V>, Rect) -> EventResult + 'static, [src]
F: Fn(&mut ScrollView<V>, Rect) -> EventResult + 'static,
Sets a callback to be run whenever scrolling happens.
This lets the callback access the ScrollView itself (and its child)
if necessary.
If you just need to run a callback on &mut Cursive, consider
set_on_scroll.
Chainable variant.
pub fn on_scroll<F>(self, on_scroll: F) -> ScrollView<V> where
F: FnMut(&mut Cursive, Rect) + 'static, [src]
F: FnMut(&mut Cursive, Rect) + 'static,
Sets a callback to be run whenever scrolling happens.
Chainable variant.
pub fn get_inner(&self) -> &V[src]
Gets access to the inner view.
pub fn get_inner_mut(&mut self) -> &mut V[src]
Gets mutable access to the inner view.
Trait Implementations
impl<V> Default for ScrollView<V> where
V: Default, [src]
V: Default,
pub fn default() -> ScrollView<V>[src]
impl<V> Scroller for ScrollView<V>[src]
pub fn get_scroller_mut(&mut self) -> &mut Core[src]
pub fn get_scroller(&self) -> &Core[src]
impl<V> View for ScrollView<V> where
V: View, [src]
V: View,
pub fn draw(&self, printer: &Printer<'_, '_>)[src]
pub fn on_event(&mut self, event: Event) -> EventResult[src]
pub fn layout(&mut self, size: XY<usize>)[src]
pub fn needs_relayout(&self) -> bool[src]
pub fn required_size(&mut self, constraint: XY<usize>) -> XY<usize>[src]
pub fn call_on_any(
&mut self,
selector: &Selector<'_>,
cb: &'a mut (dyn FnMut(&mut (dyn View + 'static)) + 'a)
)[src]
&mut self,
selector: &Selector<'_>,
cb: &'a mut (dyn FnMut(&mut (dyn View + 'static)) + 'a)
)
pub fn focus_view(
&mut self,
selector: &Selector<'_>
) -> Result<(), ViewNotFound>[src]
&mut self,
selector: &Selector<'_>
) -> Result<(), ViewNotFound>
pub fn take_focus(&mut self, source: Direction) -> bool[src]
pub fn important_area(&self, size: XY<usize>) -> Rect[src]
pub fn type_name(&self) -> &'static str[src]
Auto Trait Implementations
impl<V> !RefUnwindSafe for ScrollView<V>[src]
impl<V> !Send for ScrollView<V>[src]
impl<V> !Sync for ScrollView<V>[src]
impl<V> Unpin for ScrollView<V> where
V: Unpin, [src]
V: Unpin,
impl<V> !UnwindSafe for ScrollView<V>[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> AnyView for T where
T: View, [src]
T: View,
pub fn as_any(&self) -> &(dyn Any + 'static)[src]
Downcast self to a Any.
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)[src]
Downcast self to a mutable Any.
pub fn as_boxed_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>[src]
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<T> Erased for T
impl<T> Finder for T where
T: View, [src]
T: View,
pub fn call_on_all<V, F>(&mut self, sel: &Selector<'_>, callback: F) where
F: FnMut(&mut V),
V: View, [src]
F: FnMut(&mut V),
V: View,
pub fn call_on<V, F, R>(&mut self, sel: &Selector<'_>, callback: F) -> Option<R> where
F: FnOnce(&mut V) -> R,
V: View, [src]
F: FnOnce(&mut V) -> R,
V: View,
pub fn call_on_name<V, F, R>(&mut self, name: &str, callback: F) -> Option<R> where
F: FnOnce(&mut V) -> R,
V: View, [src]
F: FnOnce(&mut V) -> R,
V: View,
pub fn call_on_id<V, F, R>(&mut self, id: &str, callback: F) -> Option<R> where
F: FnOnce(&mut V) -> R,
V: View, [src]
F: FnOnce(&mut V) -> R,
V: View,
pub fn find_name<V>(
&mut self,
name: &str
) -> Option<OwningHandle<OwningRef<Rc<RefCell<V>>, RefCell<V>>, RefMut<'static, V>>> where
V: View, [src]
&mut self,
name: &str
) -> Option<OwningHandle<OwningRef<Rc<RefCell<V>>, RefCell<V>>, RefMut<'static, V>>> where
V: View,
pub fn find_id<V>(
&mut self,
id: &str
) -> Option<OwningHandle<OwningRef<Rc<RefCell<V>>, RefCell<V>>, RefMut<'static, V>>> where
V: View, [src]
&mut self,
id: &str
) -> Option<OwningHandle<OwningRef<Rc<RefCell<V>>, RefCell<V>>, RefMut<'static, V>>> where
V: View,
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> IntoBoxedView for T where
T: View, [src]
T: View,
pub fn into_boxed_view(self) -> Box<dyn View + 'static, Global>[src]
impl<T> Nameable for T where
T: View, [src]
T: View,
pub fn with_name<S>(self, name: S) -> NamedView<Self> where
S: Into<String>, [src]
S: Into<String>,
pub fn with_id<S>(self, id: S) -> NamedView<Self> where
S: Into<String>, [src]
S: Into<String>,
impl<T> Resizable for T where
T: View, [src]
T: View,
pub fn boxed(
self,
width: SizeConstraint,
height: SizeConstraint
) -> ResizedView<Self>[src]
self,
width: SizeConstraint,
height: SizeConstraint
) -> ResizedView<Self>
pub fn resized(
self,
width: SizeConstraint,
height: SizeConstraint
) -> ResizedView<Self>[src]
self,
width: SizeConstraint,
height: SizeConstraint
) -> ResizedView<Self>
pub fn fixed_size<S>(self, size: S) -> ResizedView<Self> where
S: Into<XY<usize>>, [src]
S: Into<XY<usize>>,
pub fn fixed_width(self, width: usize) -> ResizedView<Self>[src]
pub fn fixed_height(self, height: usize) -> ResizedView<Self>[src]
pub fn full_screen(self) -> ResizedView<Self>[src]
pub fn full_width(self) -> ResizedView<Self>[src]
pub fn full_height(self) -> ResizedView<Self>[src]
pub fn max_size<S>(self, size: S) -> ResizedView<Self> where
S: Into<XY<usize>>, [src]
S: Into<XY<usize>>,
pub fn max_width(self, max_width: usize) -> ResizedView<Self>[src]
pub fn max_height(self, max_height: usize) -> ResizedView<Self>[src]
pub fn min_size<S>(self, size: S) -> ResizedView<Self> where
S: Into<XY<usize>>, [src]
S: Into<XY<usize>>,
pub fn min_width(self, min_width: usize) -> ResizedView<Self>[src]
pub fn min_height(self, min_height: usize) -> ResizedView<Self>[src]
impl<T> Scrollable for T where
T: View, [src]
T: View,
pub fn scrollable(self) -> ScrollView<Self>[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<T> With for T[src]
pub fn wrap_with<U, F>(self, f: F) -> U where
F: FnOnce(Self) -> U, [src]
F: FnOnce(Self) -> U,
pub fn with<F>(self, f: F) -> Self where
F: FnOnce(&mut Self), [src]
F: FnOnce(&mut Self),
pub fn try_with<E, F>(self, f: F) -> Result<Self, E> where
F: FnOnce(&mut Self) -> Result<(), E>, [src]
F: FnOnce(&mut Self) -> Result<(), E>,
pub fn with_if<F>(self, condition: bool, f: F) -> Self where
F: FnOnce(&mut Self), [src]
F: FnOnce(&mut Self),