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 gtk_container_add(). If a widget does not, you must first add the widget to a Viewport, then add the viewport to the scrolled window. gtk_container_add() 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

Eq Viewport

Defined in GI.Gtk.Objects.Viewport

Methods

(==) :: Viewport -> Viewport -> Bool

(/=) :: Viewport -> Viewport -> Bool

GObject Viewport

Defined in GI.Gtk.Objects.Viewport

ManagedPtrNewtype Viewport

Defined in GI.Gtk.Objects.Viewport

Methods

toManagedPtr :: Viewport -> ManagedPtr Viewport

TypedObject Viewport

Defined in GI.Gtk.Objects.Viewport

Methods

glibType :: IO GType

IsGValue Viewport

Convert Viewport to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.Viewport

Methods

toGValue :: Viewport -> IO GValue

fromGValue :: GValue -> IO Viewport

HasParentTypes Viewport

Defined in GI.Gtk.Objects.Viewport

type ParentTypes Viewport

Defined in GI.Gtk.Objects.Viewport

type ParentTypes Viewport = '[Widget, Object, ImplementorIface, Buildable, ConstraintTarget, Scrollable]

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.

Methods

Overloaded methods

getChild

viewportGetChild

Arguments

:: (HasCallStack, MonadIO m, IsViewport a)

=> a

viewport: a Viewport

-> m (Maybe Widget)

Returns: the child widget of viewport

Gets the child widget of viewport.

getScrollToFocus

viewportGetScrollToFocus

Arguments

:: (HasCallStack, MonadIO m, IsViewport a)

=> a

viewport: a Viewport

-> m Bool

Returns: True if the viewport keeps the focus child scrolled to view

Gets whether the viewport is scrolling to keep the focused child in view. See viewportSetScrollToFocus.

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.

setChild

viewportSetChild

Arguments

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

=> a

viewport: a Viewport

-> Maybe b

child: the child widget

-> m ()

Sets the child widget of viewport.

setScrollToFocus

viewportSetScrollToFocus

Arguments

:: (HasCallStack, MonadIO m, IsViewport a)

=> a

viewport: a Viewport

-> Bool

scrollToFocus: whether to keep the focus widget scrolled to view

-> m ()

Sets whether the viewport should automatically scroll to keep the focused child in view.

Properties

child

No description available in the introspection data.

clearViewportChild :: (MonadIO m, IsViewport o) => o -> m ()

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

clear #child

constructViewportChild :: (IsViewport o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

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

getViewportChild :: (MonadIO m, IsViewport o) => o -> m (Maybe Widget)

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

get viewport #child

setViewportChild :: (MonadIO m, IsViewport o, IsWidget a) => o -> a -> m ()

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

set viewport [ #child := value ]

scrollToFocus

No description available in the introspection data.

constructViewportScrollToFocus :: (IsViewport o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getViewportScrollToFocus :: (MonadIO m, IsViewport o) => o -> m Bool

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

get viewport #scrollToFocus

setViewportScrollToFocus :: (MonadIO m, IsViewport o) => o -> Bool -> m ()

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

set viewport [ #scrollToFocus := value ]