Package org.gnome.gtk

Class GridLayout

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.LayoutManager

org.gnome.gtk.GridLayout

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class GridLayout
extends LayoutManager

Arranges child widgets in rows and columns.

Children have an "attach point" defined by the horizontal and vertical index of the cell they occupy; children can span multiple rows or columns. The layout properties for setting the attach points and spans are set using the GridLayoutChild associated to each child widget.

The behaviour of GtkGridLayout when several children occupy the same grid cell is undefined.

GtkGridLayout can be used like a GtkBoxLayout if all children are attached to the same row or column; however, if you only ever need a single row or column, you should consider using GtkBoxLayout.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GridLayout.Builder<B extends GridLayout.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	GridLayout.GridLayoutClass

Nested classes/interfaces inherited from class org.gnome.gtk.LayoutManager

LayoutManager.LayoutManager$Impl, LayoutManager.LayoutManagerClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
GridLayout()	Creates a new GridLayout.
GridLayout(MemorySegment address)	Create a GridLayout proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected GridLayout	asParent()	Returns this instance as if it were its parent type.
static GridLayout.Builder<? extends GridLayout.Builder>	builder()	A GridLayout.Builder object constructs a GridLayout with the specified properties.
int	getBaselineRow()	Retrieves the row set with gtk_grid_layout_set_baseline_row().
boolean	getColumnHomogeneous()	Checks whether all columns of this GridLayout should have the same width.
int	getColumnSpacing()	Retrieves the spacing set with gtk_grid_layout_set_column_spacing().
BaselinePosition	getRowBaselinePosition(int row)	Returns the baseline position of row.
boolean	getRowHomogeneous()	Checks whether all rows of this GridLayout should have the same height.
int	getRowSpacing()	Retrieves the spacing set with gtk_grid_layout_set_row_spacing().
static @Nullable Type	getType()	Get the GType of the GridLayout class
void	setBaselineRow(int row)	Sets which row defines the global baseline for the entire grid.
void	setColumnHomogeneous(boolean homogeneous)	Sets whether all columns of this GridLayout should have the same width.
void	setColumnSpacing(int spacing)	Sets the amount of space to insert between consecutive columns.
void	setRowBaselinePosition(int row, 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.
void	setRowHomogeneous(boolean homogeneous)	Sets whether all rows of this GridLayout should have the same height.
void	setRowSpacing(int spacing)	Sets the amount of space to insert between consecutive rows.

Methods inherited from class org.gnome.gtk.LayoutManager

allocate, createLayoutChild, getLayoutChild, getMemoryLayout, getRequestMode, getRequestMode, getWidget, layoutChanged, measure, root, unroot

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GridLayout

public GridLayout(MemorySegment address)

Create a GridLayout proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

GridLayout

public GridLayout()

Creates a new GridLayout.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the GridLayout class

Returns:

the GType

asParent

protected GridLayout asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class LayoutManager

getBaselineRow

public int getBaselineRow()

Retrieves the row set with gtk_grid_layout_set_baseline_row().

Returns:

the global baseline row

getColumnHomogeneous

public boolean getColumnHomogeneous()

Checks whether all columns of this GridLayout should have the same width.

Returns:

true if the columns are homogeneous, and false otherwise

getColumnSpacing

public int getColumnSpacing()

Retrieves the spacing set with gtk_grid_layout_set_column_spacing().

Returns:

the spacing between consecutive columns

getRowBaselinePosition

public BaselinePosition getRowBaselinePosition(int row)

Returns the baseline position of row.

If no value has been set with setRowBaselinePosition(int, org.gnome.gtk.BaselinePosition), the default value of BaselinePosition.CENTER is returned.

Parameters:

row - a row index

Returns:

the baseline position of row

getRowHomogeneous

public boolean getRowHomogeneous()

Checks whether all rows of this GridLayout should have the same height.

Returns:

true if the rows are homogeneous, and false otherwise

getRowSpacing

public int getRowSpacing()

Retrieves the spacing set with gtk_grid_layout_set_row_spacing().

Returns:

the spacing between consecutive rows

setBaselineRow

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

Parameters:

row - the row index

setColumnHomogeneous

public void setColumnHomogeneous(boolean homogeneous)

Sets whether all columns of this GridLayout should have the same width.

Parameters:

homogeneous - true to make columns homogeneous

setColumnSpacing

public void setColumnSpacing(int spacing)

Sets the amount of space to insert between consecutive columns.

Parameters:

spacing - the amount of space between columns, in pixels

setRowBaselinePosition

public void setRowBaselinePosition(int row,
 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.

Parameters:

row - a row index

pos - a GtkBaselinePosition

setRowHomogeneous

public void setRowHomogeneous(boolean homogeneous)

Sets whether all rows of this GridLayout should have the same height.

Parameters:

homogeneous - true to make rows homogeneous

setRowSpacing

public void setRowSpacing(int spacing)

Sets the amount of space to insert between consecutive rows.

Parameters:

spacing - the amount of space between rows, in pixels

builder

public static GridLayout.Builder<? extends GridLayout.Builder> builder()

A GridLayout.Builder object constructs a GridLayout with the specified properties. Use the various set...() methods to set properties, and finish construction with GridLayout.Builder.build().

Returns:

the builder object