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 Grid.attach. They can span multiple rows or columns. It is also possible to add a child next to an existing child, using Grid.attachNextTo. The behaviour of GtkGrid when several children occupy the same grid cell is undefined.

GtkGrid can be used like a gtk.Box by just using 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 gtk.Box is the preferred widget.

CSS nodes

GtkGrid uses a single CSS node with name grid.

Constructors

this
this(GtkGrid* gtkGrid, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this()

Creates a new grid widget.

Members

Functions

attach
void attach(Widget child, int left, int top, int width, int height)

Adds a widget to the grid.

attachNextTo
void attachNextTo(Widget child, Widget sibling, GtkPositionType side, int width, int height)

Adds a widget to the grid.

getBaselineRow
int getBaselineRow()

Returns which row defines the global baseline of grid.

getChildAt
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.

getGridStruct
GtkGrid* getGridStruct(bool transferOwnership)

Get the main Gtk struct

getRowBaselinePosition
GtkBaselinePosition getRowBaselinePosition(int row)

Returns the baseline position of row as set by Grid.setRowBaselinePosition or the default value GTK_BASELINE_POSITION_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.

getStruct
void* getStruct()

the main Gtk struct as a void*

insertColumn
void insertColumn(int position)

Inserts a column at the specified position.

insertNextTo
void insertNextTo(Widget sibling, GtkPositionType 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.

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, 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.

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.

Static functions

getType
GType getType()

Variables

gtkGrid
GtkGrid* gtkGrid;

the main Gtk struct

Inherited Members

From Container

gtkContainer
GtkContainer* gtkContainer;

the main Gtk struct

getContainerStruct
GtkContainer* getContainerStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

removeAll
void removeAll()

Removes all widgets from the container

getType
GType getType()
add
void add(Widget widget)

Adds widget to container. Typically used for simple containers such as gtk.Window, gtk.Frame, or gtk.Button; for more complicated layout containers such as gtk.Box or gtk.Grid, this function will pick default packing parameters that may not be correct. So consider functions such as Box.packStart and Grid.attach as an alternative to 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(Widget child, string propertyName, Value value)

Gets the value of a child property for child and container.

childGetValist
void childGetValist(Widget child, string firstPropertyName, void* varArgs)

Gets the values of one or more child properties for child and container.

childNotify
void childNotify(Widget child, string childProperty)

Emits a child-notify signal for the [child property][child-properties] child_property on the child.

childNotifyByPspec
void childNotifyByPspec(Widget child, ParamSpec pspec)

Emits a child-notify signal for the [child property][child-properties] specified by pspec on the child.

childSetProperty
void childSetProperty(Widget child, string propertyName, Value value)

Sets a child property for child and container.

childSetValist
void childSetValist(Widget child, string firstPropertyName, void* varArgs)

Sets one or more child properties for child and container.

childType
GType childType()

Returns the type of the children supported by the container.

forall
void forall(GtkCallback callback, void* callbackData)

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_(GtkCallback callback, void* callbackData)

Invokes callback on each non-internal child of container. See 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 Container.setBorderWidth.

getChildren
ListG getChildren()

Returns the container’s non-internal children. See Container.forall for details on what constitutes an "internal" child.

getFocusChain
bool getFocusChain(ListG 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
Widget getFocusChild()

Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling Window.getFocus.

getFocusHadjustment
Adjustment getFocusHadjustment()

Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().

getFocusVadjustment
Adjustment getFocusVadjustment()

Retrieves the vertical focus adjustment for the container. See Container.setFocusVadjustment.

getPathForChild
WidgetPath getPathForChild(Widget child)

Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.

getResizeMode
GtkResizeMode getResizeMode()

Returns the resize mode for the container. See gtk_container_set_resize_mode ().

propagateDraw
void propagateDraw(Widget child, Context cr)

When a container receives a call to the draw function, it must send synthetic draw calls to all children that don’t have their own gdk.Windows This function provides a convenient way of doing this. A container, when it receives a call to its draw function, calls Container.propagateDraw once for each child, passing in the cr the container received.

remove
void remove(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 g_object_ref(). If you don’t want to use widget again it’s usually more efficient to simply destroy it directly using 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(ListG focusableWidgets)

Sets a focus chain, overriding the one computed automatically by GTK+.

setFocusChild
void setFocusChild(Widget child)

Sets, or unsets if child is NULL, the focused child of container.

setFocusHadjustment
void setFocusHadjustment(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 ScrolledWindow.getHadjustment for a typical way of obtaining the adjustment and Container.setFocusVadjustment for setting the vertical adjustment.

setFocusVadjustment
void setFocusVadjustment(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 ScrolledWindow.getVadjustment for a typical way of obtaining the adjustment and 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(GtkResizeMode resizeMode)

Sets the resize mode for the container.

unsetFocusChain
void unsetFocusChain()

Removes a focus chain explicitly set with Container.setFocusChain.

addOnAdd
gulong addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
addOnCheckResize
gulong addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
addOnRemove
gulong addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
addOnSetFocusChild
gulong addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)

From OrientableIF

getOrientableStruct
GtkOrientable* getOrientableStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
getOrientation
GtkOrientation getOrientation()

Retrieves the orientation of the orientable.

setOrientation
void setOrientation(GtkOrientation orientation)

Sets the orientation of the orientable.