Class

AdwBreakpointBin

since: 1.4

Description [src]

class Adw.BreakpointBin : Gtk.Widget
  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
  /* No available fields */
}

A widget that changes layout based on available size.

breakpoint-bin

AdwBreakpointBin provides a way to use breakpoints without AdwWindow or AdwApplicationWindow. It can be useful for limiting breakpoints to a single page and similar purposes. Most applications shouldn’t need it.

AdwBreakpointBin is similar to AdwBin. It has one child, set via the AdwBreakpointBin:child property.

When AdwBreakpointBin is resized, its child widget can rearrange its layout at specific thresholds.

The thresholds and layout changes are defined via AdwBreakpoint objects. They can be added using adw_breakpoint_bin_add_breakpoint().

Each breakpoint has a condition, specifying the bin’s size and/or aspect ratio, and setters that automatically set object properties when that happens. The AdwBreakpoint::apply and AdwBreakpoint::unapply can be used instead for more complex scenarios.

Breakpoints are only allowed to modify widgets inside the AdwBreakpointBin, but not on the AdwBreakpointBin itself or any other widgets.

If multiple breakpoints can be used for the current size, the last one is always picked. The current breakpoint can be tracked using the AdwBreakpointBin:current-breakpoint property.

If none of the breakpoints can be used, that property will be set to NULL, and the original property values will be used instead.

Minimum Size

Adding a breakpoint to AdwBreakpointBin will result in it having no minimum size. The GtkWidget:width-request and GtkWidget:height-request properties must always be set when using breakpoints, indicating the smallest size you want to support.

The minimum size and breakpoint conditions must be carefully selected so that the child widget completely fits. If it doesn’t, it will overflow and a warning message will be printed.

When choosing minimum size, consider translations and text scale factor changes. Make sure to leave enough space for text labels, and enable ellipsizing or wrapping if they might not fit.

For GtkLabel this can be done via GtkLabel:ellipsize, or via GtkLabel:wrap together with GtkLabel:wrap-mode.

For buttons, use GtkButton:can-shrink, GtkMenuButton:can-shrink, AdwSplitButton:can-shrink, or AdwButtonContent:can-shrink.

Example

GtkWidget *bin, *child;
AdwBreakpoint *breakpoint;

bin = adw_breakpoint_bin_new ();
gtk_widget_set_size_request (bin, 150, 150);

child = gtk_label_new ("Wide");
gtk_label_set_ellipsize (GTK_LABEL (label), PANGO_ELLIPSIZE_END);
gtk_widget_add_css_class (child, "title-1");
adw_breakpoint_bin_set_child (ADW_BREAKPOINT_BIN (bin), child);

breakpoint = adw_breakpoint_new (adw_breakpoint_condition_parse ("max-width: 200px"));
adw_breakpoint_add_setters (breakpoint,
                            G_OBJECT (child), "label", "Narrow",
                            NULL);
adw_breakpoint_bin_add_breakpoint (ADW_BREAKPOINT_BIN (bin), breakpoint);

The bin has a single label inside it, displaying “Wide”. When the bin’s width is smaller than or equal to 200px, it changes to “Narrow”.

`AdwBreakpointBin` as `GtkBuildable`

AdwBreakpointBin allows adding AdwBreakpoint objects as children.

Example of an AdwBreakpointBin UI definition:

<object class="AdwBreakpointBin">
  <property name="width-request">150</property>
  <property name="height-request">150</property>
  <property name="child">
    <object class="GtkLabel" id="child">
      <property name="label">Wide</property>
      <property name="ellipsize">end</property>
      <style>
        <class name="title-1"/>
      </style>
    </object>
  </property>
  <child>
    <object class="AdwBreakpoint">
      <condition>max-width: 200px</condition>
      <setter object="child" property="label">Narrow</setter>
    </object>
  </child>
</object>

See AdwBreakpoint documentation for details.

Available since: 1.4

Hierarchy

Ancestors

Implements

Constructors

adw_breakpoint_bin_new

Creates a new AdwBreakpointBin.

since: 1.4

Instance methods

adw_breakpoint_bin_add_breakpoint

Adds breakpoint to self.

since: 1.4

adw_breakpoint_bin_get_child

Gets the child widget of self.

since: 1.4

adw_breakpoint_bin_get_current_breakpoint

Gets the current breakpoint.

since: 1.4

adw_breakpoint_bin_set_child

Sets the child widget of self.

since: 1.4

Methods inherited from GtkWidget (162)

unstable since: 4.0

gtk_accessible_update_state_value

Updates an array of accessible states.

unstable since: 4.0

Methods inherited from GtkBuildable (1)

gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

unstable since: 4.0

Properties

Adw.BreakpointBin:child

The child widget.

since: 1.4

Adw.BreakpointBin:current-breakpoint

The current breakpoint.

since: 1.4

Properties inherited from GtkAccessible (1)

Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

unstable since: 4.0

Signals

Signals inherited from GObject (1)

GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

unstable since: 2.0

Class structure

struct AdwBreakpointBinClass {
  GtkWidgetClass parent_class;
  
}

No description available.

Class members

parent_class: GtkWidgetClass: No description available.

Description [src]

Minimum Size

Example

AdwBreakpointBin as GtkBuildable

Hierarchy

Ancestors

Implements

Constructors

Instance methods

Methods inherited from GtkWidget (162)

Methods inherited from GObject (43)

Methods inherited from GtkAccessible (18)

Methods inherited from GtkBuildable (1)

Properties

Properties inherited from GtkWidget (34)

Properties inherited from GtkAccessible (1)

Signals

Signals inherited from GtkWidget (13)

Signals inherited from GObject (1)

Class structure

Class members

`AdwBreakpointBin` as `GtkBuildable`