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

Constructors

Viewport (ManagedPtr Viewport)

Instances

GObject Viewport

Methods

gobjectType :: Viewport -> IO GType

IsImplementorIface Viewport

IsObject Viewport

IsWidget Viewport

IsContainer Viewport

IsBin Viewport

IsScrollable Viewport

IsBuildable Viewport

IsViewport Viewport

((~) * info (ResolveViewportMethod t Viewport), MethodInfo * info Viewport p) => IsLabel t (Viewport -> p)

Methods

fromLabel :: Proxy# Symbol t -> Viewport -> p

((~) * info (ResolveViewportMethod t Viewport), MethodInfo * info Viewport p) => IsLabelProxy t (Viewport -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Viewport -> p

HasAttributeList * Viewport

type AttributeList Viewport

type AttributeList Viewport

type SignalList Viewport

type SignalList Viewport

class GObject o => IsViewport o

Instances

(GObject a, UnknownAncestorError Constraint Viewport a) => IsViewport a

IsViewport Viewport

toViewport :: IsViewport o => o -> IO Viewport

noViewport :: Maybe Viewport

Methods

getBinWindow

data ViewportGetBinWindowMethodInfo

Instances

((~) * signature (m Window), MonadIO m, IsViewport a) => MethodInfo * ViewportGetBinWindowMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ViewportGetBinWindowMethodInfo a -> signature -> s

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

data ViewportGetHadjustmentMethodInfo

Instances

((~) * signature (m Adjustment), MonadIO m, IsViewport a) => MethodInfo * ViewportGetHadjustmentMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ViewportGetHadjustmentMethodInfo a -> signature -> s

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

data ViewportGetShadowTypeMethodInfo

Instances

((~) * signature (m ShadowType), MonadIO m, IsViewport a) => MethodInfo * ViewportGetShadowTypeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ViewportGetShadowTypeMethodInfo a -> signature -> s

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

data ViewportGetVadjustmentMethodInfo

Instances

((~) * signature (m Adjustment), MonadIO m, IsViewport a) => MethodInfo * ViewportGetVadjustmentMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ViewportGetVadjustmentMethodInfo a -> signature -> s

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

data ViewportGetViewWindowMethodInfo

Instances

((~) * signature (m Window), MonadIO m, IsViewport a) => MethodInfo * ViewportGetViewWindowMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ViewportGetViewWindowMethodInfo a -> signature -> s

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

data ViewportSetHadjustmentMethodInfo

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsViewport a, IsAdjustment b) => MethodInfo * ViewportSetHadjustmentMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ViewportSetHadjustmentMethodInfo a -> signature -> s

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

data ViewportSetShadowTypeMethodInfo

Instances

((~) * signature (ShadowType -> m ()), MonadIO m, IsViewport a) => MethodInfo * ViewportSetShadowTypeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ViewportSetShadowTypeMethodInfo a -> signature -> s

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

data ViewportSetVadjustmentMethodInfo

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsViewport a, IsAdjustment b) => MethodInfo * ViewportSetVadjustmentMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ViewportSetVadjustmentMethodInfo a -> signature -> s

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

data ViewportShadowTypePropertyInfo

Instances

AttrInfo ViewportShadowTypePropertyInfo

Associated Types

type AttrAllowedOps ViewportShadowTypePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint ViewportShadowTypePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint ViewportShadowTypePropertyInfo :: * -> Constraint

type AttrGetType ViewportShadowTypePropertyInfo :: *

type AttrLabel ViewportShadowTypePropertyInfo :: Symbol

type AttrOrigin ViewportShadowTypePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint ViewportShadowTypePropertyInfo o => Proxy * ViewportShadowTypePropertyInfo -> o -> IO (AttrGetType ViewportShadowTypePropertyInfo)

attrSet :: (AttrBaseTypeConstraint ViewportShadowTypePropertyInfo o, AttrSetTypeConstraint ViewportShadowTypePropertyInfo b) => Proxy * ViewportShadowTypePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint ViewportShadowTypePropertyInfo o => Proxy * ViewportShadowTypePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint ViewportShadowTypePropertyInfo o, AttrSetTypeConstraint ViewportShadowTypePropertyInfo b) => Proxy * ViewportShadowTypePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin ViewportShadowTypePropertyInfo

type AttrOrigin ViewportShadowTypePropertyInfo = Viewport

type AttrLabel ViewportShadowTypePropertyInfo

type AttrLabel ViewportShadowTypePropertyInfo = "shadow-type"

type AttrGetType ViewportShadowTypePropertyInfo

type AttrGetType ViewportShadowTypePropertyInfo = ShadowType

type AttrBaseTypeConstraint ViewportShadowTypePropertyInfo

type AttrBaseTypeConstraint ViewportShadowTypePropertyInfo = IsViewport

type AttrSetTypeConstraint ViewportShadowTypePropertyInfo

type AttrSetTypeConstraint ViewportShadowTypePropertyInfo = * ~ ShadowType

type AttrAllowedOps ViewportShadowTypePropertyInfo

type AttrAllowedOps ViewportShadowTypePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

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

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

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

viewportShadowType :: AttrLabelProxy "shadowType"