Class
AdwBreakpointBin
Description [src]
class Adw.BreakpointBin : Gtk.Widget {
parent_instance: GtkWidget
}
A widget that changes layout based on available size.
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 |