gi-gtk4-4.0.12: Gtk 4.x bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Objects.ScrolledWindow

Contents

- Exported types
- Methods
  - getChild
  - getHadjustment
  - getHasFrame
  - getHscrollbar
  - getKineticScrolling
  - getMaxContentHeight
  - getMaxContentWidth
  - getMinContentHeight
  - getMinContentWidth
  - getOverlayScrolling
  - getPlacement
  - getPolicy
  - getPropagateNaturalHeight
  - getPropagateNaturalWidth
  - getVadjustment
  - getVscrollbar
  - new
  - setChild
  - setHadjustment
  - setHasFrame
  - setKineticScrolling
  - setMaxContentHeight
  - setMaxContentWidth
  - setMinContentHeight
  - setMinContentWidth
  - setOverlayScrolling
  - setPlacement
  - setPolicy
  - setPropagateNaturalHeight
  - setPropagateNaturalWidth
  - setVadjustment
  - unsetPlacement
- Properties
  - child
  - hadjustment
  - hasFrame
  - hscrollbarPolicy
  - kineticScrolling
  - maxContentHeight
  - maxContentWidth
  - minContentHeight
  - minContentWidth
  - overlayScrolling
  - propagateNaturalHeight
  - propagateNaturalWidth
  - vadjustment
  - vscrollbarPolicy
  - windowPlacement
- Signals
  - edgeOvershot
  - edgeReached
  - moveFocusOut
  - scrollChild

Description

Makes its child scrollable.

<picture> <source srcset="scrolledwindow-dark.png" media="(prefers-color-scheme: dark)"> <img alt="An example GtkScrolledWindow" src="scrolledwindow.png"> </picture>

It does so using either internally added scrollbars or externally associated adjustments, and optionally draws a frame around the child.

Widgets with native scrolling support, i.e. those whose classes implement the `Scrollable` interface, are added directly. For other types of widget, the class `Viewport` acts as an adaptor, giving scrollability to other widgets. `scrolledWindowSetChild` intelligently accounts for whether or not the added child is a `GtkScrollable`. If it isn’t, then it wraps the child in a `GtkViewport`. Therefore, you can just add any child widget and not worry about the details.

If `scrolledWindowSetChild` has added a `GtkViewport` for you, it will be automatically removed when you unset the child. Unless ScrolledWindow:hscrollbarPolicy and ScrolledWindow:vscrollbarPolicy are `PolicyTypeNever` or `PolicyTypeExternal`, `GtkScrolledWindow` adds internal `GtkScrollbar` widgets around its child. The scroll position of the child, and if applicable the scrollbars, is controlled by the ScrolledWindow:hadjustment and ScrolledWindow:vadjustment that are associated with the `GtkScrolledWindow`. See the docs on `Scrollbar` for the details, but note that the “step_increment” and “page_increment” fields are only effective if the policy causes scrollbars to be present.

If a `GtkScrolledWindow` doesn’t behave quite as you would like, or doesn’t have exactly the right layout, it’s very possible to set up your own scrolling with `GtkScrollbar` and for example a `GtkGrid`.

# Touch support

`GtkScrolledWindow` has built-in support for touch devices. When a touchscreen is used, swiping will move the scrolled window, and will expose 'kinetic' behavior. This can be turned off with the ScrolledWindow:kineticScrolling property if it is undesired.

`GtkScrolledWindow` also displays visual 'overshoot' indication when the content is pulled beyond the end, and this situation can be captured with the ScrolledWindow::edgeOvershot signal.

If no mouse device is present, the scrollbars will overlaid as narrow, auto-hiding indicators over the content. If traditional scrollbars are desired although no mouse is present, this behaviour can be turned off with the ScrolledWindow:overlayScrolling property.

# Shortcuts and Gestures

The following signals have default keybindings:

- ScrolledWindow::scrollChild

# CSS nodes

`GtkScrolledWindow` has a main CSS node with name scrolledwindow. It gets a .frame style class added when ScrolledWindow:hasFrame is `True`.

It uses subnodes with names overshoot and undershoot to draw the overflow and underflow indications. These nodes get the .left, .right, .top or .bottom style class added depending on where the indication is drawn.

`GtkScrolledWindow` also sets the positional style classes (.left, .right, .top, .bottom) and style classes related to overlay scrolling (.overlay-indicator, .dragging, .hovering) on its scrollbars.

If both scrollbars are visible, the area where they meet is drawn with a subnode named junction.

# Accessibility

Until GTK 4.10, `GtkScrolledWindow` used the `AccessibleRoleGroup` role.

Starting from GTK 4.12, `GtkScrolledWindow` uses the `AccessibleRoleGeneric` role.

Synopsis

