Grid

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_grid_get_type ()" ) ]
public class Grid : Widget, Accessible, Buildable, ConstraintTarget, Orientable

`GtkGrid` is a container which arranges its child widgets in rows and columns.

![An example GtkGrid](grid.png)

It supports arbitrary positions and horizontal/vertical spans.

Children are added using [method@Gtk.Grid.attach]. They can span multiple rows or columns. It is also possible to add a child next to an existing child, using [method@Gtk.Grid.attach_next_to]. To remove a child from the grid, use [method@Gtk.Grid.remove].

The behaviour of `GtkGrid` when several children occupy the same grid cell is undefined.

GtkGrid as GtkBuildable

Every child in a `GtkGrid` has access to a custom [iface@Gtk.Buildable] element, called `<layout>`. It can by used to specify a position in the grid and optionally spans. All properties that can be used in the `<layout>` element are implemented by [class@Gtk.GridLayoutChild] .

It is implemented by `GtkWidget` using [class@Gtk.LayoutManager].

To showcase it, here is a simple example:

```xml <object class="GtkGrid" id="my_grid"> <child> <object class="GtkButton" id="button1"> <property name="label"> Button 1</property> <layout> <property name="column">0</property> <property name="row">0</property> < /layout> </object> </child> <child> <object class="GtkButton" id="button2"> <property name="label">Button 2</property> <layout> <property name="column">1</property> <property name="row">0</property> </layout > </object> </child> <child> <object class="GtkButton" id="button3"> <property name="label">Button 3< /property> <layout> <property name="column">2</property> <property name="row">0</property> <property name="row-span">2</property> </layout> </object> </child> <child> <object class="GtkButton" id="button4"> <property name="label">Button 4</property> <layout> <property name="column">0</property> < property name="row">1</property> <property name="column-span">2</property> </layout> </object> </child > </object> ```

It organizes the first two buttons side-by-side in one cell each. The third button is in the last column but spans across two rows. This is defined by the `row-span` property. The last button is located in the second row and spans across two columns, which is defined by the `column-span` property.

CSS nodes

`GtkGrid` uses a single CSS node with name `grid`.

Accessibility

Until GTK 4.10, `GtkGrid` used the `GTK_ACCESSIBLE_ROLE_GROUP` role.

Starting from GTK 4.12, `GtkGrid` uses the `GTK_ACCESSIBLE_ROLE_GENERIC` role.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public int baseline_row { get; set; }
The row to align to the baseline when valign is using baseline alignment.
public bool column_homogeneous { get; set; }
If true, the columns are all the same width.
public int column_spacing { get; set; }
The amount of space between two consecutive columns.
public bool row_homogeneous { get; set; }
If true, the rows are all the same height.
public int row_spacing { get; set; }
The amount of space between two consecutive rows.

Creation methods:

public Grid ()
Creates a new grid widget.

Methods:

public void attach (Widget child, int column, int row, int width = 1, int height = 1)
Adds a widget to the grid.
public void attach_next_to (Widget child, Widget? sibling, PositionType side, int width = 1, int height = 1)
Adds a widget to the grid.
public int get_baseline_row ()
Returns which row defines the global baseline of this.
public unowned Widget? get_child_at (int column, int row)
Gets the child of this whose area covers the grid cell at column, row.
public bool get_column_homogeneous ()
Returns whether all columns of this have the same width.
public uint get_column_spacing ()
Returns the amount of space between the columns of this.
public BaselinePosition get_row_baseline_position (int row)
Returns the baseline position of row.
public bool get_row_homogeneous ()
Returns whether all rows of this have the same height.
public uint get_row_spacing ()
Returns the amount of space between the rows of this.
public void insert_column (int position)
Inserts a column at the specified position.
public void insert_next_to (Widget sibling, PositionType side)
Inserts a row or column at the specified position.
public void insert_row (int position)
Inserts a row at the specified position.
public void query_child (Widget child, out int column, out int row, out int width, out int height)
Queries the attach points and spans of child inside the given `GtkGrid`.
public void remove (Widget child)
Removes a child from this.
public void remove_column (int position)
Removes a column from the grid.
public void remove_row (int position)
Removes a row from the grid.
public void set_baseline_row (int row)
Sets which row defines the global baseline for the entire grid.
public void set_column_homogeneous (bool homogeneous)
Sets whether all columns of this will have the same width.
public void set_column_spacing (uint spacing)
Sets the amount of space between columns of this .
public void set_row_baseline_position (int row, BaselinePosition pos)
Sets how the baseline should be positioned on row of the grid, in case that row is assigned more space than is requested.
public void set_row_homogeneous (bool homogeneous)
Sets whether all rows of this will have the same height.
public void set_row_spacing (uint spacing)
Sets the amount of space between rows of this .

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable

All known members inherited from interface Gtk.Orientable

get_orientation

orientation

set_orientation