Description
GtkGrid is a container which arranges its child widgets in
rows and columns, with arbitrary positions and horizontal/vertical spans.
Children are added using gtk_grid_attach(). They can span multiple
rows or columns. It is also possible to add a child next to an
existing child, using gtk_grid_attach_next_to(). The behaviour of
GtkGrid when several children occupy the same grid cell is undefined.
GtkGrid can be used like a GtkBox by just using gtk_container_add(),
which will place children next to each other in the direction determined
by the “orientation” property. However, if all you want is a
single row or column, then GtkBox is the preferred widget.
CSS nodes
GtkGrid uses a single CSS node with name grid.
Functions
gtk_grid_new ()
GtkWidget *
gtk_grid_new (void);
Creates a new grid widget.
gtk_grid_attach ()
void
gtk_grid_attach (GtkGrid *grid,
GtkWidget *child,
gint left,
gint top,
gint width,
gint height);
Adds a widget to the grid.
The position of child
is determined by left
and top
. The
number of “cells” that child
will occupy is determined by
width
and height
.
gtk_grid_attach_next_to ()
void
gtk_grid_attach_next_to (GtkGrid *grid,
GtkWidget *child,
GtkWidget *sibling,
GtkPositionType side,
gint width,
gint height);
Adds a widget to the grid.
The widget is placed next to sibling
, on the side determined by
side
. When sibling
is NULL, the widget is placed in row (for
left or right placement) or column 0 (for top or bottom placement),
at the end indicated by side
.
Attaching widgets labeled [1], [2], [3] with sibling
== NULL and
side
== GTK_POS_LEFT yields a layout of 3[1].
gtk_grid_get_child_at ()
GtkWidget *
gtk_grid_get_child_at (GtkGrid *grid,
gint left,
gint top);
Gets the child of grid
whose area covers the grid
cell whose upper left corner is at left
, top
.
Returns
the child at the given position, or NULL.
[transfer none][nullable]
Since: 3.2
gtk_grid_insert_row ()
void
gtk_grid_insert_row (GtkGrid *grid,
gint position);
Inserts a row at the specified position.
Children which are attached at or below this position
are moved one row down. Children which span across this
position are grown to span the new row.
Since: 3.2
gtk_grid_insert_column ()
void
gtk_grid_insert_column (GtkGrid *grid,
gint position);
Inserts a column at the specified position.
Children which are attached at or to the right of this position
are moved one column to the right. Children which span across this
position are grown to span the new column.
Since: 3.2
gtk_grid_remove_row ()
void
gtk_grid_remove_row (GtkGrid *grid,
gint position);
Removes a row from the grid.
Children that are placed in this row are removed,
spanning children that overlap this row have their
height reduced by one, and children below the row
are moved up.
Since: 3.10
gtk_grid_remove_column ()
void
gtk_grid_remove_column (GtkGrid *grid,
gint position);
Removes a column from the grid.
Children that are placed in this column are removed,
spanning children that overlap this column have their
width reduced by one, and children after the column
are moved to the left.
Since: 3.10
gtk_grid_set_row_homogeneous ()
void
gtk_grid_set_row_homogeneous (GtkGrid *grid,
gboolean homogeneous);
Sets whether all rows of grid
will have the same height.
gtk_grid_get_row_homogeneous ()
gboolean
gtk_grid_get_row_homogeneous (GtkGrid *grid);
Returns whether all rows of grid
have the same height.
Returns
whether all rows of grid
have the same height.
gtk_grid_set_row_spacing ()
void
gtk_grid_set_row_spacing (GtkGrid *grid,
guint spacing);
Sets the amount of space between rows of grid
.
gtk_grid_get_row_spacing ()
guint
gtk_grid_get_row_spacing (GtkGrid *grid);
Returns the amount of space between the rows of grid
.
Returns
the row spacing of grid
gtk_grid_set_column_homogeneous ()
void
gtk_grid_set_column_homogeneous (GtkGrid *grid,
gboolean homogeneous);
Sets whether all columns of grid
will have the same width.
gtk_grid_get_column_homogeneous ()
gboolean
gtk_grid_get_column_homogeneous (GtkGrid *grid);
Returns whether all columns of grid
have the same width.
Returns
whether all columns of grid
have the same width.
gtk_grid_set_column_spacing ()
void
gtk_grid_set_column_spacing (GtkGrid *grid,
guint spacing);
Sets the amount of space between columns of grid
.
gtk_grid_get_column_spacing ()
guint
gtk_grid_get_column_spacing (GtkGrid *grid);
Returns the amount of space between the columns of grid
.
Returns
the column spacing of grid
gtk_grid_get_baseline_row ()
gint
gtk_grid_get_baseline_row (GtkGrid *grid);
Returns which row defines the global baseline of grid
.
Returns
the row index defining the global baseline
Since: 3.10
gtk_grid_set_baseline_row ()
void
gtk_grid_set_baseline_row (GtkGrid *grid,
gint row);
Sets which row defines the global baseline for the entire grid.
Each row in the grid can have its own local baseline, but only
one of those is global, meaning it will be the baseline in the
parent of the grid
.
Since: 3.10
gtk_grid_set_row_baseline_position ()
void
gtk_grid_set_row_baseline_position (GtkGrid *grid,
gint row,
GtkBaselinePosition pos);
Sets how the baseline should be positioned on row
of the
grid, in case that row is assigned more space than is requested.
Since: 3.10
Property Details
The “baseline-row” property
“baseline-row” gint
The row to align the to the baseline when valign is GTK_ALIGN_BASELINE.
Owner: GtkGrid
Flags: Read / Write
Allowed values: >= 0
Default value: 0
The “column-homogeneous” property
“column-homogeneous” gboolean
If TRUE, the columns are all the same width.
Owner: GtkGrid
Flags: Read / Write
Default value: FALSE
The “column-spacing” property
“column-spacing” gint
The amount of space between two consecutive columns.
Owner: GtkGrid
Flags: Read / Write
Allowed values: [0,32767]
Default value: 0
The “row-homogeneous” property
“row-homogeneous” gboolean
If TRUE, the rows are all the same height.
Owner: GtkGrid
Flags: Read / Write
Default value: FALSE
The “row-spacing” property
“row-spacing” gint
The amount of space between two consecutive rows.
Owner: GtkGrid
Flags: Read / Write
Allowed values: [0,32767]
Default value: 0