- newtype ScrolledWindow = ScrolledWindow (ManagedPtr ScrolledWindow)
- class (GObject o, IsDescendantOf ScrolledWindow o) => IsScrolledWindow o
- toScrolledWindow :: (MonadIO m, IsScrolledWindow o) => o -> m ScrolledWindow
- scrolledWindowGetChild :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m (Maybe Widget)
- scrolledWindowGetHadjustment :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Adjustment
- scrolledWindowGetHasFrame :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Bool
- scrolledWindowGetHscrollbar :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Widget
- scrolledWindowGetKineticScrolling :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Bool
- scrolledWindowGetMaxContentHeight :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Int32
- scrolledWindowGetMaxContentWidth :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Int32
- scrolledWindowGetMinContentHeight :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Int32
- scrolledWindowGetMinContentWidth :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Int32
- scrolledWindowGetOverlayScrolling :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Bool
- scrolledWindowGetPlacement :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m CornerType
- scrolledWindowGetPolicy :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m (PolicyType, PolicyType)
- scrolledWindowGetPropagateNaturalHeight :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Bool
- scrolledWindowGetPropagateNaturalWidth :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Bool
- scrolledWindowGetVadjustment :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Adjustment
- scrolledWindowGetVscrollbar :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Widget
- scrolledWindowNew :: (HasCallStack, MonadIO m) => m ScrolledWindow
- scrolledWindowSetChild :: (HasCallStack, MonadIO m, IsScrolledWindow a, IsWidget b) => a -> Maybe b -> m ()
- scrolledWindowSetHadjustment :: (HasCallStack, MonadIO m, IsScrolledWindow a, IsAdjustment b) => a -> Maybe b -> m ()
- scrolledWindowSetHasFrame :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> Bool -> m ()
- scrolledWindowSetKineticScrolling :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> Bool -> m ()
- scrolledWindowSetMaxContentHeight :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> Int32 -> m ()
- scrolledWindowSetMaxContentWidth :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> Int32 -> m ()
- scrolledWindowSetMinContentHeight :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> Int32 -> m ()
- scrolledWindowSetMinContentWidth :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> Int32 -> m ()
- scrolledWindowSetOverlayScrolling :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> Bool -> m ()
- scrolledWindowSetPlacement :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> CornerType -> m ()
- scrolledWindowSetPolicy :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> PolicyType -> PolicyType -> m ()
- scrolledWindowSetPropagateNaturalHeight :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> Bool -> m ()
- scrolledWindowSetPropagateNaturalWidth :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> Bool -> m ()
- scrolledWindowSetVadjustment :: (HasCallStack, MonadIO m, IsScrolledWindow a, IsAdjustment b) => a -> Maybe b -> m ()
- scrolledWindowUnsetPlacement :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m ()
- clearScrolledWindowChild :: (MonadIO m, IsScrolledWindow o) => o -> m ()
- constructScrolledWindowChild :: (IsScrolledWindow o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getScrolledWindowChild :: (MonadIO m, IsScrolledWindow o) => o -> m (Maybe Widget)
- setScrolledWindowChild :: (MonadIO m, IsScrolledWindow o, IsWidget a) => o -> a -> m ()
- clearScrolledWindowHadjustment :: (MonadIO m, IsScrolledWindow o) => o -> m ()
- constructScrolledWindowHadjustment :: (IsScrolledWindow o, MonadIO m, IsAdjustment a) => a -> m (GValueConstruct o)
- getScrolledWindowHadjustment :: (MonadIO m, IsScrolledWindow o) => o -> m Adjustment
- setScrolledWindowHadjustment :: (MonadIO m, IsScrolledWindow o, IsAdjustment a) => o -> a -> m ()
- constructScrolledWindowHasFrame :: (IsScrolledWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
- getScrolledWindowHasFrame :: (MonadIO m, IsScrolledWindow o) => o -> m Bool
- setScrolledWindowHasFrame :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m ()
- constructScrolledWindowHscrollbarPolicy :: (IsScrolledWindow o, MonadIO m) => PolicyType -> m (GValueConstruct o)
- getScrolledWindowHscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> m PolicyType
- setScrolledWindowHscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> PolicyType -> m ()
- constructScrolledWindowKineticScrolling :: (IsScrolledWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
- getScrolledWindowKineticScrolling :: (MonadIO m, IsScrolledWindow o) => o -> m Bool
- setScrolledWindowKineticScrolling :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m ()
- constructScrolledWindowMaxContentHeight :: (IsScrolledWindow o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getScrolledWindowMaxContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> m Int32
- setScrolledWindowMaxContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m ()
- constructScrolledWindowMaxContentWidth :: (IsScrolledWindow o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getScrolledWindowMaxContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> m Int32
- setScrolledWindowMaxContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m ()
- constructScrolledWindowMinContentHeight :: (IsScrolledWindow o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getScrolledWindowMinContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> m Int32
- setScrolledWindowMinContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m ()
- constructScrolledWindowMinContentWidth :: (IsScrolledWindow o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getScrolledWindowMinContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> m Int32
- setScrolledWindowMinContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m ()
- constructScrolledWindowOverlayScrolling :: (IsScrolledWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
- getScrolledWindowOverlayScrolling :: (MonadIO m, IsScrolledWindow o) => o -> m Bool
- setScrolledWindowOverlayScrolling :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m ()
- constructScrolledWindowPropagateNaturalHeight :: (IsScrolledWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
- getScrolledWindowPropagateNaturalHeight :: (MonadIO m, IsScrolledWindow o) => o -> m Bool
- setScrolledWindowPropagateNaturalHeight :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m ()
- constructScrolledWindowPropagateNaturalWidth :: (IsScrolledWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
- getScrolledWindowPropagateNaturalWidth :: (MonadIO m, IsScrolledWindow o) => o -> m Bool
- setScrolledWindowPropagateNaturalWidth :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m ()
- clearScrolledWindowVadjustment :: (MonadIO m, IsScrolledWindow o) => o -> m ()
- constructScrolledWindowVadjustment :: (IsScrolledWindow o, MonadIO m, IsAdjustment a) => a -> m (GValueConstruct o)
- getScrolledWindowVadjustment :: (MonadIO m, IsScrolledWindow o) => o -> m Adjustment
- setScrolledWindowVadjustment :: (MonadIO m, IsScrolledWindow o, IsAdjustment a) => o -> a -> m ()
- constructScrolledWindowVscrollbarPolicy :: (IsScrolledWindow o, MonadIO m) => PolicyType -> m (GValueConstruct o)
- getScrolledWindowVscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> m PolicyType
- setScrolledWindowVscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> PolicyType -> m ()
- constructScrolledWindowWindowPlacement :: (IsScrolledWindow o, MonadIO m) => CornerType -> m (GValueConstruct o)
- getScrolledWindowWindowPlacement :: (MonadIO m, IsScrolledWindow o) => o -> m CornerType
- setScrolledWindowWindowPlacement :: (MonadIO m, IsScrolledWindow o) => o -> CornerType -> m ()
- type ScrolledWindowEdgeOvershotCallback = PositionType -> IO ()
- afterScrolledWindowEdgeOvershot :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowEdgeOvershotCallback) -> m SignalHandlerId
- onScrolledWindowEdgeOvershot :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowEdgeOvershotCallback) -> m SignalHandlerId
- type ScrolledWindowEdgeReachedCallback = PositionType -> IO ()
- afterScrolledWindowEdgeReached :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowEdgeReachedCallback) -> m SignalHandlerId
- onScrolledWindowEdgeReached :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowEdgeReachedCallback) -> m SignalHandlerId
- type ScrolledWindowMoveFocusOutCallback = DirectionType -> IO ()
- afterScrolledWindowMoveFocusOut :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowMoveFocusOutCallback) -> m SignalHandlerId
- onScrolledWindowMoveFocusOut :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowMoveFocusOutCallback) -> m SignalHandlerId
- type ScrolledWindowScrollChildCallback = ScrollType -> Bool -> IO Bool
- afterScrolledWindowScrollChild :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowScrollChildCallback) -> m SignalHandlerId
- onScrolledWindowScrollChild :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowScrollChildCallback) -> m SignalHandlerId

# Exported types

newtype ScrolledWindow Source #

Memory-managed wrapper type.

Constructors

ScrolledWindow (ManagedPtr ScrolledWindow) |

#### Instances

Instances details

Eq ScrolledWindow Source # |
Instance details Defined in GI.Gtk.Objects.ScrolledWindow Methods (==) :: ScrolledWindow -> ScrolledWindow -> Bool Source # (/=) :: ScrolledWindow -> ScrolledWindow -> Bool Source #
GObject ScrolledWindow Source # |
Instance details Defined in GI.Gtk.Objects.ScrolledWindow
ManagedPtrNewtype ScrolledWindow Source # |
Instance details Defined in GI.Gtk.Objects.ScrolledWindow Methods toManagedPtr :: ScrolledWindow -> ManagedPtr ScrolledWindow Source #
TypedObject ScrolledWindow Source # |
Instance details Defined in GI.Gtk.Objects.ScrolledWindow Methods glibType :: IO GType Source #
HasParentTypes ScrolledWindow Source # |
Instance details Defined in GI.Gtk.Objects.ScrolledWindow
IsGValue (Maybe ScrolledWindow) Source # | Convert `ScrolledWindow` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.ScrolledWindow Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe ScrolledWindow -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe ScrolledWindow) Source #
type ParentTypes ScrolledWindow Source # |
Instance details Defined in GI.Gtk.Objects.ScrolledWindow type ParentTypes ScrolledWindow = '[Widget, Object, Accessible, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf ScrolledWindow o) => IsScrolledWindow o Source #

Type class for types which can be safely cast to `ScrolledWindow`, for instance with `toScrolledWindow`.

#### Instances

Instances details

(GObject o, IsDescendantOf ScrolledWindow o) => IsScrolledWindow o Source # |
Instance details Defined in GI.Gtk.Objects.ScrolledWindow

toScrolledWindow :: (MonadIO m, IsScrolledWindow o) => o -> m ScrolledWindow Source #

Cast to `ScrolledWindow`, for types for which this is known to be safe. For general casts, use `castTo`.

# Methods

### Click to display all available methods, including inherited ones

Expand

#### Methods

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, announce, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetPlacement, unsetStateFlags, updateNextAccessibleSibling, updatePlatformState, updateProperty, updateRelation, updateState, watchClosure.

#### Getters

getAccessibleId, getAccessibleParent, getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAtContext, getBaseline, getBounds, getBuildableId, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFirstAccessibleChild, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHadjustment, getHalign, getHasFrame, getHasTooltip, getHeight, getHexpand, getHexpandSet, getHscrollbar, getKineticScrolling, getLastChild, getLayoutManager, getLimitEvents, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMaxContentHeight, getMaxContentWidth, getMinContentHeight, getMinContentWidth, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOverflow, getOverlayScrolling, getPangoContext, getParent, getPlacement, getPlatformState, getPolicy, getPreferredSize, getPrevSibling, getPrimaryClipboard, getPropagateNaturalHeight, getPropagateNaturalWidth, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getVadjustment, getValign, getVexpand, getVexpandSet, getVisible, getVscrollbar, getWidth.

#### Setters

setAccessibleParent, setCanFocus, setCanTarget, setChild, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHadjustment, setHalign, setHasFrame, setHasTooltip, setHexpand, setHexpandSet, setKineticScrolling, setLayoutManager, setLimitEvents, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setMaxContentHeight, setMaxContentWidth, setMinContentHeight, setMinContentWidth, setName, setOpacity, setOverflow, setOverlayScrolling, setParent, setPlacement, setPolicy, setPropagateNaturalHeight, setPropagateNaturalWidth, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setVadjustment, setValign, setVexpand, setVexpandSet, setVisible.

## getChild

scrolledWindowGetChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m (Maybe Widget) | Returns: the child widget of `scrolledWindow`

Gets the child widget of `scrolledWindow`.

If the scrolled window automatically added a `Viewport`, this function will return the viewport widget, and you can retrieve its child using `viewportGetChild`.

## getHadjustment

scrolledWindowGetHadjustment Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m Adjustment | Returns: the horizontal `GtkAdjustment`

Returns the horizontal scrollbar’s adjustment.

This is the adjustment used to connect the horizontal scrollbar to the child widget’s horizontal scroll functionality.

## getHasFrame

scrolledWindowGetHasFrame Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m Bool | Returns: `True` if the `scrolledWindow` has a frame

Gets whether the scrolled window draws a frame.

## getHscrollbar

scrolledWindowGetHscrollbar Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m Widget | Returns: the horizontal scrollbar of the scrolled window.

Returns the horizontal scrollbar of `scrolledWindow`.

## getKineticScrolling

scrolledWindowGetKineticScrolling Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m Bool | Returns: the scrolling behavior flags.

Returns the specified kinetic scrolling behavior.

## getMaxContentHeight

scrolledWindowGetMaxContentHeight Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m Int32 | Returns: the maximum content height, or -1

Returns the maximum content height set.

## getMaxContentWidth

scrolledWindowGetMaxContentWidth Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m Int32 | Returns: the maximum content width, or -1

Returns the maximum content width set.

## getMinContentHeight

scrolledWindowGetMinContentHeight Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m Int32 | Returns: the minimal content height

Gets the minimal content height of `scrolledWindow`.

## getMinContentWidth

scrolledWindowGetMinContentWidth Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m Int32 | Returns: the minimum content width

Gets the minimum content width of `scrolledWindow`.

## getOverlayScrolling

scrolledWindowGetOverlayScrolling Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m Bool | Returns: `True` if overlay scrolling is enabled

Returns whether overlay scrolling is enabled for this scrolled window.

## getPlacement

scrolledWindowGetPlacement Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m CornerType | Returns: the current placement value.

Gets the placement of the contents with respect to the scrollbars.

## getPolicy

scrolledWindowGetPolicy Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m (PolicyType, PolicyType) |

Retrieves the current policy values for the horizontal and vertical scrollbars.

See `scrolledWindowSetPolicy`.

## getPropagateNaturalHeight

scrolledWindowGetPropagateNaturalHeight Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m Bool | Returns: whether natural height propagation is enabled.

Reports whether the natural height of the child will be calculated and propagated through the scrolled window’s requested natural height.

## getPropagateNaturalWidth

scrolledWindowGetPropagateNaturalWidth Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m Bool | Returns: whether natural width propagation is enabled.

Reports whether the natural width of the child will be calculated and propagated through the scrolled window’s requested natural width.

## getVadjustment

scrolledWindowGetVadjustment Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m Adjustment | Returns: the vertical `GtkAdjustment`

Returns the vertical scrollbar’s adjustment.

This is the adjustment used to connect the vertical scrollbar to the child widget’s vertical scroll functionality.

## getVscrollbar

scrolledWindowGetVscrollbar Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m Widget | Returns: the vertical scrollbar of the scrolled window.

Returns the vertical scrollbar of `scrolledWindow`.

## new

scrolledWindowNew Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> m ScrolledWindow | Returns: a new scrolled window

Creates a new scrolled window.

## setChild

scrolledWindowSetChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a, IsWidget b) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> Maybe b | `child`: the child widget
-> m () |

Sets the child widget of `scrolledWindow`.

If `child` does not implement the `Scrollable` interface, the scrolled window will add `child` to a `Viewport` instance and then add the viewport as its child widget.

## setHadjustment

scrolledWindowSetHadjustment Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a, IsAdjustment b) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> Maybe b | `hadjustment`: the `GtkAdjustment` to use, or `Nothing` to create a new one
-> m () |

