Enumerationmigueldeicaza.swiftgodot 0.45.0SwiftGodot
ScrollMode
ScrollContainer.swift:19enum ScrollMode
Cases
case disabled
Scrolling disabled, scrollbar will be invisible.
case auto
Scrolling enabled, scrollbar will be visible only if necessary, i.e. container’s content is bigger than the container.
case showAlways
Scrolling enabled, scrollbar will be always visible.
case showNever
Scrolling enabled, scrollbar will be hidden.
Other members in extension
View members
Hide members
This section is hidden by default because it contains too many (14) members.
Type members
Instance members
var followFocus: Bool
If
true
, the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible.var horizontalScrollMode: ScrollContainer.ScrollMode
Controls whether horizontal scrollbar can be used and when it should be visible. See
ScrollMode
for options.var scrollDeadzone: Int32
Deadzone for touch scrolling. Lower deadzone makes the scrolling more sensitive.
var scrollEnded: SimpleSignal
Emitted when scrolling stops when dragging the scrollable area with a touch event. This signal is not emitted when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events.
var scrollHorizontal: Int32
The current horizontal scroll value.
var scrollHorizontalCustomStep: Double
Overrides the
customStep
used when clicking the internal scroll bar’s horizontal increment and decrement buttons or when using arrow keys when theScrollBar
is focused.var scrollStarted: SimpleSignal
Emitted when scrolling starts when dragging the scrollable area w_ith a touch event_. This signal is not emitted when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events.
var scrollVertical: Int32
The current vertical scroll value.
var scrollVerticalCustomStep: Double
Overrides the
customStep
used when clicking the internal scroll bar’s vertical increment and decrement buttons or when using arrow keys when theScrollBar
is focused.var verticalScrollMode: ScrollContainer.ScrollMode
Controls whether vertical scrollbar can be used and when it should be visible. See
ScrollMode
for options.func ensureControlVisible(control: Control?
) Ensures the given
control
is visible (must be a direct or indirect child of the ScrollContainer). Used byfollowFocus
.func getHScrollBar(
) -> HScrollBar? Returns the horizontal scrollbar
HScrollBar
of thisScrollContainer
.func getVScrollBar(
) -> VScrollBar? Returns the vertical scrollbar
VScrollBar
of thisScrollContainer
.
Citizens in SwiftGodot
Conformances
protocol CaseIterable
A type that provides a collection of all of its values.
protocol CustomDebugStringConvertible
A type with a customized textual representation suitable for debugging purposes.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a
Hasher
to produce an integer hash value.protocol RawRepresentable<RawValue>
A type that can be converted to and from an associated raw value.
Type members
Instance members
var debugDescription: String
A textual representation of this instance, suitable for debugging
Type features
static func != (lhs: Self, rhs: Self
) -> Bool Returns a Boolean value indicating whether two values are not equal.