Gtk.Frame – gtk4 Reference Manual

Frame

Object Hierarchy:

Description:

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

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

![An example GtkFrame](frame.png)

If present, the label is drawn inside the top edge of the frame. The horizontal position of the label can be controlled with [ [email protected]_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: ```xml <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> ```

`GtkFrame` has 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; }
The child widget.
public string label { get; set; }
Text of the frame's label.
public Widget label_widget { get; set; }
Widget to display in place of the usual frame label.
public float label_xalign { get; set; }
The horizontal alignment of the label.

Creation methods:

public Frame (string? label)
Creates a new `GtkFrame`, 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 ()
Returns the frame labels text.
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)
Creates a new `GtkLabel` with the label and sets it as the frame's 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

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable

2022 vala-language.org