Gtk.Frame – gtk+-3.0 Reference Manual

Frame

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_frame_get_type ()" ) ]
public class Frame : Bin, Implementor, Buildable

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 set_label_align.

GtkFrame as GtkBuildable

The GtkFrame implementation of the Buildable 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
├── border[.flat]
├── <label widget>
╰── <child>

ain 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 set_shadow_type with gtk_shadow_none to add the “.flat” class or any other shadow type to remove it.

GtkFrame

All known sub-classes:

AspectFrame

Namespace: Gtk

Package: gtk+-3.0

Content:

Properties:

public string label { get; set; }
public Widget label_widget { get; set; }
public float label_xalign { get; set; }
public float label_yalign { get; set; }
public ShadowType shadow_type { 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 string? get_label ()
If the frame’s label widget is a Label, returns the text in the label widget.
public void get_label_align (out float xalign, out float yalign)
Retrieves the X and Y alignment of the frame’s label.
public unowned Widget? get_label_widget ()
Retrieves the label widget for the frame.
public ShadowType get_shadow_type ()
Retrieves the shadow type of the frame.
public void set_label (string? label)
Removes the current label_widget.
public void set_label_align (float xalign, float yalign)
Sets the alignment of the frame widget’s label.
public void set_label_widget (Widget? label_widget)
Sets the label_widget for the frame.
public void set_shadow_type (ShadowType type)
Sets the shadow_type for this, i.

Inherited Members:

All known members inherited from class Gtk.Bin

get_child

All known members inherited from class Gtk.Container

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 Atk.Implementor

ref_accessible

All known members inherited from interface Gtk.Buildable

2022 vala-language.org