Adw.BreakpointBin
Description: Reference for Adw.BreakpointBin

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

`AdwBreakpointBin` provides a way to use breakpoints without `AdwWindow`, `AdwApplicationWindow` or `AdwDialog`. 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

- GtkWidget
- GInitiallyUnowned
- GObject

#### Implements

- GtkAccessible
- GtkBuildable
- GtkConstraintTarget

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

Removes `breakpoint` from `self`.

since: 1.5

###### adw_breakpoint_bin_set_child

Sets the child widget of `self`.

since: 1.4

##### Methods inherited from GtkWidget (164)

Please see GtkWidget for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from GtkAccessible (20)

###### gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

###### gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

###### gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

###### gtk_accessible_get_at_context

Retrieves the implementation for the given accessible object.

###### gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

###### gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

###### gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

###### gtk_accessible_get_platform_state

Queries a platform state, such as focus.

###### gtk_accessible_reset_property

Resets the accessible property to its default value.

###### gtk_accessible_reset_relation

Resets the accessible relation to its default value.

###### gtk_accessible_reset_state

Resets the accessible state to its default value.

###### gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

###### gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling.

###### gtk_accessible_update_platform_state

Informs ATs that the platform state has changed.

###### gtk_accessible_update_property

Updates a list of accessible properties.

###### gtk_accessible_update_property_value

Updates an array of accessible properties.

###### gtk_accessible_update_relation

Updates a list of accessible relations.

###### gtk_accessible_update_relation_value

Updates an array of accessible relations.

###### gtk_accessible_update_state

Updates a list of accessible states.

###### gtk_accessible_update_state_value

Updates an array of accessible states.

##### Methods inherited from GtkBuildable (1)

###### gtk_buildable_get_buildable_id

Gets the ID of the `buildable` object.

#### Properties

###### Adw.BreakpointBin:child

The child widget.

since: 1.4

###### Adw.BreakpointBin:current-breakpoint

The current breakpoint.

since: 1.4

##### Properties inherited from GtkWidget (35)

###### Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

###### Gtk.Widget:can-target

Whether the widget can receive pointer events.

###### Gtk.Widget:css-classes

A list of css classes applied to this widget.

###### Gtk.Widget:css-name

The name of this widget in the CSS tree.

###### Gtk.Widget:cursor

The cursor used by `widget`.

###### Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

###### Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

###### Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

###### Gtk.Widget:has-default

Whether the widget is the default widget.

###### Gtk.Widget:has-focus

Whether the widget has the input focus.

###### Gtk.Widget:has-tooltip

Enables or disables the emission of the `GtkWidget::query-tooltip` signal on `widget`.

###### Gtk.Widget:height-request

Overrides for height request of the widget.

###### Gtk.Widget:hexpand

Whether to expand horizontally.

###### Gtk.Widget:hexpand-set

Whether to use the `hexpand` property.

###### Gtk.Widget:layout-manager

The `GtkLayoutManager` instance to use to compute the preferred size of the widget, and allocate its children.

###### Gtk.Widget:limit-events

Makes this widget act like a modal dialog, with respect to event delivery.

###### Gtk.Widget:margin-bottom

Margin on bottom side of widget.

###### Gtk.Widget:margin-end

Margin on end of widget, horizontally.

###### Gtk.Widget:margin-start

Margin on start of widget, horizontally.

###### Gtk.Widget:margin-top

Margin on top side of widget.

###### Gtk.Widget:name

The name of the widget.

###### Gtk.Widget:opacity

The requested opacity of the widget.

###### Gtk.Widget:overflow

How content outside the widget’s content area is treated.

###### Gtk.Widget:parent

The parent widget of this widget.

###### Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

###### Gtk.Widget:root

The `GtkRoot` widget of the widget tree containing this widget.

###### Gtk.Widget:scale-factor

The scale factor of the widget.

###### Gtk.Widget:sensitive

Whether the widget responds to input.

###### Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

###### Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

###### Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

###### Gtk.Widget:vexpand

Whether to expand vertically.

###### Gtk.Widget:vexpand-set

Whether to use the `vexpand` property.

###### Gtk.Widget:visible

Whether the widget is visible.

###### Gtk.Widget:width-request

Overrides for width request of the widget.

##### Properties inherited from GtkAccessible (1)

###### Gtk.Accessible:accessible-role

The accessible role of the given `GtkAccessible` implementation.

#### Signals

##### Signals inherited from GtkWidget (13)

###### GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

###### GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

###### GtkWidget::hide

Emitted when `widget` is hidden.

###### GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

###### GtkWidget::map

Emitted when `widget` is going to be mapped.

###### GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

###### GtkWidget::move-focus

Emitted when the focus is moved.

###### GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

###### GtkWidget::realize

Emitted when `widget` is associated with a `GdkSurface`.

###### GtkWidget::show

Emitted when `widget` is shown.

###### GtkWidget::state-flags-changed

Emitted when the widget state changes.

###### GtkWidget::unmap

Emitted when `widget` is going to be unmapped.

###### GtkWidget::unrealize

Emitted when the `GdkSurface` associated with `widget` is destroyed.

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

#### Class structure

    struct AdwBreakpointBinClass {
      GtkWidgetClass parent_class;

    }

No description available.

###### Class members

`parent_class: GtkWidgetClass`

  No description available.