Sets the `GtkAdjustment` for the horizontal scrollbar.

## setHasFrame

scrolledWindowSetHasFrame Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> Bool | `hasFrame`: whether to draw a frame around scrolled window contents
-> m () |

Changes the frame drawn around the contents of `scrolledWindow`.

## setKineticScrolling

scrolledWindowSetKineticScrolling Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> Bool | `kineticScrolling`: `True` to enable kinetic scrolling
-> m () |

Turns kinetic scrolling on or off.

Kinetic scrolling only applies to devices with source `InputSourceTouchscreen`.

## setMaxContentHeight

scrolledWindowSetMaxContentHeight Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> Int32 | `height`: the maximum content height
-> m () |

Sets the maximum height that `scrolledWindow` should keep visible.

The `scrolledWindow` will grow up to this height before it starts scrolling the content.

It is a programming error to set the maximum content height to a value smaller than ScrolledWindow:minContentHeight.

## setMaxContentWidth

scrolledWindowSetMaxContentWidth Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> Int32 | `width`: the maximum content width
-> m () |

Sets the maximum width that `scrolledWindow` should keep visible.

The `scrolledWindow` will grow up to this width before it starts scrolling the content.

It is a programming error to set the maximum content width to a value smaller than ScrolledWindow:minContentWidth.

## setMinContentHeight

