Frame

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_frame_get_type ()" ) ]
public class Frame : Widget, Accessible, Buildable, ConstraintTarget

The frame widget is a widget that surrounds its child with a decorative frame and an optional label.

If present, the label is drawn inside the top edge of the frame. The horizontal position of the label can be controlled with set_label_align.

GtkFrame clips its child. You can use this to add rounded corners to widgets, but be aware that it also cuts off shadows.

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

frame
├── <label widget>
╰── <child>

as a main CSS node with name “frame”, which is used to draw the visible border. You can set the appearance of the border using CSS properties like “border-style” on this node.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public Widget child { get; set; }
public string label { get; set; }
public Widget label_widget { get; set; }
public float label_xalign { get; set; }

Creation methods:

public Frame (string? label)
Creates a new Frame, with optional label label.

Methods:

public virtual void compute_child_allocation (Allocation allocation)
public unowned Widget? get_child ()
Gets the child widget of this.
public unowned string? get_label ()
If the frame’s label widget is a Label, returns the text in the label widget.
public float get_label_align ()
Retrieves the X alignment of the frame’s label.
public unowned Widget? get_label_widget ()
Retrieves the label widget for the frame.
public void set_child (Widget? child)
Sets the child widget of this.
public void set_label (string? label)
Removes the current label_widget.
public void set_label_align (float xalign)
Sets the X alignment of the frame widget’s label.
public void set_label_widget (Widget? label_widget)
Sets the label_widget for the frame.

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable