GI.Gtk.Objects.Viewport

The Viewport widget acts as an adaptor class, implementing scrollability for child widgets that lack their own scrolling capabilities. Use GtkViewport to scroll child widgets such as Grid, Box, and so on.

If a widget has native scrolling abilities, such as TextView, TreeView or IconView, it can be added to a ScrolledWindow with containerAdd. If a widget does not, you must first add the widget to a Viewport, then add the viewport to the scrolled window. containerAdd does this automatically if a child that does not implement Scrollable is added to a ScrolledWindow, so you can ignore the presence of the viewport.

The GtkViewport will start scrolling content only if allocated less than the child widget’s minimum size in a given orientation.

CSS nodes

GtkViewport has a single CSS node with name viewport.

Exported types

newtype Viewport

Memory-managed wrapper type.

Constructors

Viewport (ManagedPtr Viewport)

Instances

GObject Viewport

Defined in GI.Gtk.Objects.Viewport

Methods

gobjectType :: IO GType

HasParentTypes Viewport

Defined in GI.Gtk.Objects.Viewport

type ParentTypes Viewport

Defined in GI.Gtk.Objects.Viewport

type ParentTypes Viewport = Bin ': (Container ': (Widget ': (Object ': (ImplementorIface ': (Buildable ': (Scrollable ': ([] :: [Type])))))))

class (GObject o, IsDescendantOf Viewport o) => IsViewport o

Type class for types which can be safely cast to Viewport, for instance with toViewport.

Instances

(GObject o, IsDescendantOf Viewport o) => IsViewport o

Defined in GI.Gtk.Objects.Viewport

toViewport :: (MonadIO m, IsViewport o) => o -> m Viewport

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

noViewport :: Maybe Viewport

A convenience alias for Nothing :: Maybe Viewport.

Methods

getBinWindow

viewportGetBinWindow

Arguments

:: (HasCallStack, MonadIO m, IsViewport a)

=> a

viewport: a Viewport

-> m Window

Returns: a Window

Gets the bin window of the Viewport.

Since: 2.20

getHadjustment

viewportGetHadjustment

Arguments

:: (HasCallStack, MonadIO m, IsViewport a)

=> a

viewport: a Viewport.

-> m Adjustment

Returns: the horizontal adjustment of viewport.

Deprecated: (Since version 3.0)Use scrollableGetHadjustment

Returns the horizontal adjustment of the viewport.

getShadowType

viewportGetShadowType

Arguments

:: (HasCallStack, MonadIO m, IsViewport a)

=> a

viewport: a Viewport

-> m ShadowType

Returns: the shadow type

Gets the shadow type of the Viewport. See viewportSetShadowType.

getVadjustment

viewportGetVadjustment

Arguments

:: (HasCallStack, MonadIO m, IsViewport a)

=> a

viewport: a Viewport.

-> m Adjustment

Returns: the vertical adjustment of viewport.

Deprecated: (Since version 3.0)Use scrollableGetVadjustment

Returns the vertical adjustment of the viewport.

getViewWindow

viewportGetViewWindow

Arguments

:: (HasCallStack, MonadIO m, IsViewport a)

=> a

viewport: a Viewport

-> m Window

Returns: a Window

Gets the view window of the Viewport.

Since: 2.22

new

viewportNew

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a, IsAdjustment b)

=> Maybe a

hadjustment: horizontal adjustment

-> Maybe b

vadjustment: vertical adjustment

-> m Viewport

Returns: a new Viewport

Creates a new Viewport with the given adjustments, or with default adjustments if none are given.

setHadjustment

viewportSetHadjustment

Arguments

:: (HasCallStack, MonadIO m, IsViewport a, IsAdjustment b)

=> a

viewport: a Viewport.

-> Maybe b

adjustment: a Adjustment.

-> m ()

Deprecated: (Since version 3.0)Use scrollableSetHadjustment

Sets the horizontal adjustment of the viewport.

setShadowType

viewportSetShadowType

Arguments

:: (HasCallStack, MonadIO m, IsViewport a)

=> a

viewport: a Viewport.

-> ShadowType

type: the new shadow type.

-> m ()

Sets the shadow type of the viewport.

setVadjustment

viewportSetVadjustment

Arguments

:: (HasCallStack, MonadIO m, IsViewport a, IsAdjustment b)

=> a

viewport: a Viewport.

-> Maybe b

adjustment: a Adjustment.

-> m ()

Deprecated: (Since version 3.0)Use scrollableSetVadjustment

Sets the vertical adjustment of the viewport.

Properties

shadowType

No description available in the introspection data.

constructViewportShadowType :: IsViewport o => ShadowType -> IO (GValueConstruct o)

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

getViewportShadowType :: (MonadIO m, IsViewport o) => o -> m ShadowType

Get the value of the “shadow-type” property. When overloading is enabled, this is equivalent to

get viewport #shadowType

setViewportShadowType :: (MonadIO m, IsViewport o) => o -> ShadowType -> m ()

Set the value of the “shadow-type” property. When overloading is enabled, this is equivalent to

set viewport [ #shadowType := value ]