Grid

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

An example GtkGrid

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:

<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

GtkGrid uses the %GTK_ACCESSIBLE_ROLE_GROUP role.

class Grid : Widget , OrientableIF {

protected

GtkGrid* gtkGrid;

GtkGrid* getGridStruct(bool transferOwnership);

void* getStruct();

this(GtkGrid* gtkGrid, bool ownedRef);

mixin OrientableT!(GtkGrid) ;

static GType getType();

this();

void attach(Widget child, int column, int row, int width, int height);

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

int getBaselineRow();

Widget getChildAt(int column, int row);

bool getColumnHomogeneous();

uint getColumnSpacing();

GtkBaselinePosition getRowBaselinePosition(int row);

bool getRowHomogeneous();

uint getRowSpacing();

void insertColumn(int position);

void insertNextTo(Widget sibling, GtkPositionType side);

void insertRow(int position);

void queryChild(Widget child, int column, int row, int width, int height);

void remove(Widget child);

void removeColumn(int position);

void removeRow(int position);

void setBaselineRow(int row);

void setColumnHomogeneous(bool homogeneous);

void setColumnSpacing(uint spacing);

void setRowBaselinePosition(int row, GtkBaselinePosition pos);

void setRowHomogeneous(bool homogeneous);

void setRowSpacing(uint spacing);

}

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 column, int row, 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 column, int row): Gets the child of @grid whose area covers the grid cell at @column, @row.
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.
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.
queryChild void queryChild(Widget child, int column, int row, int width, int height): Queries the attach points and spans of @child inside the given GtkGrid.
remove void remove(Widget child): Removes a child from @grid.
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.
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.

Mixins

__anonymous mixin OrientableT!(GtkGrid): Undocumented in source.

Static functions

getType GType getType()

Variables

gtkGrid GtkGrid* gtkGrid;: the main Gtk struct

Inherited Members

