Scroll
Show a part of view with scrollbar.
| Module | require("yue.gui") |
| Type | Class |
| Inherits | View |
The Scroll view can show an arbitrary content view inside it.
When the content is larger than the Scroll view, scrollbars will be
optionally showed. When the content view is smaller then the Scroll view,
the content view will be resized to the size of the Scroll view.
Class methods
create()
Create a new Scroll view.
Return
ScrollMethods
setcontentview(view)
Set the content view.
Parameters
Viewview
getcontentview()
Return the content view.
Return
Viewsetcontentsize(size)
Set the size of content view.
Parameters
SizeFsize
getcontentsize()
Return the size of content view.
Return
SizeFsetscrollposition(horizon, vertical)
Scroll to the horizon and vertical position.
Parameters
numberhorizonnumbervertical
getscrollposition()
Return the horizon and vertical scroll position.
Return
number, numbergetmaximumscrollposition()
Return the maximum horizon and vertical scroll position.
Return
number, numbersetoverlayscrollbar(overlay) macOS linux
Set whether to use overlay scrolling.
Parameters
booleanoverlay
isoverlayscrollbar() macOS linux
Return whether overlay scrolling is used.
Return
booleansetscrollbarpolicy(hpolicy, vpolicy)
Set the policy for displaying horizontal and vertical scrollbars.
Parameters
Scroll::Policyhpolicy - Policy for horizontal scrollbar.Scroll::Policyvpolicy - Policy for vertical scrollbar.
getscrollbarpolicy()
Return the display policy of horizontal and vertical scrollbars.
Return
Scroll::Policy, Scroll::Policysetscrollelasticity(helasticity, velasticity) macOS
Set horizontal and vertical scroll elasticity (bounce).
Parameters
Scroll::Elasticityhelasticity - Horizontal scroll elasticity.Scroll::Elasticityvelasticity - Vertical scroll elasticity.
getscrollelasticity() macOS
Return the horizontal and vertical scroll elasticity.
Return
Scroll::Elasticity, Scroll::ElasticityEvents
onscroll(self)
Emitted when the content view is being scrolled.
Parameters
Scrollself