Adw.BreakpointBin¶

Subclasses:: None

Methods¶

Inherited:: Gtk.Widget (181), GObject.Object (37), Gtk.Accessible (15), Gtk.Buildable (1)
Structs:: Gtk.WidgetClass (18), GObject.ObjectClass (5)

class	`new` ()
	`add_breakpoint` (breakpoint)
	`get_child` ()
	`get_current_breakpoint` ()
	`remove_breakpoint` (breakpoint)
	`set_child` (child)

Virtual Methods¶

Inherited:: Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9)

Properties¶

Inherited:: Gtk.Widget (34), Gtk.Accessible (1)

Name	Type	Flags	Short Description
`child`	`Gtk.Widget`	r/w/en
`current-breakpoint`	`Adw.Breakpoint`	r

Signals¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Fields¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Gtk.Widget`	r

Class Details¶

class Adw.BreakpointBin(**kwargs)¶

Bases:: Gtk.Widget
Abstract:: No
Structure:: Adw.BreakpointBinClass

A widget that changes layout based on available size.

AdwBreakpointBin provides a way to use breakpoints without [class`Window`], [class`ApplicationWindow`] or [class`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 [class`Bin`]. It has one child, set via the [property`BreakpointBin`:py:data::child<Adw.BreakpointBin.props.child>] property.

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

The thresholds and layout changes are defined via [class`Breakpoint`] objects. They can be added using [method`BreakpointBin`.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 [signal`Breakpoint`:py:func:::apply<Adw.BreakpointBin.signals.apply>] and [signal`Breakpoint`:py:func:::unapply<Adw.BreakpointBin.signals.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 [property`BreakpointBin`:py:data::current-breakpoint<Adw.BreakpointBin.props.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 [property`Gtk`.Widget:width-request] and [property`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 [class`Gtk`.Label] this can be done via [property`Gtk`.Label:ellipsize], or via [property`Gtk`.Label:wrap] together with [property`Gtk`.Label:wrap-mode].

For buttons, use [property`Gtk`.Button:can-shrink], [property`Gtk`.MenuButton:can-shrink], [property`Adw`.SplitButton:can-shrink], or [property`Adw`.ButtonContent:can-shrink].

Example

```c Gtk.Widget *bin, *child; Adw.Breakpoint *breakpoint;

bin = Adw.BreakpointBin.new (); Gtk.Widget.set_size_request (bin, 150, 150);

child = Gtk.Label.new (“Wide”); Gtk.Label.set_ellipsize (GTK_LABEL (label), Pango.EllipsizeMode.END); Gtk.Widget.add_css_class (child, “title-1”); Adw.BreakpointBin.set_child (ADW_BREAKPOINT_BIN (bin), child);

breakpoint = Adw.Breakpoint.new (Adw.BreakpointCondition.parse (“max-width: 200px”)); Adw.Breakpoint.add_setters (breakpoint, G_OBJECT (child), “label”, “Narrow”, None); Adw.BreakpointBin.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”.

Adw.BreakpointBin as Gtk.Buildable

AdwBreakpointBin allows adding AdwBreakpoint objects as children.

Example of an AdwBreakpointBin UI definition:

``xml <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 [class`Breakpoint`] documentation for details.

New in version 1.4.

classmethod new()¶

Returns:: the newly created AdwBreakpointBin
Return type:: Gtk.Widget

Creates a new AdwBreakpointBin.

New in version 1.4.

add_breakpoint(breakpoint)¶

Parameters:: breakpoint (Adw.Breakpoint) – the breakpoint to add

Adds breakpoint to self.

New in version 1.4.

get_child()¶

Returns:: the child widget of self
Return type:: Gtk.Widget or None

Gets the child widget of self.

New in version 1.4.

get_current_breakpoint()¶

Returns:: the current breakpoint
Return type:: Adw.Breakpoint or None

Gets the current breakpoint.

New in version 1.4.

remove_breakpoint(breakpoint)¶

Parameters:: breakpoint (Adw.Breakpoint) – a breakpoint to remove

Removes breakpoint from self.

New in version 1.5.

set_child(child)¶

Parameters:: child (Gtk.Widget or None) – the child widget

Sets the child widget of self.

New in version 1.4.

Property Details¶

Adw.BreakpointBin.props.child¶

Name:: child
Type:: Gtk.Widget
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The child widget.

New in version 1.4.

Adw.BreakpointBin.props.current_breakpoint¶

Name:: current-breakpoint
Type:: Adw.Breakpoint
Default Value:: None
Flags:: READABLE

The current breakpoint.

New in version 1.4.