gtkWidget GtkWidget* gtkWidget;: the main Gtk struct
getWidgetStruct GtkWidget* getWidgetStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
__anonymous mixin AccessibleT!(GtkWidget): Undocumented in source.
__anonymous mixin BuildableT!(GtkWidget): Undocumented in source.
__anonymous mixin ConstraintTargetT!(GtkWidget): Undocumented in source.
getType GType getType()
getDefaultDirection GtkTextDirection getDefaultDirection(): Obtains the current default reading direction.
setDefaultDirection void setDefaultDirection(GtkTextDirection dir): Sets the default reading direction for widgets.
actionSetEnabled void actionSetEnabled(string actionName, bool enabled): Enable or disable an action installed with gtk_widget_class_install_action().
activate bool activate(): For widgets that can be “activated” (buttons, menu items, etc.) this function activates them.
activateActionVariant bool activateActionVariant(string name, Variant args): Looks up the action in the action groups associated with @widget and its ancestors, and activates it.
activateDefault void activateDefault(): Activates the default.activate action from @widget.
addController void addController(EventController controller): Adds @controller to @widget so that it will receive events.
addCssClass void addCssClass(string cssClass): Adds a style class to @widget.
addMnemonicLabel void addMnemonicLabel(Widget label): Adds a widget to the list of mnemonic labels for this widget.
addTickCallback uint addTickCallback(GtkTickCallback callback, void* userData, GDestroyNotify notify): Queues an animation frame update and adds a callback to be called before each frame.
allocate void allocate(int width, int height, int baseline, Transform transform): This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.
childFocus bool childFocus(GtkDirectionType direction): Called by widgets as the user moves around the window using keyboard shortcuts.
computeBounds bool computeBounds(Widget target, Rect outBounds): Computes the bounds for @widget in the coordinate space of @target.
computeExpand bool computeExpand(GtkOrientation orientation): Computes whether a container should give this widget extra space when possible.
computePoint bool computePoint(Widget target, Point point, Point outPoint): Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system.
computeTransform bool computeTransform(Widget target, Matrix outTransform): Computes a matrix suitable to describe a transformation from @widget's coordinate system into @target's coordinate system.
contains bool contains(double x, double y): Tests if the point at (@x, @y) is contained in @widget.
createPangoContext PgContext createPangoContext(): Creates a new PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget.
createPangoLayout PgLayout createPangoLayout(string text): Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.
dragCheckThreshold bool dragCheckThreshold(int startX, int startY, int currentX, int currentY): Checks to see if a drag movement has passed the GTK drag threshold.
errorBell void errorBell(): Notifies the user about an input-related error on this widget.
getAllocatedBaseline int getAllocatedBaseline(): Returns the baseline that has currently been allocated to @widget.
getAllocatedHeight int getAllocatedHeight(): Returns the height that has currently been allocated to @widget.
getAllocatedWidth int getAllocatedWidth(): Returns the width that has currently been allocated to @widget.
getAllocation void getAllocation(GtkAllocation allocation): Retrieves the widget’s allocation.
getAncestor Widget getAncestor(GType widgetType): Gets the first ancestor of @widget with type @widget_type.
getCanFocus bool getCanFocus(): Determines whether the input focus can enter @widget or any of its children.
getCanTarget bool getCanTarget(): Queries whether @widget can be the target of pointer events.
getChildVisible bool getChildVisible(): Gets the value set with gtk_widget_set_child_visible().
getClipboard Clipboard getClipboard(): Gets the clipboard object for @widget.
getCssClasses string[] getCssClasses(): Returns the list of style classes applied to @widget.
getCssName string getCssName(): Returns the CSS name that is used for @self.
getCursor Cursor getCursor(): Queries the cursor set on @widget.
getDirection GtkTextDirection getDirection(): Gets the reading direction for a particular widget.
getDisplay Display getDisplay(): Get the GdkDisplay for the toplevel window associated with this widget.
getFirstChild Widget getFirstChild(): Returns the widgets first child.
getFocusChild Widget getFocusChild(): Returns the current focus child of @widget.
getFocusOnClick bool getFocusOnClick(): Returns whether the widget should grab focus when it is clicked with the mouse.
getFocusable bool getFocusable(): Determines whether @widget can own the input focus.
getFontMap PgFontMap getFontMap(): Gets the font map of @widget.
getFontOptions FontOption getFontOptions(): Returns the cairo_font_options_t used for Pango rendering.
getFrameClock FrameClock getFrameClock(): Obtains the frame clock for a widget.
getHalign GtkAlign getHalign(): Gets the horizontal alignment of @widget.
getHasTooltip bool getHasTooltip(): Returns the current value of the has-tooltip property.
getHeight int getHeight(): Returns the content height of the widget.
getHexpand bool getHexpand(): Gets whether the widget would like any available extra horizontal space.
getHexpandSet bool getHexpandSet(): Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget.
getLastChild Widget getLastChild(): Returns the widgets last child.
getLayoutManager LayoutManager getLayoutManager(): Retrieves the layout manager used by @widget
getMapped bool getMapped(): Whether the widget is mapped.
getMarginBottom int getMarginBottom(): Gets the bottom margin of @widget.
getMarginEnd int getMarginEnd(): Gets the end margin of @widget.
getMarginStart int getMarginStart(): Gets the start margin of @widget.
getMarginTop int getMarginTop(): Gets the top margin of @widget.
getName string getName(): Retrieves the name of a widget.
getNative NativeIF getNative(): Returns the GtkNative widget that contains @widget.
getNextSibling Widget getNextSibling(): Returns the widgets next sibling.
getOpacity double getOpacity(): #Fetches the requested opacity for this widget.
getOverflow GtkOverflow getOverflow(): Returns the widgets overflow value.
getPangoContext PgContext getPangoContext(): Gets a PangoContext with the appropriate font map, font description, and base direction for this widget.
getParent Widget getParent(): Returns the parent widget of @widget.
getPreferredSize void getPreferredSize(Requisition minimumSize, Requisition naturalSize): Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
getPrevSibling Widget getPrevSibling(): Returns the widgets previous sibling.
getPrimaryClipboard Clipboard getPrimaryClipboard(): Gets the primary clipboard of @widget.
getRealized bool getRealized(): Determines whether @widget is realized.
getReceivesDefault bool getReceivesDefault(): Determines whether @widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
getRequestMode GtkSizeRequestMode getRequestMode(): Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
getRoot RootIF getRoot(): Returns the GtkRoot widget of @widget.
getScaleFactor int getScaleFactor(): Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.
getSensitive bool getSensitive(): Returns the widget’s sensitivity.
getSettings Settings getSettings(): Gets the settings object holding the settings used for this widget.
getSize int getSize(GtkOrientation orientation): Returns the content width or height of the widget.
getSizeRequest void getSizeRequest(int width, int height): Gets the size request that was explicitly set for the widget using gtk_widget_set_size_request().
getStateFlags GtkStateFlags getStateFlags(): Returns the widget state as a flag set.
getStyleContext StyleContext getStyleContext(): Returns the style context associated to @widget.
getTemplateChild ObjectG getTemplateChild(GType widgetType, string name): Fetch an object build from the template XML for @widget_type in this @widget instance.
getTooltipMarkup string getTooltipMarkup(): Gets the contents of the tooltip for @widget.
getTooltipText string getTooltipText(): Gets the contents of the tooltip for @widget.
getValign GtkAlign getValign(): Gets the vertical alignment of @widget.
getVexpand bool getVexpand(): Gets whether the widget would like any available extra vertical space.
getVexpandSet bool getVexpandSet(): Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget.
getVisible bool getVisible(): Determines whether the widget is visible.
getWidth int getWidth(): Returns the content width of the widget.
grabFocus bool grabFocus(): Causes @widget to have the keyboard focus for the GtkWindow it's inside.
hasCssClass bool hasCssClass(string cssClass): Returns whether @css_class is currently applied to @widget.
hasDefault bool hasDefault(): Determines whether @widget is the current default widget within its toplevel.
hasFocus bool hasFocus(): Determines if the widget has the global input focus.
hasVisibleFocus bool hasVisibleFocus(): Determines if the widget should show a visible indication that it has the global input focus.
hide void hide(): Reverses the effects of gtk_widget_show().
inDestruction bool inDestruction(): Returns whether the widget is currently being destroyed.
initTemplate void initTemplate(): Creates and initializes child widgets defined in templates.
insertActionGroup void insertActionGroup(string name, ActionGroupIF group): Inserts @group into @widget.
insertAfter void insertAfter(Widget parent, Widget previousSibling): Inserts @widget into the child widget list of @parent.
insertBefore void insertBefore(Widget parent, Widget nextSibling): Inserts @widget into the child widget list of @parent.
isAncestor bool isAncestor(Widget ancestor): Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.
isDrawable bool isDrawable(): Determines whether @widget can be drawn to.
isFocus bool isFocus(): Determines if the widget is the focus widget within its toplevel.
isSensitive bool isSensitive(): Returns the widget’s effective sensitivity.
isVisible bool isVisible(): Determines whether the widget and all its parents are marked as visible.
keynavFailed bool keynavFailed(GtkDirectionType direction): Emits the ::keynav-failed signal on the widget.
listMnemonicLabels ListG listMnemonicLabels(): Returns the widgets for which this widget is the target of a mnemonic.
map void map(): Causes a widget to be mapped if it isn’t already.
measure void measure(GtkOrientation orientation, int forSize, int minimum, int natural, int minimumBaseline, int naturalBaseline): Measures @widget in the orientation @orientation and for the given @for_size.
mnemonicActivate bool mnemonicActivate(bool groupCycling): Emits the GtkWidget::mnemonic-activate signal.
observeChildren ListModelIF observeChildren(): Returns a GListModel to track the children of @widget.
observeControllers ListModelIF observeControllers(): Returns a GListModel to track the [class@Gtk.EventController]s of @widget.
pick Widget pick(double x, double y, GtkPickFlags flags): Finds the descendant of @widget closest to the screen at the point (@x, @y).
queueAllocate void queueAllocate(): Flags the widget for a rerun of the GtkWidgetClass::size_allocate function.
queueDraw void queueDraw(): Schedules this widget to be redrawn in paint phase of the current or the next frame.
queueResize void queueResize(): Flags a widget to have its size renegotiated.
realize void realize(): Creates the GDK resources associated with a widget.
removeController void removeController(EventController controller): Removes @controller from @widget, so that it doesn't process events anymore.
removeCssClass void removeCssClass(string cssClass): Removes a style from @widget.
removeMnemonicLabel void removeMnemonicLabel(Widget label): Removes a widget from the list of mnemonic labels for this widget.
removeTickCallback void removeTickCallback(uint id): Removes a tick callback previously registered with gtk_widget_add_tick_callback().
setCanFocus void setCanFocus(bool canFocus): Specifies whether the input focus can enter the widget or any of its children.
setCanTarget void setCanTarget(bool canTarget): Sets whether @widget can be the target of pointer events.
setChildVisible void setChildVisible(bool childVisible): Sets whether @widget should be mapped along with its parent.
setCssClasses void setCssClasses(string[] classes): Will clear all style classes applied to @widget and replace them with @classes.
setCursor void setCursor(Cursor cursor): Sets the cursor to be shown when pointer devices point towards @widget.
setCursorFromName void setCursorFromName(string name): Sets a named cursor to be shown when pointer devices point towards @widget.
setDirection void setDirection(GtkTextDirection dir): Sets the reading direction on a particular widget.
setFocusChild void setFocusChild(Widget child): Set @child as the current focus child of @widget.
setFocusOnClick void setFocusOnClick(bool focusOnClick): Sets whether the widget should grab focus when it is clicked with the mouse.
setFocusable void setFocusable(bool focusable): Specifies whether @widget can own the input focus.
setFontMap void setFontMap(PgFontMap fontMap): Sets the font map to use for Pango rendering.
setFontOptions void setFontOptions(FontOption options): Sets the cairo_font_options_t used for Pango rendering in this widget.
setHalign void setHalign(GtkAlign align_): Sets the horizontal alignment of @widget.
setHasTooltip void setHasTooltip(bool hasTooltip): Sets the has-tooltip property on @widget to @has_tooltip.
setHexpand void setHexpand(bool expand): Sets whether the widget would like any available extra horizontal space.
setHexpandSet void setHexpandSet(bool set): Sets whether the hexpand flag will be used.
setLayoutManager void setLayoutManager(LayoutManager layoutManager): Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of @widget.
setMarginBottom void setMarginBottom(int margin): Sets the bottom margin of @widget.
setMarginEnd void setMarginEnd(int margin): Sets the end margin of @widget.
setMarginStart void setMarginStart(int margin): Sets the start margin of @widget.
setMarginTop void setMarginTop(int margin): Sets the top margin of @widget.
setName void setName(string name): Sets a widgets name.
setOpacity void setOpacity(double opacity): Request the @widget to be rendered partially transparent.
setOverflow void setOverflow(GtkOverflow overflow): Sets how @widget treats content that is drawn outside the widget's content area.
setParent void setParent(Widget parent): Sets @parent as the parent widget of @widget.
setReceivesDefault void setReceivesDefault(bool receivesDefault): Specifies whether @widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
setSensitive void setSensitive(bool sensitive): Sets the sensitivity of a widget.
setSizeRequest void setSizeRequest(int width, int height): Sets the minimum size of a widget.
setStateFlags void setStateFlags(GtkStateFlags flags, bool clear): Turns on flag values in the current widget state.
setTooltipMarkup void setTooltipMarkup(string markup): Sets @markup as the contents of the tooltip, which is marked up with Pango markup.
setTooltipText void setTooltipText(string text): Sets @text as the contents of the tooltip.
setValign void setValign(GtkAlign align_): Sets the vertical alignment of @widget.
setVexpand void setVexpand(bool expand): Sets whether the widget would like any available extra vertical space.
setVexpandSet void setVexpandSet(bool set): Sets whether the vexpand flag will be used.
setVisible void setVisible(bool visible): Sets the visibility state of @widget.
shouldLayout bool shouldLayout(): Returns whether @widget should contribute to the measuring and allocation of its parent.
show void show(): Flags a widget to be displayed.
sizeAllocate void sizeAllocate(GtkAllocation* allocation, int baseline): Allocates widget with a transformation that translates the origin to the position in @allocation.
snapshotChild void snapshotChild(Widget child, Snapshot snapshot): Snapshot the a child of @widget.
translateCoordinates bool translateCoordinates(Widget destWidget, double srcX, double srcY, double destX, double destY): Translate coordinates relative to @src_widget’s allocation to coordinates relative to @dest_widget’s allocations.
triggerTooltipQuery void triggerTooltipQuery(): Triggers a tooltip query on the display where the toplevel of @widget is located.
unmap void unmap(): Causes a widget to be unmapped if it’s currently mapped.
unparent void unparent(): Dissociate @widget from its parent.
unrealize void unrealize(): Causes a widget to be unrealized (frees all GDK resources associated with the widget).
unsetStateFlags void unsetStateFlags(GtkStateFlags flags): Turns off flag values for the current widget state.
addOnDestroy gulong addOnDestroy(void delegate(Widget) dlg, ConnectFlags connectFlags): Signals that all holders of a reference to the widget should release the reference that they hold.
addOnDirectionChanged gulong addOnDirectionChanged(void delegate(GtkTextDirection, Widget) dlg, ConnectFlags connectFlags): Emitted when the text direction of a widget changes.
addOnHide gulong addOnHide(void delegate(Widget) dlg, ConnectFlags connectFlags): Emitted when @widget is hidden.
addOnKeynavFailed gulong addOnKeynavFailed(bool delegate(GtkDirectionType, Widget) dlg, ConnectFlags connectFlags): Emitted if keyboard navigation fails.
addOnMap gulong addOnMap(void delegate(Widget) dlg, ConnectFlags connectFlags): Emitted when @widget is going to be mapped.
addOnMnemonicActivate gulong addOnMnemonicActivate(bool delegate(bool, Widget) dlg, ConnectFlags connectFlags): Emitted when a widget is activated via a mnemonic.
addOnMoveFocus gulong addOnMoveFocus(void delegate(GtkDirectionType, Widget) dlg, ConnectFlags connectFlags): Emitted when the focus is moved.
addOnQueryTooltip gulong addOnQueryTooltip(bool delegate(int, int, bool, Tooltip, Widget) dlg, ConnectFlags connectFlags): Emitted when the widgets tooltip is about to be shown.
addOnRealize gulong addOnRealize(void delegate(Widget) dlg, ConnectFlags connectFlags): Emitted when @widget is associated with a GdkSurface.
addOnShow gulong addOnShow(void delegate(Widget) dlg, ConnectFlags connectFlags): Emitted when @widget is shown.
addOnStateFlagsChanged gulong addOnStateFlagsChanged(void delegate(GtkStateFlags, Widget) dlg, ConnectFlags connectFlags): Emitted when the widget state changes.
addOnUnmap gulong addOnUnmap(void delegate(Widget) dlg, ConnectFlags connectFlags): Emitted when @widget is going to be unmapped.
addOnUnrealize gulong addOnUnrealize(void delegate(Widget) dlg, ConnectFlags connectFlags): Emitted when the GdkSurface associated with @widget is destroyed.

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.