Table

Description The GtkTable functions allow the programmer to arrange widgets in rows and columns, making it easy to align many widgets next to each other, horizontally and vertically. Tables are created with a call to gtk_table_new(), the size of which can later be changed with gtk_table_resize(). Widgets can be added to a table using gtk_table_attach() or the more convenient (but slightly less flexible) gtk_table_attach_defaults(). To alter the space next to a specific row, use gtk_table_set_row_spacing(), and for a column, gtk_table_set_col_spacing(). The gaps between all rows or columns can be changed by calling gtk_table_set_row_spacings() or gtk_table_set_col_spacings() respectively. gtk_table_set_homogeneous(), can be used to set whether all cells in the table will resize themselves to the size of the largest widget in the table.

Constructors

this
this(GtkTable* gtkTable)

Sets our main struct and passes it to the parent class

this
this(uint rows, uint columns, int homogeneous)

Used to create a new table widget. An initial size must be given by specifying how many rows and columns the table should have, although this can be changed later with gtk_table_resize(). rows and columns must both be in the range 0 .. 65535.

Members

Functions

attach
void attach(Widget child)

Attach a new widget creating a new row if necessary

attach
void attach(Widget child, uint leftAttach, uint rightAttach, uint topAttach, uint bottomAttach, GtkAttachOptions xoptions, GtkAttachOptions yoptions, uint xpadding, uint ypadding)

Adds a widget to a table. The number of 'cells' that a widget will occupy is specified by left_attach, right_attach, top_attach and bottom_attach. These each represent the leftmost, rightmost, uppermost and lowest column and row numbers of the table. (Columns and rows are indexed from zero).

attachDefaults
void attachDefaults(Widget widget, uint leftAttach, uint rightAttach, uint topAttach, uint bottomAttach)

As there are many options associated with gtk_table_attach(), this convenience function provides the programmer with a means to add children to a table with identical padding and expansion options. The values used for the GtkAttachOptions are GTK_EXPAND | GTK_FILL, and the padding is set to 0.

getColSpacing
uint getColSpacing(uint column)

Gets the amount of space between column col, and column col + 1. See gtk_table_set_col_spacing().

getDefaultColSpacing
uint getDefaultColSpacing()

Gets the default column spacing for the table. This is the spacing that will be used for newly added columns. (See gtk_table_set_col_spacings())

getDefaultRowSpacing
uint getDefaultRowSpacing()

Gets the default row spacing for the table. This is the spacing that will be used for newly added rows. (See gtk_table_set_row_spacings())

getHomogeneous
int getHomogeneous()

Returns whether the table cells are all constrained to the same width and height. (See gtk_table_set_homogenous())

getRowSpacing
uint getRowSpacing(uint row)

Gets the amount of space between row row, and row row + 1. See gtk_table_set_row_spacing().

getSize
void getSize(uint rows, uint columns)

Since 2.22

getStruct
void* getStruct()

the main Gtk struct as a void*

getTableStruct
GtkTable* getTableStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
removeAll
void removeAll()

Removes all children and resizes the table to 1,1

resize
void resize(uint rows, uint columns)

If you need to change a table's size after it has been created, this function allows you to do so.

setColSpacing
void setColSpacing(uint column, uint spacing)

Alters the amount of space between a given table column and the following column.

setColSpacings
void setColSpacings(uint spacing)

Sets the space between every column in table equal to spacing.

setHomogeneous
void setHomogeneous(int homogeneous)

Changes the homogenous property of table cells, ie. whether all cells are an equal size or not.

setRowSpacing
void setRowSpacing(uint row, uint spacing)

Changes the space between a given table row and the subsequent row.

setRowSpacings
void setRowSpacings(uint spacing)

Sets the space between every row in table equal to spacing.

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.

Variables

col
int col;
Undocumented in source.
defaultXOption
AttachOptions defaultXOption;
Undocumented in source.
defaultYOption
AttachOptions defaultYOption;
Undocumented in source.
gtkTable
GtkTable* gtkTable;

the main Gtk struct

maxCols
int maxCols;
Undocumented in source.
maxRows
int maxRows;
Undocumented in source.
row
int row;
Undocumented in source.

Inherited Members

From Container

gtkContainer
GtkContainer* gtkContainer;

the main Gtk struct

getContainerStruct
GtkContainer* getContainerStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
removeAll
void removeAll()

Removes all widgets from the container

