GtkLayout

GtkLayout

Properties

GtkAdjustment * hadjustment Read / Write
guint height Read / Write
GtkAdjustment * vadjustment Read / Write
guint width Read / Write

Child Properties

int x Read / Write
int y Read / Write

Signals

Types and Values

struct GtkLayout

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkLayout

Implemented Interfaces

GtkLayout implements AtkImplementorIface and GtkBuildable.

Includes

#include <gtk/gtk.h>

Description

Functions

gtk_layout_new ()

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

Creates a new GtkLayout. Unless you have a specific adjustment you'd like the layout to use for scrolling, pass NULL for hadjustment and vadjustment .

Parameters

hadjustment

horizontal scroll adjustment, or NULL.

[allow-none]

vadjustment

vertical scroll adjustment, or NULL.

[allow-none]

Returns

a new GtkLayout


gtk_layout_put ()

void
gtk_layout_put (GtkLayout *layout,
                GtkWidget *child_widget,
                gint x,
                gint y);

Adds child_widget to layout , at position (x ,y ). layout becomes the new parent container of child_widget .

Parameters

layout

a GtkLayout

 

child_widget

child widget

 

x

X position of child widget

 

y

Y position of child widget

 

gtk_layout_move ()

void
gtk_layout_move (GtkLayout *layout,
                 GtkWidget *child_widget,
                 gint x,
                 gint y);

Moves a current child of layout to a new position.

Parameters

layout

a GtkLayout

 

child_widget

a current child of layout

 

x

X position to move to

 

y

Y position to move to

 

gtk_layout_set_size ()

void
gtk_layout_set_size (GtkLayout *layout,
                     guint width,
                     guint height);

Sets the size of the scrollable area of the layout.

Parameters

layout

a GtkLayout

 

width

width of entire scrollable area

 

height

height of entire scrollable area

 

gtk_layout_get_size ()

void
gtk_layout_get_size (GtkLayout *layout,
                     guint *width,
                     guint *height);

Gets the size that has been set on the layout, and that determines the total extents of the layout's scrollbar area. See gtk_layout_set_size().

Parameters

layout

a GtkLayout

 

width

location to store the width set on layout , or NULL.

[out][allow-none]

height

location to store the height set on layout , or NULL.

[out][allow-none]

gtk_layout_freeze ()

void
gtk_layout_freeze (GtkLayout *layout);

gtk_layout_freeze is deprecated and should not be used in newly-written code.

This is a deprecated function, it doesn't do anything useful.

Parameters

layout

a GtkLayout

 

gtk_layout_thaw ()

void
gtk_layout_thaw (GtkLayout *layout);

gtk_layout_thaw is deprecated and should not be used in newly-written code.

This is a deprecated function, it doesn't do anything useful.

Parameters

layout

a GtkLayout

 

gtk_layout_get_hadjustment ()

GtkAdjustment *
gtk_layout_get_hadjustment (GtkLayout *layout);

This function should only be called after the layout has been placed in a GtkScrolledWindow or otherwise configured for scrolling. It returns the GtkAdjustment used for communication between the horizontal scrollbar and layout .

See GtkScrolledWindow, GtkScrollbar, GtkAdjustment for details.

Parameters

layout

a GtkLayout

 

Returns

horizontal scroll adjustment.

[transfer none]


gtk_layout_get_vadjustment ()

GtkAdjustment *
gtk_layout_get_vadjustment (GtkLayout *layout);

This function should only be called after the layout has been placed in a GtkScrolledWindow or otherwise configured for scrolling. It returns the GtkAdjustment used for communication between the vertical scrollbar and layout .

See GtkScrolledWindow, GtkScrollbar, GtkAdjustment for details.

Parameters

layout

a GtkLayout

 

Returns

vertical scroll adjustment.

[transfer none]


gtk_layout_set_hadjustment ()

void
gtk_layout_set_hadjustment (GtkLayout *layout,
                            GtkAdjustment *adjustment);

Sets the horizontal scroll adjustment for the layout.

See GtkScrolledWindow, GtkScrollbar, GtkAdjustment for details.

Parameters

layout

a GtkLayout

 

adjustment

new scroll adjustment.

[allow-none]

gtk_layout_set_vadjustment ()

void
gtk_layout_set_vadjustment (GtkLayout *layout,
                            GtkAdjustment *adjustment);

Sets the vertical scroll adjustment for the layout.

See GtkScrolledWindow, GtkScrollbar, GtkAdjustment for details.

Parameters

layout

a GtkLayout

 

adjustment

new scroll adjustment.

[allow-none]

gtk_layout_get_bin_window ()

GdkWindow *
gtk_layout_get_bin_window (GtkLayout *layout);

Retrieve the bin window of the layout used for drawing operations.

Parameters

layout

a GtkLayout

 

Returns

a GdkWindow.

[transfer none]

Since: 2.14

Types and Values

struct GtkLayout

struct GtkLayout {
  GdkWindow *GSEAL (bin_window);
};

Property Details

The “hadjustment” property

  “hadjustment”              GtkAdjustment *

The GtkAdjustment for the horizontal position.

Owner: GtkLayout

Flags: Read / Write


The “height” property

  “height”                   guint

The height of the layout.

Owner: GtkLayout

Flags: Read / Write

Allowed values: <= G_MAXINT

Default value: 100


The “vadjustment” property

  “vadjustment”              GtkAdjustment *

The GtkAdjustment for the vertical position.

Owner: GtkLayout

Flags: Read / Write


The “width” property

  “width”                    guint

The width of the layout.

Owner: GtkLayout

Flags: Read / Write

Allowed values: <= G_MAXINT

Default value: 100

Child Property Details

The “x” child property

  “x”                        int

X position of child widget.

Owner: GtkLayout

Flags: Read / Write

Default value: 0


The “y” child property

  “y”                        int

Y position of child widget.

Owner: GtkLayout

Flags: Read / Write

Default value: 0

Signal Details

The “set-scroll-adjustments” signal

void
user_function (GtkLayout     *horizontal,
               GtkAdjustment *vertical,
               GtkAdjustment *arg2,
               gpointer       user_data)

Set the scroll adjustments for the layout. Usually scrolled containers like GtkScrolledWindow will emit this signal to connect two instances of GtkScrollbar to the scroll directions of the GtkLayout.

Parameters

horizontal

the horizontal GtkAdjustment

 

vertical

the vertical GtkAdjustment

 

user_data

user data set when the signal handler was connected.

 

Flags: Action