Layout

#GtkLayout is similar to #GtkDrawingArea in that it’s a “blank slate” and doesn’t do anything except paint a blank background by default. It’s different in that it supports scrolling natively due to implementing #GtkScrollable, and can contain child widgets since it’s a #GtkContainer.

If you just want to draw, a #GtkDrawingArea is a better choice since it has lower overhead. If you just need to position child widgets at specific points, then #GtkFixed provides that functionality on its own.

When handling expose events on a #GtkLayout, you must draw to the #GdkWindow returned by gtk.layout.Layout.getBinWindow, rather than to the one returned by gtk.widget.Widget.getWindow as you would for a #GtkDrawingArea.

Constructors

this
this(void* ptr, Flag!"Take" take)
this
this(gtk.adjustment.Adjustment hadjustment, gtk.adjustment.Adjustment vadjustment)

Creates a new #GtkLayout. Unless you have a specific adjustment you’d like the layout to use for scrolling, pass null for hadjustment and vadjustment.

Members

Functions

getBinWindow
gdk.window.Window getBinWindow()

Retrieve the bin window of the layout used for drawing operations.

getHadjustment
gtk.adjustment.Adjustment getHadjustment()

This function should only be called after the layout has been placed in a #GtkScrolledWindow or otherwise configured for scrolling. It returns the #GtkAdjustment used for communication between the horizontal scrollbar and layout.

getSize
void getSize(uint width, uint height)

Gets the size that has been set on the layout, and that determines the total extents of the layout’s scrollbar area. See gtk_layout_set_size ().

getVadjustment
gtk.adjustment.Adjustment getVadjustment()

This function should only be called after the layout has been placed in a #GtkScrolledWindow or otherwise configured for scrolling. It returns the #GtkAdjustment used for communication between the vertical scrollbar and layout.

move
void move(gtk.widget.Widget childWidget, int x, int y)

Moves a current child of layout to a new position.

put
void put(gtk.widget.Widget childWidget, int x, int y)

Adds child_widget to layout, at position (x,y). layout becomes the new parent container of child_widget.

self
Layout self()

Returns this, for use in with statements.

setHadjustment
void setHadjustment(gtk.adjustment.Adjustment adjustment)

Sets the horizontal scroll adjustment for the layout.

setSize
void setSize(uint width, uint height)

Sets the size of the scrollable area of the layout.

setVadjustment
void setVadjustment(gtk.adjustment.Adjustment adjustment)

Sets the vertical scroll adjustment for the layout.

Properties

_gType
GType _gType [@property getter]
height
uint height [@property getter]
height
uint height [@property setter]
width
uint width [@property getter]
width
uint width [@property setter]

Static functions

_getGType
GType _getGType()
builder
LayoutGidBuilder builder()

Get builder for gtk.layout.Layout

Mixed In Members

From mixin ScrollableT!()

hadjustment
gtk.adjustment.Adjustment hadjustment [@property getter]

Get hadjustment property.

hadjustment
gtk.adjustment.Adjustment hadjustment [@property setter]

Set hadjustment property.

hscrollPolicy
gtk.types.ScrollablePolicy hscrollPolicy [@property getter]

Get hscrollPolicy property.

hscrollPolicy
gtk.types.ScrollablePolicy hscrollPolicy [@property setter]

Set hscrollPolicy property.

vadjustment
gtk.adjustment.Adjustment vadjustment [@property getter]

Get vadjustment property.

vadjustment
gtk.adjustment.Adjustment vadjustment [@property setter]

Set vadjustment property.

vscrollPolicy
gtk.types.ScrollablePolicy vscrollPolicy [@property getter]

Get vscrollPolicy property.

vscrollPolicy
gtk.types.ScrollablePolicy vscrollPolicy [@property setter]

Set vscrollPolicy property.

getBorder
bool getBorder(gtk.border.Border border)

