Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Child Properties | ![]() |
![]() |
![]() |
![]() |
#include <gtk/gtk.h> struct GtkGrid; GtkWidget * gtk_grid_new (void
); void gtk_grid_attach (GtkGrid *grid
,GtkWidget *child
,gint left
,gint top
,gint width
,gint height
); void gtk_grid_attach_next_to (GtkGrid *grid
,GtkWidget *child
,GtkWidget *sibling
,GtkPositionType side
,gint width
,gint height
); GtkWidget * gtk_grid_get_child_at (GtkGrid *grid
,gint left
,gint top
); void gtk_grid_insert_row (GtkGrid *grid
,gint position
); void gtk_grid_insert_column (GtkGrid *grid
,gint position
); void gtk_grid_remove_row (GtkGrid *grid
,gint position
); void gtk_grid_remove_column (GtkGrid *grid
,gint position
); void gtk_grid_insert_next_to (GtkGrid *grid
,GtkWidget *sibling
,GtkPositionType side
); void gtk_grid_set_row_homogeneous (GtkGrid *grid
,gboolean homogeneous
); gboolean gtk_grid_get_row_homogeneous (GtkGrid *grid
); void gtk_grid_set_row_spacing (GtkGrid *grid
,guint spacing
); guint gtk_grid_get_row_spacing (GtkGrid *grid
); void gtk_grid_set_column_homogeneous (GtkGrid *grid
,gboolean homogeneous
); gboolean gtk_grid_get_column_homogeneous (GtkGrid *grid
); void gtk_grid_set_column_spacing (GtkGrid *grid
,guint spacing
); guint gtk_grid_get_column_spacing (GtkGrid *grid
); gint gtk_grid_get_baseline_row (GtkGrid *grid
); void gtk_grid_set_baseline_row (GtkGrid *grid
,gint row
); GtkBaselinePosition gtk_grid_get_row_baseline_position (GtkGrid *grid
,gint row
); void gtk_grid_set_row_baseline_position (GtkGrid *grid
,gint row
,GtkBaselinePosition pos
);
"baseline-row" gint : Read / Write "column-homogeneous" gboolean : Read / Write "column-spacing" gint : Read / Write "row-homogeneous" gboolean : Read / Write "row-spacing" gint : Read / Write
"height" gint : Read / Write "left-attach" gint : Read / Write "top-attach" gint : Read / Write "width" gint : Read / Write
GtkGrid is a container which arranges its child widgets in rows and columns. It is a very similar to GtkTable and GtkBox, but it consistently uses GtkWidget's "margin" and "expand" properties instead of custom child properties, and it fully supports height-for-width geometry management.
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.
GtkWidget * gtk_grid_new (void
);
Creates a new grid widget.
Returns : |
the new GtkGrid |
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
.
|
a GtkGrid |
|
the widget to add |
|
the column number to attach the left side of child to |
|
the row number to attach the top side of child to |
|
the number of columns that child will span |
|
the number of rows that child will span |
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][2][1].
|
a GtkGrid |
|
the widget to add |
|
the child of grid that child will be placed
next to, or NULL to place child at the beginning or end. [allow-none]
|
|
the side of sibling that child is positioned next to |
|
the number of columns that child will span |
|
the number of rows that child will span |
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
.
|
a GtkGrid |
|
the left edge of the cell |
|
the top edge of the cell |
Returns : |
the child at the given position, or NULL . [transfer none]
|
Since 3.2
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.
|
a GtkGrid |
|
the position to insert the row at |
Since 3.2
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.
|
a GtkGrid |
|
the position to insert the column at |
Since 3.2
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.
|
a GtkGrid |
|
the position of the row to remove |
Since 3.10
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.
|
a GtkGrid |
|
the position of the column to remove |
Since 3.10
void gtk_grid_insert_next_to (GtkGrid *grid
,GtkWidget *sibling
,GtkPositionType side
);
Inserts a row or column at the specified position.
The new row or column is placed next to sibling
, on the side
determined by side
. If side
is GTK_POS_TOP
or GTK_POS_BOTTOM
,
a row is inserted. If side
is GTK_POS_LEFT
of GTK_POS_RIGHT
,
a column is inserted.
|
a GtkGrid |
|
the child of grid that the new row or column will be
placed next to |
|
the side of sibling that child is positioned next to |
Since 3.2
void gtk_grid_set_row_homogeneous (GtkGrid *grid
,gboolean homogeneous
);
Sets whether all rows of grid
will have the same height.
|
a GtkGrid |
|
TRUE to make rows homogeneous |
gboolean gtk_grid_get_row_homogeneous (GtkGrid *grid
);
Returns whether all rows of grid
have the same height.
|
a GtkGrid |
Returns : |
whether all rows of grid have the same height. |
void gtk_grid_set_row_spacing (GtkGrid *grid
,guint spacing
);
Sets the amount of space between rows of grid
.
|
a GtkGrid |
|
the amount of space to insert between rows |
guint gtk_grid_get_row_spacing (GtkGrid *grid
);
Returns the amount of space between the rows of grid
.
|
a GtkGrid |
Returns : |
the row spacing of grid
|
void gtk_grid_set_column_homogeneous (GtkGrid *grid
,gboolean homogeneous
);
Sets whether all columns of grid
will have the same width.
|
a GtkGrid |
|
TRUE to make columns homogeneous |
gboolean gtk_grid_get_column_homogeneous (GtkGrid *grid
);
Returns whether all columns of grid
have the same width.
|
a GtkGrid |
Returns : |
whether all columns of grid have the same width. |
void gtk_grid_set_column_spacing (GtkGrid *grid
,guint spacing
);
Sets the amount of space between columns of grid
.
|
a GtkGrid |
|
the amount of space to insert between columns |
guint gtk_grid_get_column_spacing (GtkGrid *grid
);
Returns the amount of space between the columns of grid
.
|
a GtkGrid |
Returns : |
the column spacing of grid
|
gint gtk_grid_get_baseline_row (GtkGrid *grid
);
Returns which row defines the global baseline of grid
.
|
a GtkGrid |
Returns : |
the row index defining the global baseline |
Since 3.10
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
.
|
a GtkGrid |
|
the row index |
Returns : |
the row index defining the global baseline |
Since 3.10
GtkBaselinePosition gtk_grid_get_row_baseline_position (GtkGrid *grid
,gint row
);
Returns the baseline position of row
as set
by gtk_grid_set_row_baseline_position()
or the default value
GTK_BASELINE_POSITION_CENTER
.
|
a GtkGrid |
|
a row index |
Returns : |
the baseline position of row
|
Since 3.10
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.
|
a GtkGrid |
|
a row index |
|
a GtkBaselinePosition |
Since 3.10
"baseline-row"
property "baseline-row" gint : Read / Write
The row to align the to the baseline when valign is GTK_ALIGN_BASELINE.
Allowed values: >= 0
Default value: 0
"column-homogeneous"
property "column-homogeneous" gboolean : Read / Write
If TRUE, the columns are all the same width.
Default value: FALSE
"column-spacing"
property "column-spacing" gint : Read / Write
The amount of space between two consecutive columns.
Allowed values: [0,32767]
Default value: 0
"row-homogeneous"
property "row-homogeneous" gboolean : Read / Write
If TRUE, the rows are all the same height.
Default value: FALSE
"height"
child property "height" gint : Read / Write
The number of rows that a child spans.
Allowed values: >= 1
Default value: 1
"left-attach"
child property "left-attach" gint : Read / Write
The column number to attach the left side of the child to.
Default value: 0
"top-attach"
child property "top-attach" gint : Read / Write
The row number to attach the top side of a child widget to.
Default value: 0