scrolledWindowSetMinContentHeight Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> Int32 | `height`: the minimal content height
-> m () |

Sets the minimum height that `scrolledWindow` should keep visible.

Note that this can and (usually will) be smaller than the minimum size of the content.

It is a programming error to set the minimum content height to a value greater than ScrolledWindow:maxContentHeight.

## setMinContentWidth

scrolledWindowSetMinContentWidth Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> Int32 | `width`: the minimal content width
-> m () |

Sets the minimum width that `scrolledWindow` should keep visible.

Note that this can and (usually will) be smaller than the minimum size of the content.

It is a programming error to set the minimum content width to a value greater than ScrolledWindow:maxContentWidth.

## setOverlayScrolling

scrolledWindowSetOverlayScrolling Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> Bool | `overlayScrolling`: whether to enable overlay scrolling
-> m () |

Enables or disables overlay scrolling for this scrolled window.

## setPlacement

scrolledWindowSetPlacement Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> CornerType | `windowPlacement`: position of the child window
-> m () |

Sets the placement of the contents with respect to the scrollbars for the scrolled window.

The default is `CornerTypeTopLeft`, meaning the child is in the top left, with the scrollbars underneath and to the right. Other values in `CornerType` are `CornerTypeTopRight`, `CornerTypeBottomLeft`, and `CornerTypeBottomRight`.

