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_get_bin_window(), rather than to the one returned by gtk_widget_get_window() as you would for a #GtkDrawingArea.

class Layout : Container , ScrollableIF {

protected

GtkLayout* gtkLayout;

GtkLayout* getLayoutStruct(bool transferOwnership);

void* getStruct();

this(GtkLayout* gtkLayout, bool ownedRef);

mixin ScrollableT!(GtkLayout) ;

static GType getType();

this(Adjustment hadjustment, Adjustment vadjustment);

Window getBinWindow();

Adjustment getHadjustment();

void getSize(uint width, uint height);

Adjustment getVadjustment();

void move(Widget childWidget, int x, int y);

void put(Widget childWidget, int x, int y);

void setHadjustment(Adjustment adjustment);

void setSize(uint width, uint height);

void setVadjustment(Adjustment adjustment);

}

Constructors

this this(GtkLayout* gtkLayout, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(Adjustment hadjustment, 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 Window getBinWindow(): Retrieve the bin window of the layout used for drawing operations.
getHadjustment 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.
getLayoutStruct GtkLayout* getLayoutStruct(bool transferOwnership): Get the main Gtk struct
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 ().
getStruct void* getStruct(): the main Gtk struct as a void*
getVadjustment 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(Widget childWidget, int x, int y): Moves a current child of @layout to a new position.
put void put(Widget childWidget, int x, int y): Adds @child_widget to @layout, at position (@x,@y). @layout becomes the new parent container of @child_widget.
setHadjustment void setHadjustment(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(Adjustment adjustment): Sets the vertical scroll adjustment for the layout.

Mixins

__anonymous mixin ScrollableT!(GtkLayout): Undocumented in source.

Static functions

getType GType getType()

Variables

gtkLayout GtkLayout* gtkLayout;: 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 #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_pack_start() and gtk_grid_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.
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 #GtkWidget::child-notify signal for the [child property][child-properties] @child_property on the child.
childNotifyByPspec void childNotifyByPspec(Widget child, ParamSpec pspec): Emits a #GtkWidget::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.
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. 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_set_border_width().
getChildren ListG getChildren(): Returns the container’s non-internal children. See gtk_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 gtk_window_get_focus().
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 gtk_container_set_focus_vadjustment().
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 #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_propagate_draw() 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 gtk_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 gtk_scrolled_window_get_hadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_vadjustment() 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 gtk_scrolled_window_get_vadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_hadjustment() 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 gtk_container_set_focus_chain().
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 ScrollableIF

getScrollableStruct GtkScrollable* getScrollableStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
getBorder bool getBorder(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 Adjustment getHadjustment(): Retrieves the #GtkAdjustment used for horizontal scrolling.
getHscrollPolicy GtkScrollablePolicy getHscrollPolicy(): Gets the horizontal #GtkScrollablePolicy.
getVadjustment Adjustment getVadjustment(): Retrieves the #GtkAdjustment used for vertical scrolling.
getVscrollPolicy GtkScrollablePolicy getVscrollPolicy(): Gets the vertical #GtkScrollablePolicy.
setHadjustment void setHadjustment(Adjustment hadjustment): Sets the horizontal adjustment of the #GtkScrollable.
setHscrollPolicy void setHscrollPolicy(GtkScrollablePolicy policy): Sets the #GtkScrollablePolicy to determine whether horizontal scrolling should start below the minimum width or below the natural width.
setVadjustment void setVadjustment(Adjustment vadjustment): Sets the vertical adjustment of the #GtkScrollable.
setVscrollPolicy void setVscrollPolicy(GtkScrollablePolicy policy): Sets the #GtkScrollablePolicy to determine whether vertical scrolling should start below the minimum height or below the natural height.