class Adw::Breakpoint

• Adw::Breakpoint
• GObject::Object
• Reference
• Object

Overview

Describes a breakpoint for #Window or #Dialog.

Breakpoints are used to create adaptive UI, allowing to change the layout depending on available size.

Breakpoint is a size threshold, specified by its condition, as well as one or more setters.

Each setter has a target object, a property and a value. When a breakpoint is applied, each setter sets the target property on their target object to the specified value, and reset it back to the original value when it's unapplied.

For more complicated scenarios, Breakpoint::#apply and Breakpoint::#unapply can be used instead.

Breakpoints can be used within #Window, #ApplicationWindow, #Dialog or #BreakpointBin.

Adw::Breakpoint as Gtk::Buildable:

Adw::Breakpoint supports specifying its condition via the <condition> element. The contents of the element must be a string in a format accepted by BreakpointCondition::parse.

It also supports adding setters via the <setter> element. Each <setter> element must have the object attribute specifying the target object, and the property attribute specifying the property name. The contents of the element are used as the setter value.

For G_TYPE_OBJECT and G_TYPE_BOXED derived properties, empty contents are treated as NULL.

Setter values can be translated with the usual translatable, context and comments attributes.

Example of an Adw::Breakpoint UI definition:

WARNING ⚠️ The following code is in xml ⚠️

<object class="Adw::Breakpoint">
  <condition>max-width: 400px</condition>
  <setter object="button" property="visible">True</setter>
  <setter object="box" property="orientation">vertical</setter>
  <setter object="page" property="title" translatable="yes">Example</setter>
</object>

Included Modules

• Gtk::Buildable

Defined in:

Constructors

• .new(condition : Adw::BreakpointCondition) : self

  Creates a new Adw::Breakpoint with condition.

• .new

  Initialize a new Breakpoint.

• .new(*, condition : Adw::BreakpointCondition | Nil = nil)

Class Method Summary

• .g_type : UInt64

  Returns the type id (GType) registered in GLib type system.

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #add_setter(object : GObject::Object, property : String, value : _ | Nil) : Nil

  Adds a setter to self.

• #add_setters(objects : Enumerable(GObject::Object), names : Enumerable(String), values : Enumerable(_)) : Nil

  Adds multiple setters to self.

• #apply_signal
• #condition : Adw::BreakpointCondition | Nil

  Gets the condition for self.

• #condition=(condition : Adw::BreakpointCondition | Nil) : Nil

  Sets the condition for self.

• #hash(hasher)

  See Object#hash(hasher)

• #unapply_signal

Constructor Detail

Class Method Detail

Instance Method Detail

static void
breakpoint_apply_cb (MyWidget *self)
{
  gtk_button_set_icon_name (self->button, "go-previous-symbolic");
}

static void
breakpoint_apply_cb (MyWidget *self)
{
  gtk_button_set_label (self->button, _("_Back"));
}

// ...

g_signal_connect_swapped (breakpoint, "apply",
                          G_CALLBACK (breakpoint_apply_cb), self);
g_signal_connect_swapped (breakpoint, "unapply",
                          G_CALLBACK (breakpoint_unapply_cb), self);

adw_breakpoint_add_setters (breakpoint,
                            G_OBJECT (box), "orientation", GTK_ORIENTATION_VERTICAL,
                            G_OBJECT (button), "halign", GTK_ALIGN_FILL,
                            G_OBJECT (button), "valign", GTK_ALIGN_END,
                            NULL);