See also `scrolledWindowGetPlacement` and `scrolledWindowUnsetPlacement`.

## setPolicy

scrolledWindowSetPolicy Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> PolicyType | `hscrollbarPolicy`: policy for horizontal bar
-> PolicyType | `vscrollbarPolicy`: policy for vertical bar
-> m () |

Sets the scrollbar policy for the horizontal and vertical scrollbars.

The policy determines when the scrollbar should appear; it is a value from the `PolicyType` enumeration. If `PolicyTypeAlways`, the scrollbar is always present; if `PolicyTypeNever`, the scrollbar is never present; if `PolicyTypeAutomatic`, the scrollbar is present only if needed (that is, if the slider part of the bar would be smaller than the trough — the display is larger than the page size).

## setPropagateNaturalHeight

scrolledWindowSetPropagateNaturalHeight Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> Bool | `propagate`: whether to propagate natural height
-> m () |

Sets whether the natural height of the child should be calculated and propagated through the scrolled window’s requested natural height.

## setPropagateNaturalWidth

scrolledWindowSetPropagateNaturalWidth Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> Bool | `propagate`: whether to propagate natural width
-> m () |

Sets whether the natural width of the child should be calculated and propagated through the scrolled window’s requested natural width.

## setVadjustment

scrolledWindowSetVadjustment Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a, IsAdjustment b) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> Maybe b | `vadjustment`: the `GtkAdjustment` to use, or `Nothing` to create a new one
-> m () |

Sets the `GtkAdjustment` for the vertical scrollbar.

## unsetPlacement

scrolledWindowUnsetPlacement Source #

Arguments

:: (HasCallStack, MonadIO m, IsScrolledWindow a) |
=> a | `scrolledWindow`: a `GtkScrolledWindow`
-> m () |

Unsets the placement of the contents with respect to the scrollbars.

If no window placement is set for a scrolled window, it defaults to `CornerTypeTopLeft`.

# Properties

## child

The child widget.

