[−][src]Struct cursive::views::ScrollView
Wraps a view in a scrollable area.
Implementations
impl<V> ScrollView<V> where
V: View,
[src]
V: View,
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)
[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) 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)
[src]
Controls whether this view can scroll vertically.
Defaults to true
.
pub fn set_scroll_x(&mut self, enabled: bool)
[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)
[src]
Programmatically scroll to the top of the view.
pub fn scroll_to_bottom(&mut self)
[src]
Programmatically scroll to the bottom of the view.
pub fn scroll_to_left(&mut self)
[src]
Programmatically scroll to the leftmost side of the view.
pub fn scroll_to_right(&mut self)
[src]
Programmatically scroll to the rightmost side of the view.
pub fn scroll_to_important_area(&mut self)
[src]
Programmatically scroll until the child's important area is in view.
pub fn into_inner(self) -> V
[src]
Returns the wrapped view.
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> Scroller for ScrollView<V>
[src]
fn get_scroller_mut(&mut self) -> &mut Core
[src]
fn get_scroller(&self) -> &Core
[src]
impl<V> View for ScrollView<V> where
V: View,
[src]
V: View,
fn draw(&self, printer: &Printer)
[src]
fn on_event(&mut self, event: Event) -> EventResult
[src]
fn layout(&mut self, size: XY<usize>)
[src]
fn needs_relayout(&self) -> bool
[src]
fn required_size(&mut self, constraint: XY<usize>) -> XY<usize>
[src]
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)
)
fn focus_view(&mut self, selector: &Selector) -> Result<(), ()>
[src]
fn take_focus(&mut self, source: Direction) -> bool
[src]
fn important_area(&self, size: XY<usize>) -> Rect
[src]
fn type_name(&self) -> &'static str
[src]
Auto Trait Implementations
impl<V> RefUnwindSafe for ScrollView<V> where
V: RefUnwindSafe,
V: RefUnwindSafe,
impl<V> Send for ScrollView<V> where
V: Send,
V: Send,
impl<V> Sync for ScrollView<V> where
V: Sync,
V: Sync,
impl<V> Unpin for ScrollView<V> where
V: Unpin,
V: Unpin,
impl<V> UnwindSafe for ScrollView<V> where
V: UnwindSafe,
V: UnwindSafe,
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,
fn as_any(&self) -> &(dyn Any + 'static)
[src]
Downcast self to a Any
.
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
[src]
Downcast self to a mutable Any
.
fn as_boxed_any(self: Box<T>) -> Box<dyn Any + 'static>
[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,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Erased for T
impl<T> Finder for T where
T: View,
[src]
T: View,
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,
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,
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,
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,
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,
fn as_boxed_view(self) -> Box<dyn View + 'static>
[src]
impl<T> Nameable for T where
T: View,
[src]
T: View,
fn with_name<S>(self, name: S) -> NamedView<Self> where
S: Into<String>,
[src]
S: Into<String>,
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,
fn boxed(
self,
width: SizeConstraint,
height: SizeConstraint
) -> ResizedView<Self>
[src]
self,
width: SizeConstraint,
height: SizeConstraint
) -> ResizedView<Self>
fn resized(
self,
width: SizeConstraint,
height: SizeConstraint
) -> ResizedView<Self>
[src]
self,
width: SizeConstraint,
height: SizeConstraint
) -> ResizedView<Self>
fn fixed_size<S>(self, size: S) -> ResizedView<Self> where
S: Into<XY<usize>>,
[src]
S: Into<XY<usize>>,
fn fixed_width(self, width: usize) -> ResizedView<Self>
[src]
fn fixed_height(self, height: usize) -> ResizedView<Self>
[src]
fn full_screen(self) -> ResizedView<Self>
[src]
fn full_width(self) -> ResizedView<Self>
[src]
fn full_height(self) -> ResizedView<Self>
[src]
fn max_size<S>(self, size: S) -> ResizedView<Self> where
S: Into<XY<usize>>,
[src]
S: Into<XY<usize>>,
fn max_width(self, max_width: usize) -> ResizedView<Self>
[src]
fn max_height(self, max_height: usize) -> ResizedView<Self>
[src]
fn min_size<S>(self, size: S) -> ResizedView<Self> where
S: Into<XY<usize>>,
[src]
S: Into<XY<usize>>,
fn min_width(self, min_width: usize) -> ResizedView<Self>
[src]
fn min_height(self, min_height: usize) -> ResizedView<Self>
[src]
impl<T> Scrollable for T where
T: View,
[src]
T: View,
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.
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.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> View for T where
T: ViewWrapper,
[src]
T: ViewWrapper,
fn draw(&self, printer: &Printer)
[src]
fn required_size(&mut self, req: XY<usize>) -> XY<usize>
[src]
fn on_event(&mut self, ch: Event) -> EventResult
[src]
fn layout(&mut self, size: XY<usize>)
[src]
fn take_focus(&mut self, source: Direction) -> bool
[src]
fn call_on_any(
&mut self,
selector: &Selector,
callback: &'a mut (dyn FnMut(&mut (dyn View + 'static)) + 'a)
)
[src]
&mut self,
selector: &Selector,
callback: &'a mut (dyn FnMut(&mut (dyn View + 'static)) + 'a)
)