Returns the size of a non-scrolling border around the outside of the scrollable. An example for this would be treeview headers. GTK+ can use this information to display overlayed graphics, like the overshoot indication, at the right position.

getHadjustment
gtk.adjustment.Adjustment getHadjustment()

Retrieves the #GtkAdjustment used for horizontal scrolling.

getHscrollPolicy
gtk.types.ScrollablePolicy getHscrollPolicy()

Gets the horizontal #GtkScrollablePolicy.

getVadjustment
gtk.adjustment.Adjustment getVadjustment()

Retrieves the #GtkAdjustment used for vertical scrolling.

getVscrollPolicy
gtk.types.ScrollablePolicy getVscrollPolicy()

Gets the vertical #GtkScrollablePolicy.

setHadjustment
void setHadjustment(gtk.adjustment.Adjustment hadjustment)

Sets the horizontal adjustment of the #GtkScrollable.

setHscrollPolicy
void setHscrollPolicy(gtk.types.ScrollablePolicy policy)

Sets the #GtkScrollablePolicy to determine whether horizontal scrolling should start below the minimum width or below the natural width.

setVadjustment
void setVadjustment(gtk.adjustment.Adjustment vadjustment)

Sets the vertical adjustment of the #GtkScrollable.

setVscrollPolicy
void setVscrollPolicy(gtk.types.ScrollablePolicy policy)

Sets the #GtkScrollablePolicy to determine whether vertical scrolling should start below the minimum height or below the natural height.

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 Scrollable

_getGType
GType _getGType()
hadjustment
gtk.adjustment.Adjustment hadjustment [@property getter]

Get hadjustment property.

hadjustment
gtk.adjustment.Adjustment hadjustment [@property setter]

Set hadjustment property.

hscrollPolicy
gtk.types.ScrollablePolicy hscrollPolicy [@property getter]

Get hscrollPolicy property.

hscrollPolicy
gtk.types.ScrollablePolicy hscrollPolicy [@property setter]

Set hscrollPolicy property.

vadjustment
gtk.adjustment.Adjustment vadjustment [@property getter]

Get vadjustment property.

vadjustment
gtk.adjustment.Adjustment vadjustment [@property setter]

Set vadjustment property.

vscrollPolicy
gtk.types.ScrollablePolicy vscrollPolicy [@property getter]

Get vscrollPolicy property.

vscrollPolicy
gtk.types.ScrollablePolicy vscrollPolicy [@property setter]

Set vscrollPolicy property.

getBorder
bool getBorder(gtk.border.Border border)

Returns the size of a non-scrolling border around the outside of the scrollable. An example for this would be treeview headers. GTK+ can use this information to display overlayed graphics, like the overshoot indication, at the right position.

getHadjustment
gtk.adjustment.Adjustment getHadjustment()

Retrieves the #GtkAdjustment used for horizontal scrolling.

getHscrollPolicy
gtk.types.ScrollablePolicy getHscrollPolicy()

Gets the horizontal #GtkScrollablePolicy.

getVadjustment
gtk.adjustment.Adjustment getVadjustment()

Retrieves the #GtkAdjustment used for vertical scrolling.

getVscrollPolicy
gtk.types.ScrollablePolicy getVscrollPolicy()

Gets the vertical #GtkScrollablePolicy.

setHadjustment
void setHadjustment(gtk.adjustment.Adjustment hadjustment)

Sets the horizontal adjustment of the #GtkScrollable.

setHscrollPolicy
void setHscrollPolicy(gtk.types.ScrollablePolicy policy)

Sets the #GtkScrollablePolicy to determine whether horizontal scrolling should start below the minimum width or below the natural width.

setVadjustment
void setVadjustment(gtk.adjustment.Adjustment vadjustment)

Sets the vertical adjustment of the #GtkScrollable.

setVscrollPolicy
void setVscrollPolicy(gtk.types.ScrollablePolicy policy)

Sets the #GtkScrollablePolicy to determine whether vertical scrolling should start below the minimum height or below the natural height.