When setting this property, if the child widget does not implement `Scrollable`, the scrolled window will add the child to a `Viewport` and then set the viewport as the child.

clearScrolledWindowChild :: (MonadIO m, IsScrolledWindow o) => o -> m () Source #

Set the value of the “`child`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #child

constructScrolledWindowChild :: (IsScrolledWindow o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`child`” property. This is rarely needed directly, but it is used by `new`.

getScrolledWindowChild :: (MonadIO m, IsScrolledWindow o) => o -> m (Maybe Widget) Source #

Get the value of the “`child`” property. When overloading is enabled, this is equivalent to

    get scrolledWindow #child

setScrolledWindowChild :: (MonadIO m, IsScrolledWindow o, IsWidget a) => o -> a -> m () Source #

Set the value of the “`child`” property. When overloading is enabled, this is equivalent to

    set scrolledWindow [ #child := value ]

## hadjustment

The `GtkAdjustment` for the horizontal position.

clearScrolledWindowHadjustment :: (MonadIO m, IsScrolledWindow o) => o -> m () Source #

Set the value of the “`hadjustment`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #hadjustment

constructScrolledWindowHadjustment :: (IsScrolledWindow o, MonadIO m, IsAdjustment a) => a -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`hadjustment`” property. This is rarely needed directly, but it is used by `new`.

getScrolledWindowHadjustment :: (MonadIO m, IsScrolledWindow o) => o -> m Adjustment Source #

Get the value of the “`hadjustment`” property. When overloading is enabled, this is equivalent to

    get scrolledWindow #hadjustment

setScrolledWindowHadjustment :: (MonadIO m, IsScrolledWindow o, IsAdjustment a) => o -> a -> m () Source #

Set the value of the “`hadjustment`” property. When overloading is enabled, this is equivalent to

    set scrolledWindow [ #hadjustment := value ]

## hasFrame

Whether to draw a frame around the contents.

constructScrolledWindowHasFrame :: (IsScrolledWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`has-frame`” property. This is rarely needed directly, but it is used by `new`.

getScrolledWindowHasFrame :: (MonadIO m, IsScrolledWindow o) => o -> m Bool Source #

Get the value of the “`has-frame`” property. When overloading is enabled, this is equivalent to

    get scrolledWindow #hasFrame

setScrolledWindowHasFrame :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m () Source #

Set the value of the “`has-frame`” property. When overloading is enabled, this is equivalent to

    set scrolledWindow [ #hasFrame := value ]

## hscrollbarPolicy

When the horizontal scrollbar is displayed.

Use `scrolledWindowSetPolicy` to set this property.

constructScrolledWindowHscrollbarPolicy :: (IsScrolledWindow o, MonadIO m) => PolicyType -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`hscrollbar-policy`” property. This is rarely needed directly, but it is used by `new`.

getScrolledWindowHscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> m PolicyType Source #

Get the value of the “`hscrollbar-policy`” property. When overloading is enabled, this is equivalent to

    get scrolledWindow #hscrollbarPolicy

setScrolledWindowHscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> PolicyType -> m () Source #

Set the value of the “`hscrollbar-policy`” property. When overloading is enabled, this is equivalent to

    set scrolledWindow [ #hscrollbarPolicy := value ]

## kineticScrolling

Whether kinetic scrolling is enabled or not.

Kinetic scrolling only applies to devices with source `InputSourceTouchscreen`.

constructScrolledWindowKineticScrolling :: (IsScrolledWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`kinetic-scrolling`” property. This is rarely needed directly, but it is used by `new`.

getScrolledWindowKineticScrolling :: (MonadIO m, IsScrolledWindow o) => o -> m Bool Source #

Get the value of the “`kinetic-scrolling`” property. When overloading is enabled, this is equivalent to

    get scrolledWindow #kineticScrolling

setScrolledWindowKineticScrolling :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m () Source #

Set the value of the “`kinetic-scrolling`” property. When overloading is enabled, this is equivalent to

    set scrolledWindow [ #kineticScrolling := value ]

## maxContentHeight

The maximum content height of `scrolledWindow`.

constructScrolledWindowMaxContentHeight :: (IsScrolledWindow o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`max-content-height`” property. This is rarely needed directly, but it is used by `new`.

getScrolledWindowMaxContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> m Int32 Source #

Get the value of the “`max-content-height`” property. When overloading is enabled, this is equivalent to

    get scrolledWindow #maxContentHeight

setScrolledWindowMaxContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m () Source #

Set the value of the “`max-content-height`” property. When overloading is enabled, this is equivalent to

    set scrolledWindow [ #maxContentHeight := value ]

## maxContentWidth

The maximum content width of `scrolledWindow`.

constructScrolledWindowMaxContentWidth :: (IsScrolledWindow o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`max-content-width`” property. This is rarely needed directly, but it is used by `new`.

getScrolledWindowMaxContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> m Int32 Source #

Get the value of the “`max-content-width`” property. When overloading is enabled, this is equivalent to

    get scrolledWindow #maxContentWidth

setScrolledWindowMaxContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m () Source #

Set the value of the “`max-content-width`” property. When overloading is enabled, this is equivalent to

    set scrolledWindow [ #maxContentWidth := value ]

## minContentHeight

The minimum content height of `scrolledWindow`.

constructScrolledWindowMinContentHeight :: (IsScrolledWindow o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`min-content-height`” property. This is rarely needed directly, but it is used by `new`.

getScrolledWindowMinContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> m Int32 Source #

Get the value of the “`min-content-height`” property. When overloading is enabled, this is equivalent to

    get scrolledWindow #minContentHeight

setScrolledWindowMinContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m () Source #

Set the value of the “`min-content-height`” property. When overloading is enabled, this is equivalent to

    set scrolledWindow [ #minContentHeight := value ]

## minContentWidth

The minimum content width of `scrolledWindow`.

constructScrolledWindowMinContentWidth :: (IsScrolledWindow o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`min-content-width`” property. This is rarely needed directly, but it is used by `new`.

getScrolledWindowMinContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> m Int32 Source #

Get the value of the “`min-content-width`” property. When overloading is enabled, this is equivalent to

    get scrolledWindow #minContentWidth

setScrolledWindowMinContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m () Source #

Set the value of the “`min-content-width`” property. When overloading is enabled, this is equivalent to

    set scrolledWindow [ #minContentWidth := value ]

## overlayScrolling

Whether overlay scrolling is enabled or not.

If it is, the scrollbars are only added as traditional widgets when a mouse is present. Otherwise, they are overlaid on top of the content, as narrow indicators.

Note that overlay scrolling can also be globally disabled, with the Settings:gtkOverlayScrolling setting.

constructScrolledWindowOverlayScrolling :: (IsScrolledWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`overlay-scrolling`” property. This is rarely needed directly, but it is used by `new`.

getScrolledWindowOverlayScrolling :: (MonadIO m, IsScrolledWindow o) => o -> m Bool Source #

Get the value of the “`overlay-scrolling`” property. When overloading is enabled, this is equivalent to

    get scrolledWindow #overlayScrolling

setScrolledWindowOverlayScrolling :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m () Source #

Set the value of the “`overlay-scrolling`” property. When overloading is enabled, this is equivalent to

    set scrolledWindow [ #overlayScrolling := value ]

## propagateNaturalHeight

Whether the natural height of the child should be calculated and propagated through the scrolled window’s requested natural height.

This is useful in cases where an attempt should be made to allocate exactly enough space for the natural size of the child.

constructScrolledWindowPropagateNaturalHeight :: (IsScrolledWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`propagate-natural-height`” property. This is rarely needed directly, but it is used by `new`.

getScrolledWindowPropagateNaturalHeight :: (MonadIO m, IsScrolledWindow o) => o -> m Bool Source #

Get the value of the “`propagate-natural-height`” property. When overloading is enabled, this is equivalent to

    get scrolledWindow #propagateNaturalHeight

setScrolledWindowPropagateNaturalHeight :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m () Source #

Set the value of the “`propagate-natural-height`” property. When overloading is enabled, this is equivalent to

    set scrolledWindow [ #propagateNaturalHeight := value ]

## propagateNaturalWidth

Whether the natural width of the child should be calculated and propagated through the scrolled window’s requested natural width.

This is useful in cases where an attempt should be made to allocate exactly enough space for the natural size of the child.

constructScrolledWindowPropagateNaturalWidth :: (IsScrolledWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`propagate-natural-width`” property. This is rarely needed directly, but it is used by `new`.

getScrolledWindowPropagateNaturalWidth :: (MonadIO m, IsScrolledWindow o) => o -> m Bool Source #

Get the value of the “`propagate-natural-width`” property. When overloading is enabled, this is equivalent to

    get scrolledWindow #propagateNaturalWidth

setScrolledWindowPropagateNaturalWidth :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m () Source #

Set the value of the “`propagate-natural-width`” property. When overloading is enabled, this is equivalent to

    set scrolledWindow [ #propagateNaturalWidth := value ]

## vadjustment

The `GtkAdjustment` for the vertical position.

clearScrolledWindowVadjustment :: (MonadIO m, IsScrolledWindow o) => o -> m () Source #

Set the value of the “`vadjustment`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #vadjustment

constructScrolledWindowVadjustment :: (IsScrolledWindow o, MonadIO m, IsAdjustment a) => a -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`vadjustment`” property. This is rarely needed directly, but it is used by `new`.

getScrolledWindowVadjustment :: (MonadIO m, IsScrolledWindow o) => o -> m Adjustment Source #

Get the value of the “`vadjustment`” property. When overloading is enabled, this is equivalent to

    get scrolledWindow #vadjustment

setScrolledWindowVadjustment :: (MonadIO m, IsScrolledWindow o, IsAdjustment a) => o -> a -> m () Source #

Set the value of the “`vadjustment`” property. When overloading is enabled, this is equivalent to

    set scrolledWindow [ #vadjustment := value ]

## vscrollbarPolicy

When the vertical scrollbar is displayed.

Use `scrolledWindowSetPolicy` to set this property.

constructScrolledWindowVscrollbarPolicy :: (IsScrolledWindow o, MonadIO m) => PolicyType -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`vscrollbar-policy`” property. This is rarely needed directly, but it is used by `new`.

getScrolledWindowVscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> m PolicyType Source #

Get the value of the “`vscrollbar-policy`” property. When overloading is enabled, this is equivalent to

    get scrolledWindow #vscrollbarPolicy

setScrolledWindowVscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> PolicyType -> m () Source #

Set the value of the “`vscrollbar-policy`” property. When overloading is enabled, this is equivalent to

    set scrolledWindow [ #vscrollbarPolicy := value ]

## windowPlacement

Where the contents are located with respect to the scrollbars.

constructScrolledWindowWindowPlacement :: (IsScrolledWindow o, MonadIO m) => CornerType -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`window-placement`” property. This is rarely needed directly, but it is used by `new`.

getScrolledWindowWindowPlacement :: (MonadIO m, IsScrolledWindow o) => o -> m CornerType Source #

Get the value of the “`window-placement`” property. When overloading is enabled, this is equivalent to

    get scrolledWindow #windowPlacement

setScrolledWindowWindowPlacement :: (MonadIO m, IsScrolledWindow o) => o -> CornerType -> m () Source #

Set the value of the “`window-placement`” property. When overloading is enabled, this is equivalent to

    set scrolledWindow [ #windowPlacement := value ]

# Signals

## edgeOvershot

type ScrolledWindowEdgeOvershotCallback Source #

Arguments

= PositionType | `pos`: edge side that was hit
-> IO () |

Emitted whenever user initiated scrolling makes the scrolled window firmly surpass the limits defined by the adjustment in that orientation.

A similar behavior without edge resistance is provided by the ScrolledWindow::edgeReached signal.

Note: The `pos` argument is LTR/RTL aware, so callers should be aware too if intending to provide behavior on horizontal edges.

afterScrolledWindowEdgeOvershot :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowEdgeOvershotCallback) -> m SignalHandlerId Source #

Connect a signal handler for the edgeOvershot signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after scrolledWindow #edgeOvershot callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onScrolledWindowEdgeOvershot :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowEdgeOvershotCallback) -> m SignalHandlerId Source #

Connect a signal handler for the edgeOvershot signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on scrolledWindow #edgeOvershot callback

## edgeReached

type ScrolledWindowEdgeReachedCallback Source #

Arguments

= PositionType | `pos`: edge side that was reached
-> IO () |

Emitted whenever user-initiated scrolling makes the scrolled window exactly reach the lower or upper limits defined by the adjustment in that orientation.

A similar behavior with edge resistance is provided by the ScrolledWindow::edgeOvershot signal.

Note: The `pos` argument is LTR/RTL aware, so callers should be aware too if intending to provide behavior on horizontal edges.

afterScrolledWindowEdgeReached :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowEdgeReachedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the edgeReached signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after scrolledWindow #edgeReached callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onScrolledWindowEdgeReached :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowEdgeReachedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the edgeReached signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on scrolledWindow #edgeReached callback

## moveFocusOut

type ScrolledWindowMoveFocusOutCallback Source #

Arguments

= DirectionType | `directionType`: either `DirectionTypeTabForward` or `DirectionTypeTabBackward`
-> IO () |

Emitted when focus is moved away from the scrolled window by a keybinding.

This is a keybinding signal.

The default bindings for this signal are <kbd>Ctrl</kbd>+<kbd>Tab</kbd> to move forward and <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Tab</kbd>` to move backward.

afterScrolledWindowMoveFocusOut :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowMoveFocusOutCallback) -> m SignalHandlerId Source #

Connect a signal handler for the moveFocusOut signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after scrolledWindow #moveFocusOut callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onScrolledWindowMoveFocusOut :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowMoveFocusOutCallback) -> m SignalHandlerId Source #

Connect a signal handler for the moveFocusOut signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on scrolledWindow #moveFocusOut callback

## scrollChild

type ScrolledWindowScrollChildCallback Source #

Arguments

= ScrollType | `scroll`: a `GtkScrollType` describing how much to scroll
-> Bool | `horizontal`: whether the keybinding scrolls the child horizontally or not
-> IO Bool | Returns: whether the scroll happened

Emitted when a keybinding that scrolls is pressed.

This is a keybinding signal.

The horizontal or vertical adjustment is updated which triggers a signal that the scrolled window’s child may listen to and scroll itself.

afterScrolledWindowScrollChild :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowScrollChildCallback) -> m SignalHandlerId Source #

Connect a signal handler for the scrollChild signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after scrolledWindow #scrollChild callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onScrolledWindowScrollChild :: (IsScrolledWindow a, MonadIO m) => a -> ((?self :: a) => ScrolledWindowScrollChildCallback) -> m SignalHandlerId Source #

Connect a signal handler for the scrollChild signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on scrolledWindow #scrollChild callback