Class BreakpointBin

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.gobject.TypeInstance
org.gnome.gobject.GObject
org.gnome.gobject.InitiallyUnowned
org.gnome.gtk.Widget
org.gnome.adw.BreakpointBin
All Implemented Interfaces:
Accessible, Buildable, ConstraintTarget, Proxy
@Generated("org.javagi.JavaGI") public class BreakpointBin extends Widget implements Accessible, Buildable, ConstraintTarget

A widget that changes layout based on available size.

breakpoint-bin

AdwBreakpointBin provides a way to use breakpoints without Window, ApplicationWindow or Dialog. It can be useful for limiting breakpoints to a single page and similar purposes. Most applications shouldn't need it.

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

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

The thresholds and layout changes are defined via Breakpoint objects. They can be added using addBreakpoint(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 Breakpoint::apply and Breakpoint::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 BreakpointBin: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 Gtk.Widget:width-request and Gtk.Widget: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 Label this can be done via Gtk.Label:ellipsize, or via Gtk.Label:wrap together with Gtk.Label:wrap-mode.

For buttons, use Gtk.Button:can-shrink, Gtk.MenuButton:can-shrink, Adw.SplitButton:can-shrink, or Adw.ButtonContent: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 Breakpoint documentation for details.

Since:
1.4

  • Constructor Details

    • BreakpointBin

      public BreakpointBin(MemorySegment address)
      Create a BreakpointBin instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • BreakpointBin

      public BreakpointBin()
      Create a new BreakpointBin.

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the BreakpointBin class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • asParent

      protected BreakpointBin asParent()
      Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.
      Overrides:
      asParent in class Widget
      Returns:
      the instance as if it were its parent type

    • addBreakpoint

      public void addBreakpoint(Breakpoint breakpoint)
      Adds breakpoint to self.
      Parameters:
      breakpoint - the breakpoint to add
      Since:
      1.4

    • getChild

      public @Nullable Widget getChild()
      Gets the child widget of self.
      Returns:
      the child widget of this BreakpointBin
      Since:
      1.4

    • getCurrentBreakpoint

      public @Nullable Breakpoint getCurrentBreakpoint()
      Gets the current breakpoint.
      Returns:
      the current breakpoint
      Since:
      1.4

    • removeBreakpoint

      public void removeBreakpoint(Breakpoint breakpoint)
      Removes breakpoint from self.
      Parameters:
      breakpoint - a breakpoint to remove
      Since:
      1.5

    • setChild

      public void setChild(@Nullable Widget child)
      Sets the child widget of self.
      Parameters:
      child - the child widget
      Since:
      1.4

    • builder

      public static BreakpointBin.Builder<? extends BreakpointBin.Builder> builder()
      A BreakpointBin.Builder object constructs a BreakpointBin with the specified properties. Use the various set...() methods to set properties, and finish construction with BreakpointBin.Builder.build().
      Returns:
      the builder object