Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
GI.Gtk.Objects.ScrolledWindow
Contents
- Exported types
- Methods
- addWithViewport
- getCaptureButtonPress
- getHadjustment
- getHscrollbar
- getKineticScrolling
- getMaxContentHeight
- getMaxContentWidth
- getMinContentHeight
- getMinContentWidth
- getOverlayScrolling
- getPlacement
- getPolicy
- getPropagateNaturalHeight
- getPropagateNaturalWidth
- getShadowType
- getVadjustment
- getVscrollbar
- new
- setCaptureButtonPress
- setHadjustment
- setKineticScrolling
- setMaxContentHeight
- setMaxContentWidth
- setMinContentHeight
- setMinContentWidth
- setOverlayScrolling
- setPlacement
- setPolicy
- setPropagateNaturalHeight
- setPropagateNaturalWidth
- setShadowType
- setVadjustment
- unsetPlacement
- Properties
- Signals
Description
GtkScrolledWindow is a container that accepts a single child widget, makes that child scrollable 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.
GtkScrolledWindow’s implementation of containerAdd
intelligently
accounts for whether or not the added child is a Scrollable
. If it isn’t,
ScrolledWindow
wraps the child in a Viewport
and adds that for you.
Therefore, you can just add any child widget and not worry about the details.
If containerAdd
has added a Viewport
for you, you can remove
both your added child widget from the Viewport
, and the Viewport
from the GtkScrolledWindow, with either of these calls:
C code
gtk_container_remove (GTK_CONTAINER (scrolled_window), child_widget); // or gtk_container_remove (GTK_CONTAINER (scrolled_window), gtk_bin_get_child (GTK_BIN (scrolled_window)));
Unless ScrolledWindow
:policy
is GTK_POLICY_NEVER or GTK_POLICY_EXTERNAL,
GtkScrolledWindow adds internal Scrollbar
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 Scrollbar
and for example a Grid
.
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
:kinetic-scrolling
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
::edge-overshot
signal.
If no mouse device is present, the scrollbars will overlayed 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
:overlay-scrolling
property.
CSS nodes
GtkScrolledWindow has a main CSS node with name scrolledwindow.
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.
- newtype ScrolledWindow = ScrolledWindow (ManagedPtr ScrolledWindow)
- class GObject o => IsScrolledWindow o
- toScrolledWindow :: (MonadIO m, IsScrolledWindow o) => o -> m ScrolledWindow
- noScrolledWindow :: Maybe ScrolledWindow
- scrolledWindowAddWithViewport :: (HasCallStack, MonadIO m, IsScrolledWindow a, IsWidget b) => a -> b -> m ()
- scrolledWindowGetCaptureButtonPress :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Bool
- scrolledWindowGetHadjustment :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Adjustment
- 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
- scrolledWindowGetShadowType :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m ShadowType
- scrolledWindowGetVadjustment :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Adjustment
- scrolledWindowGetVscrollbar :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m Widget
- scrolledWindowNew :: (HasCallStack, MonadIO m, IsAdjustment a, IsAdjustment b) => Maybe a -> Maybe b -> m ScrolledWindow
- scrolledWindowSetCaptureButtonPress :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> Bool -> m ()
- scrolledWindowSetHadjustment :: (HasCallStack, MonadIO m, IsScrolledWindow a, IsAdjustment b) => a -> b -> 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 ()
- scrolledWindowSetShadowType :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> ShadowType -> m ()
- scrolledWindowSetVadjustment :: (HasCallStack, MonadIO m, IsScrolledWindow a, IsAdjustment b) => a -> b -> m ()
- scrolledWindowUnsetPlacement :: (HasCallStack, MonadIO m, IsScrolledWindow a) => a -> m ()
- constructScrolledWindowHadjustment :: (IsScrolledWindow o, IsAdjustment a) => a -> IO (GValueConstruct o)
- getScrolledWindowHadjustment :: (MonadIO m, IsScrolledWindow o) => o -> m Adjustment
- setScrolledWindowHadjustment :: (MonadIO m, IsScrolledWindow o, IsAdjustment a) => o -> a -> m ()
- constructScrolledWindowHscrollbarPolicy :: IsScrolledWindow o => PolicyType -> IO (GValueConstruct o)
- getScrolledWindowHscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> m PolicyType
- setScrolledWindowHscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> PolicyType -> m ()
- constructScrolledWindowKineticScrolling :: IsScrolledWindow o => Bool -> IO (GValueConstruct o)
- getScrolledWindowKineticScrolling :: (MonadIO m, IsScrolledWindow o) => o -> m Bool
- setScrolledWindowKineticScrolling :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m ()
- constructScrolledWindowMaxContentHeight :: IsScrolledWindow o => Int32 -> IO (GValueConstruct o)
- getScrolledWindowMaxContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> m Int32
- setScrolledWindowMaxContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m ()
- constructScrolledWindowMaxContentWidth :: IsScrolledWindow o => Int32 -> IO (GValueConstruct o)
- getScrolledWindowMaxContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> m Int32
- setScrolledWindowMaxContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m ()
- constructScrolledWindowMinContentHeight :: IsScrolledWindow o => Int32 -> IO (GValueConstruct o)
- getScrolledWindowMinContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> m Int32
- setScrolledWindowMinContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m ()
- constructScrolledWindowMinContentWidth :: IsScrolledWindow o => Int32 -> IO (GValueConstruct o)
- getScrolledWindowMinContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> m Int32
- setScrolledWindowMinContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m ()
- constructScrolledWindowOverlayScrolling :: IsScrolledWindow o => Bool -> IO (GValueConstruct o)
- getScrolledWindowOverlayScrolling :: (MonadIO m, IsScrolledWindow o) => o -> m Bool
- setScrolledWindowOverlayScrolling :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m ()
- constructScrolledWindowPropagateNaturalHeight :: IsScrolledWindow o => Bool -> IO (GValueConstruct o)
- getScrolledWindowPropagateNaturalHeight :: (MonadIO m, IsScrolledWindow o) => o -> m Bool
- setScrolledWindowPropagateNaturalHeight :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m ()
- constructScrolledWindowPropagateNaturalWidth :: IsScrolledWindow o => Bool -> IO (GValueConstruct o)
- getScrolledWindowPropagateNaturalWidth :: (MonadIO m, IsScrolledWindow o) => o -> m Bool
- setScrolledWindowPropagateNaturalWidth :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m ()
- constructScrolledWindowShadowType :: IsScrolledWindow o => ShadowType -> IO (GValueConstruct o)
- getScrolledWindowShadowType :: (MonadIO m, IsScrolledWindow o) => o -> m ShadowType
- setScrolledWindowShadowType :: (MonadIO m, IsScrolledWindow o) => o -> ShadowType -> m ()
- constructScrolledWindowVadjustment :: (IsScrolledWindow o, IsAdjustment a) => a -> IO (GValueConstruct o)
- getScrolledWindowVadjustment :: (MonadIO m, IsScrolledWindow o) => o -> m Adjustment
- setScrolledWindowVadjustment :: (MonadIO m, IsScrolledWindow o, IsAdjustment a) => o -> a -> m ()
- constructScrolledWindowVscrollbarPolicy :: IsScrolledWindow o => PolicyType -> IO (GValueConstruct o)
- getScrolledWindowVscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> m PolicyType
- setScrolledWindowVscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> PolicyType -> m ()
- constructScrolledWindowWindowPlacement :: IsScrolledWindow o => CornerType -> IO (GValueConstruct o)
- getScrolledWindowWindowPlacement :: (MonadIO m, IsScrolledWindow o) => o -> m CornerType
- setScrolledWindowWindowPlacement :: (MonadIO m, IsScrolledWindow o) => o -> CornerType -> m ()
- constructScrolledWindowWindowPlacementSet :: IsScrolledWindow o => Bool -> IO (GValueConstruct o)
- getScrolledWindowWindowPlacementSet :: (MonadIO m, IsScrolledWindow o) => o -> m Bool
- setScrolledWindowWindowPlacementSet :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m ()
- type C_ScrolledWindowEdgeOvershotCallback = Ptr () -> CUInt -> Ptr () -> IO ()
- type ScrolledWindowEdgeOvershotCallback = PositionType -> IO ()
- afterScrolledWindowEdgeOvershot :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowEdgeOvershotCallback -> m SignalHandlerId
- genClosure_ScrolledWindowEdgeOvershot :: ScrolledWindowEdgeOvershotCallback -> IO Closure
- mk_ScrolledWindowEdgeOvershotCallback :: C_ScrolledWindowEdgeOvershotCallback -> IO (FunPtr C_ScrolledWindowEdgeOvershotCallback)
- noScrolledWindowEdgeOvershotCallback :: Maybe ScrolledWindowEdgeOvershotCallback
- onScrolledWindowEdgeOvershot :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowEdgeOvershotCallback -> m SignalHandlerId
- wrap_ScrolledWindowEdgeOvershotCallback :: ScrolledWindowEdgeOvershotCallback -> Ptr () -> CUInt -> Ptr () -> IO ()
- type C_ScrolledWindowEdgeReachedCallback = Ptr () -> CUInt -> Ptr () -> IO ()
- type ScrolledWindowEdgeReachedCallback = PositionType -> IO ()
- afterScrolledWindowEdgeReached :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowEdgeReachedCallback -> m SignalHandlerId
- genClosure_ScrolledWindowEdgeReached :: ScrolledWindowEdgeReachedCallback -> IO Closure
- mk_ScrolledWindowEdgeReachedCallback :: C_ScrolledWindowEdgeReachedCallback -> IO (FunPtr C_ScrolledWindowEdgeReachedCallback)
- noScrolledWindowEdgeReachedCallback :: Maybe ScrolledWindowEdgeReachedCallback
- onScrolledWindowEdgeReached :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowEdgeReachedCallback -> m SignalHandlerId
- wrap_ScrolledWindowEdgeReachedCallback :: ScrolledWindowEdgeReachedCallback -> Ptr () -> CUInt -> Ptr () -> IO ()
- type C_ScrolledWindowMoveFocusOutCallback = Ptr () -> CUInt -> Ptr () -> IO ()
- type ScrolledWindowMoveFocusOutCallback = DirectionType -> IO ()
- afterScrolledWindowMoveFocusOut :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowMoveFocusOutCallback -> m SignalHandlerId
- genClosure_ScrolledWindowMoveFocusOut :: ScrolledWindowMoveFocusOutCallback -> IO Closure
- mk_ScrolledWindowMoveFocusOutCallback :: C_ScrolledWindowMoveFocusOutCallback -> IO (FunPtr C_ScrolledWindowMoveFocusOutCallback)
- noScrolledWindowMoveFocusOutCallback :: Maybe ScrolledWindowMoveFocusOutCallback
- onScrolledWindowMoveFocusOut :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowMoveFocusOutCallback -> m SignalHandlerId
- wrap_ScrolledWindowMoveFocusOutCallback :: ScrolledWindowMoveFocusOutCallback -> Ptr () -> CUInt -> Ptr () -> IO ()
- type C_ScrolledWindowScrollChildCallback = Ptr () -> CUInt -> CInt -> Ptr () -> IO CInt
- type ScrolledWindowScrollChildCallback = ScrollType -> Bool -> IO Bool
- afterScrolledWindowScrollChild :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowScrollChildCallback -> m SignalHandlerId
- genClosure_ScrolledWindowScrollChild :: ScrolledWindowScrollChildCallback -> IO Closure
- mk_ScrolledWindowScrollChildCallback :: C_ScrolledWindowScrollChildCallback -> IO (FunPtr C_ScrolledWindowScrollChildCallback)
- noScrolledWindowScrollChildCallback :: Maybe ScrolledWindowScrollChildCallback
- onScrolledWindowScrollChild :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowScrollChildCallback -> m SignalHandlerId
- wrap_ScrolledWindowScrollChildCallback :: ScrolledWindowScrollChildCallback -> Ptr () -> CUInt -> CInt -> Ptr () -> IO CInt
Exported types
newtype ScrolledWindow Source #
Constructors
ScrolledWindow (ManagedPtr ScrolledWindow) |
class GObject o => IsScrolledWindow o Source #
toScrolledWindow :: (MonadIO m, IsScrolledWindow o) => o -> m ScrolledWindow Source #
Methods
addWithViewport
scrolledWindowAddWithViewport Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a, IsWidget b) | |
=> a |
|
-> b |
|
-> m () |
Deprecated: (Since version 3.8)containerAdd
will automatically adda Viewport
if the child doesn’t implement Scrollable
.
Used to add children without native scrolling capabilities. This
is simply a convenience function; it is equivalent to adding the
unscrollable child to a viewport, then adding the viewport to the
scrolled window. If a child has native scrolling, use
containerAdd
instead of this function.
The viewport scrolls the child by moving its Window
, and takes
the size of the child to be the size of its toplevel Window
.
This will be very wrong for most widgets that support native scrolling;
for example, if you add a widget such as TreeView
with a viewport,
the whole widget will scroll, including the column headings. Thus,
widgets with native scrolling support should not be used with the
Viewport
proxy.
A widget supports scrolling natively if it implements the
Scrollable
interface.
getCaptureButtonPress
scrolledWindowGetCaptureButtonPress Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> m Bool | Returns: |
Return whether button presses are captured during kinetic
scrolling. See scrolledWindowSetCaptureButtonPress
.
Since: 3.4
getHadjustment
scrolledWindowGetHadjustment Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> m Adjustment | Returns: the horizontal |
Returns the horizontal scrollbar’s adjustment, used to connect the horizontal scrollbar to the child widget’s horizontal scroll functionality.
getHscrollbar
scrolledWindowGetHscrollbar Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> m Widget | Returns: the horizontal scrollbar of the scrolled window. |
Returns the horizontal scrollbar of scrolledWindow
.
Since: 2.8
getKineticScrolling
scrolledWindowGetKineticScrolling Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> m Bool | Returns: the scrolling behavior flags. |
Returns the specified kinetic scrolling behavior.
Since: 3.4
getMaxContentHeight
scrolledWindowGetMaxContentHeight Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> m Int32 | Returns: the maximum content height, or -1 |
Returns the maximum content height set.
Since: 3.22
getMaxContentWidth
scrolledWindowGetMaxContentWidth Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> m Int32 | Returns: the maximum content width, or -1 |
Returns the maximum content width set.
Since: 3.22
getMinContentHeight
scrolledWindowGetMinContentHeight Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> m Int32 | Returns: the minimal content height |
Gets the minimal content height of scrolledWindow
, or -1 if not set.
Since: 3.0
getMinContentWidth
scrolledWindowGetMinContentWidth Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> m Int32 | Returns: the minimum content width |
Gets the minimum content width of scrolledWindow
, or -1 if not set.
Since: 3.0
getOverlayScrolling
scrolledWindowGetOverlayScrolling Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether overlay scrolling is enabled for this scrolled window.
Since: 3.16
getPlacement
scrolledWindowGetPlacement Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> m CornerType | Returns: the current placement value. See also |
Gets the placement of the contents with respect to the scrollbars
for the scrolled window. See scrolledWindowSetPlacement
.
getPolicy
scrolledWindowGetPolicy Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> 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 |
|
-> 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 windows requested natural height.
Since: 3.22
getPropagateNaturalWidth
scrolledWindowGetPropagateNaturalWidth Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> 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 windows requested natural width.
Since: 3.22
getShadowType
scrolledWindowGetShadowType Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> m ShadowType | Returns: the current shadow type |
Gets the shadow type of the scrolled window. See
scrolledWindowSetShadowType
.
getVadjustment
scrolledWindowGetVadjustment Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> m Adjustment | Returns: the vertical |
Returns the vertical scrollbar’s 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 |
|
-> m Widget | Returns: the vertical scrollbar of the scrolled window. |
Returns the vertical scrollbar of scrolledWindow
.
Since: 2.8
new
Arguments
:: (HasCallStack, MonadIO m, IsAdjustment a, IsAdjustment b) | |
=> Maybe a |
|
-> Maybe b |
|
-> m ScrolledWindow | Returns: a new scrolled window |
Creates a new scrolled window.
The two arguments are the scrolled window’s adjustments; these will be
shared with the scrollbars and the child widget to keep the bars in sync
with the child. Usually you want to pass Nothing
for the adjustments, which
will cause the scrolled window to create them for you.
setCaptureButtonPress
scrolledWindowSetCaptureButtonPress Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> Bool |
|
-> m () |
Changes the behaviour of scrolledWindow
with regard to the initial
event that possibly starts kinetic scrolling. When captureButtonPress
is set to True
, the event is captured by the scrolled window, and
then later replayed if it is meant to go to the child widget.
This should be enabled if any child widgets perform non-reversible
actions on Widget
::button-press-event
. If they don't, and handle
additionally handle Widget
::grab-broken-event
, it might be better
to set captureButtonPress
to False
.
This setting only has an effect if kinetic scrolling is enabled.
Since: 3.4
setHadjustment
scrolledWindowSetHadjustment Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a, IsAdjustment b) | |
=> a |
|
-> b |
|
-> m () |
Sets the Adjustment
for the horizontal scrollbar.
setKineticScrolling
scrolledWindowSetKineticScrolling Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> Bool |
|
-> m () |
Turns kinetic scrolling on or off.
Kinetic scrolling only applies to devices with source
InputSourceTouchscreen
.
Since: 3.4
setMaxContentHeight
scrolledWindowSetMaxContentHeight Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> Int32 |
|
-> 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
:min-content-height
.
Since: 3.22
setMaxContentWidth
scrolledWindowSetMaxContentWidth Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> Int32 |
|
-> 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
:min-content-width
.
Since: 3.22
setMinContentHeight
scrolledWindowSetMinContentHeight Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> Int32 |
|
-> 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
:max-content-height
.
Since: 3.0
setMinContentWidth
scrolledWindowSetMinContentWidth Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> Int32 |
|
-> 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
:max-content-width
.
Since: 3.0
setOverlayScrolling
scrolledWindowSetOverlayScrolling Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> Bool |
|
-> m () |
Enables or disables overlay scrolling for this scrolled window.
Since: 3.16
setPlacement
scrolledWindowSetPlacement Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> CornerType |
|
-> 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 |
|
-> PolicyType |
|
-> PolicyType |
|
-> 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 |
|
-> Bool |
|
-> m () |
Sets whether the natural height of the child should be calculated and propagated through the scrolled windows requested natural height.
Since: 3.22
setPropagateNaturalWidth
scrolledWindowSetPropagateNaturalWidth Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the natural width of the child should be calculated and propagated through the scrolled windows requested natural width.
Since: 3.22
setShadowType
scrolledWindowSetShadowType Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> ShadowType |
|
-> m () |
Changes the type of shadow drawn around the contents of
scrolledWindow
.
setVadjustment
scrolledWindowSetVadjustment Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a, IsAdjustment b) | |
=> a |
|
-> b |
|
-> m () |
Sets the Adjustment
for the vertical scrollbar.
unsetPlacement
scrolledWindowUnsetPlacement Source #
Arguments
:: (HasCallStack, MonadIO m, IsScrolledWindow a) | |
=> a |
|
-> m () |
Unsets the placement of the contents with respect to the scrollbars
for the scrolled window. If no window placement is set for a scrolled
window, it defaults to CornerTypeTopLeft
.
See also scrolledWindowSetPlacement
and
scrolledWindowGetPlacement
.
Since: 2.10
Properties
hadjustment
constructScrolledWindowHadjustment :: (IsScrolledWindow o, IsAdjustment a) => a -> IO (GValueConstruct o) Source #
getScrolledWindowHadjustment :: (MonadIO m, IsScrolledWindow o) => o -> m Adjustment Source #
setScrolledWindowHadjustment :: (MonadIO m, IsScrolledWindow o, IsAdjustment a) => o -> a -> m () Source #
hscrollbarPolicy
constructScrolledWindowHscrollbarPolicy :: IsScrolledWindow o => PolicyType -> IO (GValueConstruct o) Source #
getScrolledWindowHscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> m PolicyType Source #
setScrolledWindowHscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> PolicyType -> m () Source #
kineticScrolling
constructScrolledWindowKineticScrolling :: IsScrolledWindow o => Bool -> IO (GValueConstruct o) Source #
getScrolledWindowKineticScrolling :: (MonadIO m, IsScrolledWindow o) => o -> m Bool Source #
setScrolledWindowKineticScrolling :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m () Source #
maxContentHeight
constructScrolledWindowMaxContentHeight :: IsScrolledWindow o => Int32 -> IO (GValueConstruct o) Source #
getScrolledWindowMaxContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> m Int32 Source #
setScrolledWindowMaxContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m () Source #
maxContentWidth
constructScrolledWindowMaxContentWidth :: IsScrolledWindow o => Int32 -> IO (GValueConstruct o) Source #
getScrolledWindowMaxContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> m Int32 Source #
setScrolledWindowMaxContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m () Source #
minContentHeight
constructScrolledWindowMinContentHeight :: IsScrolledWindow o => Int32 -> IO (GValueConstruct o) Source #
getScrolledWindowMinContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> m Int32 Source #
setScrolledWindowMinContentHeight :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m () Source #
minContentWidth
constructScrolledWindowMinContentWidth :: IsScrolledWindow o => Int32 -> IO (GValueConstruct o) Source #
getScrolledWindowMinContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> m Int32 Source #
setScrolledWindowMinContentWidth :: (MonadIO m, IsScrolledWindow o) => o -> Int32 -> m () Source #
overlayScrolling
constructScrolledWindowOverlayScrolling :: IsScrolledWindow o => Bool -> IO (GValueConstruct o) Source #
getScrolledWindowOverlayScrolling :: (MonadIO m, IsScrolledWindow o) => o -> m Bool Source #
setScrolledWindowOverlayScrolling :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m () Source #
propagateNaturalHeight
constructScrolledWindowPropagateNaturalHeight :: IsScrolledWindow o => Bool -> IO (GValueConstruct o) Source #
getScrolledWindowPropagateNaturalHeight :: (MonadIO m, IsScrolledWindow o) => o -> m Bool Source #
setScrolledWindowPropagateNaturalHeight :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m () Source #
propagateNaturalWidth
constructScrolledWindowPropagateNaturalWidth :: IsScrolledWindow o => Bool -> IO (GValueConstruct o) Source #
getScrolledWindowPropagateNaturalWidth :: (MonadIO m, IsScrolledWindow o) => o -> m Bool Source #
setScrolledWindowPropagateNaturalWidth :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m () Source #
shadowType
constructScrolledWindowShadowType :: IsScrolledWindow o => ShadowType -> IO (GValueConstruct o) Source #
getScrolledWindowShadowType :: (MonadIO m, IsScrolledWindow o) => o -> m ShadowType Source #
setScrolledWindowShadowType :: (MonadIO m, IsScrolledWindow o) => o -> ShadowType -> m () Source #
vadjustment
constructScrolledWindowVadjustment :: (IsScrolledWindow o, IsAdjustment a) => a -> IO (GValueConstruct o) Source #
getScrolledWindowVadjustment :: (MonadIO m, IsScrolledWindow o) => o -> m Adjustment Source #
setScrolledWindowVadjustment :: (MonadIO m, IsScrolledWindow o, IsAdjustment a) => o -> a -> m () Source #
vscrollbarPolicy
constructScrolledWindowVscrollbarPolicy :: IsScrolledWindow o => PolicyType -> IO (GValueConstruct o) Source #
getScrolledWindowVscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> m PolicyType Source #
setScrolledWindowVscrollbarPolicy :: (MonadIO m, IsScrolledWindow o) => o -> PolicyType -> m () Source #
windowPlacement
constructScrolledWindowWindowPlacement :: IsScrolledWindow o => CornerType -> IO (GValueConstruct o) Source #
getScrolledWindowWindowPlacement :: (MonadIO m, IsScrolledWindow o) => o -> m CornerType Source #
setScrolledWindowWindowPlacement :: (MonadIO m, IsScrolledWindow o) => o -> CornerType -> m () Source #
windowPlacementSet
constructScrolledWindowWindowPlacementSet :: IsScrolledWindow o => Bool -> IO (GValueConstruct o) Source #
getScrolledWindowWindowPlacementSet :: (MonadIO m, IsScrolledWindow o) => o -> m Bool Source #
setScrolledWindowWindowPlacementSet :: (MonadIO m, IsScrolledWindow o) => o -> Bool -> m () Source #
Signals
edgeOvershot
type ScrolledWindowEdgeOvershotCallback = PositionType -> IO () Source #
afterScrolledWindowEdgeOvershot :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowEdgeOvershotCallback -> m SignalHandlerId Source #
mk_ScrolledWindowEdgeOvershotCallback :: C_ScrolledWindowEdgeOvershotCallback -> IO (FunPtr C_ScrolledWindowEdgeOvershotCallback) Source #
onScrolledWindowEdgeOvershot :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowEdgeOvershotCallback -> m SignalHandlerId Source #
wrap_ScrolledWindowEdgeOvershotCallback :: ScrolledWindowEdgeOvershotCallback -> Ptr () -> CUInt -> Ptr () -> IO () Source #
edgeReached
type ScrolledWindowEdgeReachedCallback = PositionType -> IO () Source #
afterScrolledWindowEdgeReached :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowEdgeReachedCallback -> m SignalHandlerId Source #
mk_ScrolledWindowEdgeReachedCallback :: C_ScrolledWindowEdgeReachedCallback -> IO (FunPtr C_ScrolledWindowEdgeReachedCallback) Source #
onScrolledWindowEdgeReached :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowEdgeReachedCallback -> m SignalHandlerId Source #
wrap_ScrolledWindowEdgeReachedCallback :: ScrolledWindowEdgeReachedCallback -> Ptr () -> CUInt -> Ptr () -> IO () Source #
moveFocusOut
type ScrolledWindowMoveFocusOutCallback = DirectionType -> IO () Source #
afterScrolledWindowMoveFocusOut :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowMoveFocusOutCallback -> m SignalHandlerId Source #
mk_ScrolledWindowMoveFocusOutCallback :: C_ScrolledWindowMoveFocusOutCallback -> IO (FunPtr C_ScrolledWindowMoveFocusOutCallback) Source #
onScrolledWindowMoveFocusOut :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowMoveFocusOutCallback -> m SignalHandlerId Source #
wrap_ScrolledWindowMoveFocusOutCallback :: ScrolledWindowMoveFocusOutCallback -> Ptr () -> CUInt -> Ptr () -> IO () Source #
scrollChild
type ScrolledWindowScrollChildCallback = ScrollType -> Bool -> IO Bool Source #
afterScrolledWindowScrollChild :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowScrollChildCallback -> m SignalHandlerId Source #
mk_ScrolledWindowScrollChildCallback :: C_ScrolledWindowScrollChildCallback -> IO (FunPtr C_ScrolledWindowScrollChildCallback) Source #
onScrolledWindowScrollChild :: (IsScrolledWindow a, MonadIO m) => a -> ScrolledWindowScrollChildCallback -> m SignalHandlerId Source #
wrap_ScrolledWindowScrollChildCallback :: ScrolledWindowScrollChildCallback -> Ptr () -> CUInt -> CInt -> Ptr () -> IO CInt Source #