gtk.frame

Module for [Frame] class

class Frame FrameGidBuilder FrameGidBuilderImpl

Types 3

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 [gtk.frame.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 [gtk.frame.Frame]:

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

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 [gtk.frame.Frame.setShadowType] with [gtk.types.ShadowType.None] to add the “.flat” class or any other shadow type to remove it.

Methods

GType _getGType()

GType _gType() @property

Frame self()Returns `this`, for use in `with` statements.

FrameGidBuilder builder()Get builder for [gtk.frame.Frame] Returns: New builder object

string label() @property

void label(string propval) @property

gtk.widget.Widget labelWidget() @property

void labelWidget(gtk.widget.Widget propval) @property

float labelXalign() @property

void labelXalign(float propval) @property

float labelYalign() @property

void labelYalign(float propval) @property

gtk.types.ShadowType shadowType() @property

void shadowType(gtk.types.ShadowType propval) @property

string getLabel()If the frame’s label widget is a #GtkLabel, returns the text in the label widget. (The frame will have a #GtkLabel for the label widget if a non-null argument was passed to [gtk.frame.Frame.new_]...

void getLabelAlign(out float xalign, out float yalign)Retrieves the X and Y alignment of the frame’s label. See [gtk.frame.Frame.setLabelAlign].

gtk.widget.Widget getLabelWidget()Retrieves the label widget for the frame. See [gtk.frame.Frame.setLabelWidget]. Returns: the label widget, or null if there is none.

gtk.types.ShadowType getShadowType()Retrieves the shadow type of the frame. See [gtk.frame.Frame.setShadowType]. Returns: the current shadow type of the frame.

void setLabel(string label = null)Removes the current #GtkFrame:label-widget. If label is not null, creates a new #GtkLabel with that text and adds it as the #GtkFrame: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(gtk.widget.Widget labelWidget = null)Sets the #GtkFrame: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(gtk.types.ShadowType type)Sets the #GtkFrame:shadow-type for frame, i.e. whether it is drawn without ([gtk.types.ShadowType.None]) or with (other values) a visible border. Values other than [gtk.types.ShadowType.None] are t...

Constructors

this(void * ptr, Flag!"Take" take)

this(string label = null)Creates a new #GtkFrame, with optional label label. If label is null, the label is omitted.

classFrameGidBuilderImpl(T) : gtk.bin.BinGidBuilderImpl!T

Methods

T label(string propval)

T labelWidget(gtk.widget.Widget propval)

T labelXalign(float propval)

T labelYalign(float propval)

T shadowType(gtk.types.ShadowType propval)

classFrameGidBuilder : FrameGidBuilderImpl!FrameGidBuilder

Fluent builder for [gtk.frame.Frame]

Methods

Frame build()