[−][src]Struct kas::widget::ScrollRegion
A scrollable region
This region supports scrolling via mouse wheel and drag.
Optionally, it can have scroll bars (see ScrollRegion::show_bars
and
ScrollRegion::with_bars
).
Scroll regions translate their contents by an offset
, which has a
minimum value of Coord::ZERO
and a maximum value of
ScrollRegion::max_offset
.
Methods
impl<W: Widget> ScrollRegion<W>
[src]
pub fn new(inner: W) -> Self
[src]
Construct a new scroll region around an inner widget
pub fn with_auto_bars(self, enable: bool) -> Self
[src]
Auto-enable bars
If enabled, this automatically enables/disables scroll bars when resized.
This has the side-effect of reserving enough space for scroll bars even when not required.
pub fn with_bars(self, horiz: bool, vert: bool) -> Self
[src]
Set which scroll bars are visible
pub fn show_bars(&mut self, horiz: bool, vert: bool)
[src]
Set which scroll bars are visible
pub fn inner(&self) -> &W
[src]
Access inner widget directly
pub fn inner_mut(&mut self) -> &mut W
[src]
Access inner widget directly
pub fn max_offset(&self) -> Coord
[src]
Get the maximum offset
pub fn offset(&self) -> Coord
[src]
Get the current offset
pub fn set_offset(&mut self, offset: Coord) -> TkAction
[src]
Set the scroll offset
Returns TkAction::None
if the offset is identical to the old offset,
or a greater action if not identical.
Trait Implementations
impl<W: Clone + Widget> Clone for ScrollRegion<W>
[src]
fn clone(&self) -> ScrollRegion<W>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<W: Debug + Widget> Debug for ScrollRegion<W>
[src]
impl<W: Default + Widget> Default for ScrollRegion<W>
[src]
fn default() -> ScrollRegion<W>
[src]
impl<W: Widget> Handler for ScrollRegion<W>
[src]
type Msg = <W as Handler>::Msg
Type of message returned by this widget Read more
fn activation_via_press(&self) -> bool
[src]
fn handle(&mut self, _: &mut Manager, event: Event) -> Response<Self::Msg>
[src]
impl<W: Widget> Layout for ScrollRegion<W>
[src]
fn size_rules(
&mut self,
size_handle: &mut dyn SizeHandle,
axis: AxisInfo
) -> SizeRules
[src]
&mut self,
size_handle: &mut dyn SizeHandle,
axis: AxisInfo
) -> SizeRules
fn set_rect(&mut self, rect: Rect, _: AlignHints)
[src]
fn translation(&self, child_index: usize) -> Coord
[src]
fn find_id(&self, coord: Coord) -> Option<WidgetId>
[src]
fn draw(
&self,
draw_handle: &mut dyn DrawHandle,
mgr: &ManagerState,
disabled: bool
)
[src]
&self,
draw_handle: &mut dyn DrawHandle,
mgr: &ManagerState,
disabled: bool
)
fn spatial_range(&self) -> (usize, usize)
[src]
impl<W: Widget> SendEvent for ScrollRegion<W>
[src]
impl<W: Widget> Widget for ScrollRegion<W>
[src]
impl<W: Widget> WidgetChildren for ScrollRegion<W>
[src]
fn len(&self) -> usize
[src]
fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>
[src]
fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>
[src]
fn is_ancestor_of(&self, id: WidgetId) -> bool
[src]
fn find(&self, id: WidgetId) -> Option<&dyn WidgetConfig>
[src]
fn find_mut(&mut self, id: WidgetId) -> Option<&mut dyn WidgetConfig>
[src]
fn walk(&self, f: &mut dyn FnMut(&dyn WidgetConfig))
[src]
fn walk_mut(&mut self, f: &mut dyn FnMut(&mut dyn WidgetConfig))
[src]
impl<W: Widget> WidgetConfig for ScrollRegion<W>
[src]
fn configure(&mut self, mgr: &mut Manager)
[src]
fn configure_recurse<'a, 'b>(&mut self, cmgr: ConfigureManager<'a, 'b>)
[src]
fn key_nav(&self) -> bool
[src]
fn cursor_icon(&self) -> CursorIcon
[src]
impl<W: Widget> WidgetCore for ScrollRegion<W>
[src]
fn as_any(&self) -> &dyn Any
[src]
fn as_any_mut(&mut self) -> &mut dyn Any
[src]
fn core_data(&self) -> &CoreData
[src]
fn core_data_mut(&mut self) -> &mut CoreData
[src]
fn widget_name(&self) -> &'static str
[src]
fn as_widget(&self) -> &dyn WidgetConfig
[src]
fn as_widget_mut(&mut self) -> &mut dyn WidgetConfig
[src]
fn id(&self) -> WidgetId
[src]
fn is_disabled(&self) -> bool
[src]
fn set_disabled(&mut self, disabled: bool) -> TkAction
[src]
fn rect(&self) -> Rect
[src]
fn input_state(&self, mgr: &ManagerState, disabled: bool) -> InputState
[src]
Auto Trait Implementations
impl<W> RefUnwindSafe for ScrollRegion<W> where
W: RefUnwindSafe,
W: RefUnwindSafe,
impl<W> Send for ScrollRegion<W> where
W: Send,
W: Send,
impl<W> Sync for ScrollRegion<W> where
W: Sync,
W: Sync,
impl<W> Unpin for ScrollRegion<W> where
W: Unpin,
W: Unpin,
impl<W> UnwindSafe for ScrollRegion<W> where
W: UnwindSafe,
W: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src where
Scheme: ApproxScheme,
[src]
Scheme: ApproxScheme,
type Err = NoError
The error type produced by a failed conversion.
fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>
[src]
impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src where
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,
[src]
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,
type Err = <Dst as ApproxFrom<Src, Scheme>>::Err
The error type produced by a failed conversion.
fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>
[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, Dst> ConvAsUtil<Dst> for T
[src]
fn approx(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,
[src]
Self: ApproxInto<Dst, DefaultApprox>,
fn approx_by<Scheme>(self) -> Result<Dst, Self::Err> where
Scheme: ApproxScheme,
Self: ApproxInto<Dst, Scheme>,
[src]
Scheme: ApproxScheme,
Self: ApproxInto<Dst, Scheme>,
impl<T> ConvUtil for T
[src]
fn approx_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,
[src]
Self: ApproxInto<Dst, DefaultApprox>,
fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err> where
Scheme: ApproxScheme,
Self: ApproxInto<Dst, Scheme>,
[src]
Scheme: ApproxScheme,
Self: ApproxInto<Dst, Scheme>,
fn into_as<Dst>(self) -> Dst where
Self: Into<Dst>,
[src]
Self: Into<Dst>,
fn try_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: TryInto<Dst>,
[src]
Self: TryInto<Dst>,
fn value_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ValueInto<Dst>,
[src]
Self: ValueInto<Dst>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<Src> TryFrom<Src> for Src
[src]
type Err = NoError
The error type produced by a failed conversion.
fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>
[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<Src, Dst> TryInto<Dst> for Src where
Dst: TryFrom<Src>,
[src]
Dst: TryFrom<Src>,
type Err = <Dst as TryFrom<Src>>::Err
The error type produced by a failed conversion.
fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>
[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<Src> ValueFrom<Src> for Src
[src]
type Err = NoError
The error type produced by a failed conversion.
fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>
[src]
impl<Src, Dst> ValueInto<Dst> for Src where
Dst: ValueFrom<Src>,
[src]
Dst: ValueFrom<Src>,