Grid

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.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.Grid.attachNextTo. 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.Container.add, which will place children next to each other in the direction determined by the #GtkOrientable: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.

class Grid : Container , Orientable {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

Grid self();

static GridGidBuilder builder();

int baselineRow [@property getter];

int baselineRow [@property setter];

bool columnHomogeneous [@property getter];

bool columnHomogeneous [@property setter];

int columnSpacing [@property getter];

int columnSpacing [@property setter];

bool rowHomogeneous [@property getter];

bool rowHomogeneous [@property setter];

int rowSpacing [@property getter];

int rowSpacing [@property setter];

this();

void attach(gtk.widget.Widget child, int left, int top, int width, int height);

void attachNextTo(gtk.widget.Widget child, gtk.widget.Widget sibling, gtk.types.PositionType side, int width, int height);

int getBaselineRow();

gtk.widget.Widget getChildAt(int left, int top);

bool getColumnHomogeneous();

uint getColumnSpacing();

gtk.types.BaselinePosition getRowBaselinePosition(int row);

bool getRowHomogeneous();

uint getRowSpacing();

void insertColumn(int position);

void insertNextTo(gtk.widget.Widget sibling, gtk.types.PositionType side);

void insertRow(int position);

void removeColumn(int position);

void removeRow(int position);

void setBaselineRow(int row);

void setColumnHomogeneous(bool homogeneous);

void setColumnSpacing(uint spacing);

void setRowBaselinePosition(int row, gtk.types.BaselinePosition pos);

void setRowHomogeneous(bool homogeneous);

void setRowSpacing(uint spacing);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Creates a new grid widget.

Members

Functions

attach void attach(gtk.widget.Widget child, int left, int top, int width, int height): Adds a widget to the grid.
attachNextTo void attachNextTo(gtk.widget.Widget child, gtk.widget.Widget sibling, gtk.types.PositionType side, int width, int height): Adds a widget to the grid.
getBaselineRow int getBaselineRow(): Returns which row defines the global baseline of grid.
getChildAt gtk.widget.Widget getChildAt(int left, int top): Gets the child of grid whose area covers the grid cell whose upper left corner is at left, top.
getColumnHomogeneous bool getColumnHomogeneous(): Returns whether all columns of grid have the same width.
getColumnSpacing uint getColumnSpacing(): Returns the amount of space between the columns of grid.
getRowBaselinePosition gtk.types.BaselinePosition getRowBaselinePosition(int row): Returns the baseline position of row as set by gtk.grid.Grid.setRowBaselinePosition or the default value gtk.types.BaselinePosition.Center.
getRowHomogeneous bool getRowHomogeneous(): Returns whether all rows of grid have the same height.
getRowSpacing uint getRowSpacing(): Returns the amount of space between the rows of grid.
insertColumn void insertColumn(int position): Inserts a column at the specified position.
insertNextTo void insertNextTo(gtk.widget.Widget sibling, gtk.types.PositionType side): Inserts a row or column at the specified position.
insertRow void insertRow(int position): Inserts a row at the specified position.
removeColumn void removeColumn(int position): Removes a column from the grid.
removeRow void removeRow(int position): Removes a row from the grid.
self Grid self(): Returns this, for use in with statements.
setBaselineRow void setBaselineRow(int 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.
setColumnHomogeneous void setColumnHomogeneous(bool homogeneous): Sets whether all columns of grid will have the same width.
setColumnSpacing void setColumnSpacing(uint spacing): Sets the amount of space between columns of grid.
setRowBaselinePosition void setRowBaselinePosition(int row, gtk.types.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.
setRowHomogeneous void setRowHomogeneous(bool homogeneous): Sets whether all rows of grid will have the same height.
setRowSpacing void setRowSpacing(uint spacing): Sets the amount of space between rows of grid.

Properties

_gType GType _gType [@property getter]
baselineRow int baselineRow [@property getter]
baselineRow int baselineRow [@property setter]
columnHomogeneous bool columnHomogeneous [@property getter]
columnHomogeneous bool columnHomogeneous [@property setter]
columnSpacing int columnSpacing [@property getter]
columnSpacing int columnSpacing [@property setter]
rowHomogeneous bool rowHomogeneous [@property getter]
rowHomogeneous bool rowHomogeneous [@property setter]
rowSpacing int rowSpacing [@property getter]
rowSpacing int rowSpacing [@property setter]

Static functions

_getGType GType _getGType()
builder GridGidBuilder builder(): Get builder for gtk.grid.Grid

Mixed In Members

From `mixin OrientableT!()`

orientation gtk.types.Orientation orientation [@property getter]: Get orientation property.
orientation gtk.types.Orientation orientation [@property setter]: Set orientation property.
getOrientation gtk.types.Orientation getOrientation(): Retrieves the orientation of the orientable.
setOrientation void setOrientation(gtk.types.Orientation orientation): Sets the orientation of the orientable.

Inherited Members

From Container

_getGType GType _getGType()
_gType GType _gType [@property getter]
self Container self(): Returns this, for use in with statements.
builder ContainerGidBuilder builder(): Get builder for gtk.container.Container
borderWidth uint borderWidth [@property getter]
borderWidth uint borderWidth [@property setter]
child gtk.widget.Widget child [@property setter]
resizeMode gtk.types.ResizeMode resizeMode [@property getter]
resizeMode gtk.types.ResizeMode resizeMode [@property setter]
add void add(gtk.widget.Widget widget): Adds widget to container. Typically used for simple containers such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated layout containers such as #GtkBox or #GtkGrid, this function will pick default packing parameters that may not be correct. So consider functions such as gtk.box.Box.packStart and gtk.grid.Grid.attach as an alternative to gtk.container.Container.add in those cases. A widget may be added to only one container at a time; you can’t place the same widget inside two different containers.
checkResize void checkResize()
childGetProperty void childGetProperty(gtk.widget.Widget child, string propertyName, gobject.value.Value value): Gets the value of a child property for child and container.
childNotify void childNotify(gtk.widget.Widget child, string childProperty): Emits a #GtkWidget::child-notify signal for the [child property][child-properties] child_property on the child.
childNotifyByPspec void childNotifyByPspec(gtk.widget.Widget child, gobject.param_spec.ParamSpec pspec): Emits a #GtkWidget::child-notify signal for the [child property][child-properties] specified by pspec on the child.
childSetProperty void childSetProperty(gtk.widget.Widget child, string propertyName, gobject.value.Value value): Sets a child property for child and container.
childType gobject.types.GType childType(): Returns the type of the children supported by the container.
forall void forall(gtk.types.Callback callback): Invokes callback on each direct child of container, including children that are considered “internal” (implementation details of the container). “Internal” children generally weren’t added by the user of the container, but were added by the container implementation itself.
foreach_ void foreach_(gtk.types.Callback callback): Invokes callback on each non-internal child of container. See gtk.container.Container.forall for details on what constitutes an “internal” child. For all practical purposes, this function should iterate over precisely those child widgets that were added to the container by the application with explicit add() calls.
getBorderWidth uint getBorderWidth(): Retrieves the border width of the container. See gtk.container.Container.setBorderWidth.
getChildren gtk.widget.Widget[] getChildren(): Returns the container’s non-internal children. See gtk.container.Container.forall for details on what constitutes an "internal" child.
getFocusChain bool getFocusChain(gtk.widget.Widget[] focusableWidgets): Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores null in focusable_widgets and returns false.
getFocusChild gtk.widget.Widget getFocusChild(): Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling gtk.window.Window.getFocus.
getFocusHadjustment gtk.adjustment.Adjustment getFocusHadjustment(): Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().
getFocusVadjustment gtk.adjustment.Adjustment getFocusVadjustment(): Retrieves the vertical focus adjustment for the container. See gtk.container.Container.setFocusVadjustment.
getPathForChild gtk.widget_path.WidgetPath getPathForChild(gtk.widget.Widget child): Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.
getResizeMode gtk.types.ResizeMode getResizeMode(): Returns the resize mode for the container. See gtk_container_set_resize_mode ().
propagateDraw void propagateDraw(gtk.widget.Widget child, cairo.context.Context cr): When a container receives a call to the draw function, it must send synthetic #GtkWidget::draw calls to all children that don’t have their own #GdkWindows. This function provides a convenient way of doing this. A container, when it receives a call to its #GtkWidget::draw function, calls gtk.container.Container.propagateDraw once for each child, passing in the cr the container received.
remove void remove(gtk.widget.Widget widget): Removes widget from container. widget must be inside container. Note that container will own a reference to widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use widget again, you need to add a reference to it before removing it from a container, using gobject.object.ObjectWrap.ref_. If you don’t want to use widget again it’s usually more efficient to simply destroy it directly using gtk.widget.Widget.destroy since this will remove it from the container and help break any circular reference count cycles.
resizeChildren void resizeChildren()
setBorderWidth void setBorderWidth(uint borderWidth): Sets the border width of the container.
setFocusChain void setFocusChain(gtk.widget.Widget[] focusableWidgets): Sets a focus chain, overriding the one computed automatically by GTK+.
setFocusChild void setFocusChild(gtk.widget.Widget child): Sets, or unsets if child is null, the focused child of container.
setFocusHadjustment void setFocusHadjustment(gtk.adjustment.Adjustment adjustment): Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See gtk.scrolled_window.ScrolledWindow.getHadjustment for a typical way of obtaining the adjustment and gtk.container.Container.setFocusVadjustment for setting the vertical adjustment.
setFocusVadjustment void setFocusVadjustment(gtk.adjustment.Adjustment adjustment): Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See gtk.scrolled_window.ScrolledWindow.getVadjustment for a typical way of obtaining the adjustment and gtk.container.Container.setFocusHadjustment for setting the horizontal adjustment.
setReallocateRedraws void setReallocateRedraws(bool needsRedraws): Sets the reallocate_redraws flag of the container to the given value.
setResizeMode void setResizeMode(gtk.types.ResizeMode resizeMode): Sets the resize mode for the container.
unsetFocusChain void unsetFocusChain(): Removes a focus chain explicitly set with gtk.container.Container.setFocusChain.
connectAdd gulong connectAdd(T callback, Flag!"After" after): Connect to Add signal.
connectCheckResize gulong connectCheckResize(T callback, Flag!"After" after): Connect to CheckResize signal.
connectRemove gulong connectRemove(T callback, Flag!"After" after): Connect to Remove signal.
connectSetFocusChild gulong connectSetFocusChild(T callback, Flag!"After" after): Connect to SetFocusChild signal.

From Orientable

_getGType GType _getGType()
orientation gtk.types.Orientation orientation [@property getter]: Get orientation property.
orientation gtk.types.Orientation orientation [@property setter]: Set orientation property.
getOrientation gtk.types.Orientation getOrientation(): Retrieves the orientation of the orientable.
setOrientation void setOrientation(gtk.types.Orientation orientation): Sets the orientation of the orientable.

gtk grid classes

Grid

CSS nodes

From mixin OrientableT!()

From `mixin OrientableT!()`