GtkViewport

GtkViewport — An adapter which makes widgets scrollable

Functions

Properties

GtkShadowType shadow-type Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBin
                    ╰── GtkViewport

Implemented Interfaces

GtkViewport implements AtkImplementorIface, GtkBuildable, GtkConstraintTarget and GtkScrollable.

Includes

#include <gtk/gtk.h>

Description

The GtkViewport 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 GtkGrid, GtkBox, and so on.

If a widget has native scrolling abilities, such as GtkTextView, GtkTreeView or GtkIconView, it can be added to a GtkScrolledWindow with gtk_container_add(). If a widget does not, you must first add the widget to a GtkViewport, then add the viewport to the scrolled window. gtk_container_add() does this automatically if a child that does not implement GtkScrollable is added to a GtkScrolledWindow, 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.

Functions

gtk_viewport_new ()

GtkWidget *
gtk_viewport_new (GtkAdjustment *hadjustment,
                  GtkAdjustment *vadjustment);

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

Parameters

hadjustment

horizontal adjustment.

[allow-none]

vadjustment

vertical adjustment.

[allow-none]

Returns

a new GtkViewport


gtk_viewport_set_shadow_type ()

void
gtk_viewport_set_shadow_type (GtkViewport *viewport,
                              GtkShadowType type);

Sets the shadow type of the viewport.

Parameters

viewport

a GtkViewport.

 

type

the new shadow type.

 

gtk_viewport_get_shadow_type ()

GtkShadowType
gtk_viewport_get_shadow_type (GtkViewport *viewport);

Gets the shadow type of the GtkViewport. See gtk_viewport_set_shadow_type().

Parameters

viewport

a GtkViewport

 

Returns

the shadow type

Property Details

The “shadow-type” property

  “shadow-type”              GtkShadowType

Determines how the shadowed box around the viewport is drawn.

Owner: GtkViewport

Flags: Read / Write

Default value: GTK_SHADOW_IN

See Also

GtkScrolledWindow, GtkAdjustment