The frame widget is a bin that surrounds its child with a decorative frame and an optional label. If present, the label is drawn in a gap in the top side of the frame. The position of the label can be controlled with Frame.setLabelAlign.

GtkFrame as GtkBuildable

The GtkFrame implementation of the GtkBuildable interface supports placing a child in the label position by specifying “label” as the “type” attribute of a <child> element. A normal content child can be specified without specifying a <child> type attribute.

An example of a UI definition fragment with GtkFrame: |[ <object class="GtkFrame"> <child type="label"> <object class="GtkLabel" id="frame-label"/> </child> <child> <object class="GtkEntry" id="frame-content"/> </child> </object>

# CSS nodes

|[<!-- language="plain" -->
├── border[.flat]
├── <label widget>
╰── <child>

GtkFrame has a main CSS node named “frame” and a subnode named “border”. The “border” node is used to draw the visible border. You can set the appearance of the border using CSS properties like “border-style” on the “border” node.

The border node can be given the style class “.flat”, which is used by themes to disable drawing of the border. To do this from code, call Frame.setShadowType with GTK_SHADOW_NONE to add the “.flat” class or any other shadow type to remove it.


this(GtkFrame* gtkFrame, bool ownedRef)

Sets our main struct and passes it to the parent class.

this(Widget widget, string label)

Creates frame with label and set it's child widget

this(string label)

Creates a new gtk.Frame, with optional label label. If label is NULL, the label is omitted.



GtkFrame* getFrameStruct(bool transferOwnership)

Get the main Gtk struct

string getLabel()

If the frame’s label widget is a gtk.Label, returns the text in the label widget. (The frame will have a gtk.Label for the label widget if a non-NULL argument was passed to

void getLabelAlign(float xalign, float yalign)

Retrieves the X and Y alignment of the frame’s label. See Frame.setLabelAlign.

Widget getLabelWidget()

Retrieves the label widget for the frame. See Frame.setLabelWidget.

GtkShadowType getShadowType()

Retrieves the shadow type of the frame. See Frame.setShadowType.

void* getStruct()

the main Gtk struct as a void*

void setLabel(string label)

Removes the current label-widget. If label is not NULL, creates a new gtk.Label with that text and adds it as the label-widget.

void setLabelAlign(float xalign, float yalign)

Sets the alignment of the frame widget’s label. The default values for a newly created frame are 0.0 and 0.5.

void setLabelWidget(Widget labelWidget)

Sets the label-widget for the frame. This is the widget that will appear embedded in the top edge of the frame as a title.

void setShadowType(GtkShadowType type)

Sets the shadow-type for frame, i.e. whether it is drawn without (GTK_SHADOW_NONE) or with (other values) a visible border. Values other than GTK_SHADOW_NONE are treated identically by GtkFrame. The chosen type is applied by removing or adding the .flat class to the CSS node named border.

Static functions

GType getType()


GtkFrame* gtkFrame;

the main Gtk struct

Inherited Members

From Bin

GtkBin* gtkBin;

the main Gtk struct

GtkBin* getBinStruct(bool transferOwnership)

Get the main Gtk struct

void* getStruct()

the main Gtk struct as a void*

GType getType()
Widget getChild()

Gets the child of the gtk.Bin, or NULL if the bin contains no child widget. The returned widget does not have a reference added, so you do not need to unref it.