connectedSignals
int[string] connectedSignals;
onAddListeners
void delegate(Widget, Container)[] onAddListeners;
Undocumented in source.
addOnAdd
void addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackAdd
void callBackAdd(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onCheckResizeListeners
void delegate(Container)[] onCheckResizeListeners;
Undocumented in source.
addOnCheckResize
void addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
callBackCheckResize
void callBackCheckResize(GtkContainer* containerStruct, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onRemoveListeners
void delegate(Widget, Container)[] onRemoveListeners;
Undocumented in source.
addOnRemove
void addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackRemove
void callBackRemove(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onSetFocusChildListeners
void delegate(Widget, Container)[] onSetFocusChildListeners;
Undocumented in source.
addOnSetFocusChild
void addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackSetFocusChild
void callBackSetFocusChild(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
add
void add(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 GtkTable, this function will pick default packing parameters that may not be correct. So consider functions such as gtk_box_pack_start() and gtk_table_attach() as an alternative to gtk_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.

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 while it's not inside 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 gtk_widget_destroy() since this will remove it from the container and help break any circular reference count cycles.

getResizeMode
GtkResizeMode getResizeMode()

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

setResizeMode
void setResizeMode(GtkResizeMode resizeMode)

Sets the resize mode for the container. The resize mode of a container determines whether a resize request will be passed to the container's parent, queued for later execution or executed immediately.

checkResize
void checkResize()
foreac
void foreac(GtkCallback callback, void* callbackData)

Invokes callback on each non-internal child of container. See gtk_container_forall() for details on what constitutes an "internal" child. Most applications should use gtk_container_foreach(), rather than gtk_container_forall().

foreachFull
void foreachFull(GtkCallback callback, GtkCallbackMarshal marshal, void* callbackData, GDestroyNotify notify)

Warning gtk_container_foreach_full is deprecated and should not be used in newly-written code. Use gtk_container_foreach() instead.

getChildren
ListG getChildren()

Returns the container's non-internal children. See gtk_container_forall() for details on what constitutes an "internal" child.

setReallocateRedraws
void setReallocateRedraws(int needsRedraws)

Sets the reallocate_redraws flag of the container to the given value. Containers requesting reallocation redraws get automatically redrawn if any of their children changed allocation.

getFocusChild
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_get_focus(). Since 2.14

setFocusChild
void setFocusChild(Widget child)

Sets, or unsets if child is NULL, the focused child of container. This function emits the GtkContainer::set_focus_child signal of container. Implementations of GtkContainer can override the default behaviour by overriding the class closure of this signal. This is function is mostly meant to be used by widgets. Applications can use gtk_widget_grab_focus() to manualy set the focus to a specific widget.

getFocusVadjustment
Adjustment getFocusVadjustment()

Retrieves the vertical focus adjustment for the container. See gtk_container_set_focus_vadjustment().

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 gtk_scrolled_window_get_vadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_hadjustment() for setting the horizontal adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

getFocusHadjustment
Adjustment getFocusHadjustment()

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

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 gtk_scrolled_window_get_hadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_vadjustment() for setting the vertical adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

resizeChildren
void resizeChildren()
childType
GType childType()

Returns the type of the children supported by the container. Note that this may return G_TYPE_NONE to indicate that no more children can be added, e.g. for a GtkPaned which already has two children.

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

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

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

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

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

Sets one or more child properties for child and container.

forall
void forall(GtkCallback callback, void* callbackData)

Invokes callback on each 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. Most applications should use gtk_container_foreach(), rather than gtk_container_forall().

getBorderWidth
uint getBorderWidth()

Retrieves the border width of the container. See gtk_container_set_border_width().

setBorderWidth
void setBorderWidth(uint borderWidth)

Sets the border width of the container. The border width of a container is the amount of space to leave around the outside of the container. The only exception to this is GtkWindow; because toplevel windows can't leave space outside, they leave the space inside. The border is added on all sides of the container. To add space to only one side, one approach is to create a GtkAlignment widget, call gtk_widget_set_size_request() to give it a size, and place it on the side of the container as a spacer.

propagateExpose
void propagateExpose(Widget child, GdkEventExpose* event)

When a container receives an expose event, it must send synthetic expose events to all children that don't have their own GdkWindows. This function provides a convenient way of doing this. A container, when it receives an expose event, calls gtk_container_propagate_expose() once for each child, passing in the event the container received. gtk_container_propagate_expose() takes care of deciding whether an expose event needs to be sent to the child, intersecting the event's area with the child area, and sending the event. In most cases, a container can simply either simply inherit the "expose" implementation from GtkContainer, or, do some drawing and then chain to the ::expose implementation from GtkContainer. Note that the ::expose-event signal has been replaced by a ::draw signal in GTK+ 3, and consequently, gtk_container_propagate_expose() has been replaced by gtk_container_propagate_draw(). The GTK+ 3 migration guide for hints on how to port from ::expose-event to ::draw.

getFocusChain
int 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.

setFocusChain
void setFocusChain(ListG focusableWidgets)

Sets a focus chain, overriding the one computed automatically by GTK+. In principle each widget in the chain should be a descendant of the container, but this is not enforced by this method, since it's allowed to set the focus chain before you pack the widgets, or have a widget in the chain that isn't always packed. The necessary checks are done when the focus chain is actually traversed.

unsetFocusChain
void unsetFocusChain()

Removes a focus chain explicitly set with gtk_container_set_focus_chain().

classFindChildProperty
ParamSpec classFindChildProperty(GObjectClass* cclass, string propertyName)

Finds a child property of a container class by name.

classInstallChildProperty
void classInstallChildProperty(Container cclass, uint propertyId, ParamSpec pspec)

Installs a child property on a container class.

classListChildProperties
ParamSpec[] classListChildProperties(GObjectClass* cclass)

Returns all child properties of a container class.

Meta