Adw.ClampLayout¶
- Subclasses:
None
Methods¶
- Inherited:
Gtk.LayoutManager (6), GObject.Object (37), Gtk.Orientable (2)
- Structs:
class |
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r/w/en |
|||
r/w/en |
|||
r/w/en |
Signals¶
- Inherited:
Fields¶
- Inherited:
Class Details¶
- class Adw.ClampLayout(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
A layout manager constraining its children to a given size.
<picture> <source srcset=”clamp-wide-dark.png” media=”(prefers-color-scheme: dark)”> <img src=”clamp-wide.png” alt=”clamp-wide”> </picture> <picture> <source srcset=”clamp-narrow-dark.png” media=”(prefers-color-scheme: dark)”> <img src=”clamp-narrow.png” alt=”clamp-narrow”> </picture>
AdwClampLayoutconstraints the size of the widgets it contains to a given maximum size. It will constrain the width if it is horizontal, or the height if it is vertical. The expansion of the children from their minimum to their maximum size is eased out for a smooth transition.If a child requires more than the requested maximum size, it will be allocated the minimum size it can fit in instead.
AdwClampLayoutcan scale with the text scale factor, use the [property`ClampLayout`:py:data::unit<Adw.ClampLayout.props.unit>] property to enable that behavior.- classmethod new()¶
- Returns:
the newly created
AdwClampLayout- Return type:
Creates a new
AdwClampLayout.
- get_maximum_size()¶
- Returns:
the maximum size to allocate to the children
- Return type:
Gets the maximum size allocated to the children.
- get_tightening_threshold()¶
- Returns:
the size above which the children are clamped
- Return type:
Gets the size above which the children are clamped.
- get_unit()¶
- Returns:
the length unit
- Return type:
Gets the length unit for maximum size and tightening threshold.
New in version 1.4.
- set_maximum_size(maximum_size)¶
- Parameters:
maximum_size (
int) – the maximum size
Sets the maximum size allocated to the children.
It is the width if the layout is horizontal, or the height if it is vertical.
- set_tightening_threshold(tightening_threshold)¶
- Parameters:
tightening_threshold (
int) – the tightening threshold
Sets the size above which the children are clamped.
Starting from this size, the layout will tighten its grip on the children, slowly allocating less and less of the available size up to the maximum allocated size. Below that threshold and below the maximum size, the children will be allocated all the available size.
If the threshold is greater than the maximum size to allocate to the children, they will be allocated the whole size up to the maximum. If the threshold is lower than the minimum size to allocate to the children, that size will be used as the tightening threshold.
Effectively, tightening the grip on a child before it reaches its maximum size makes transitions to and from the maximum size smoother when resizing.
- set_unit(unit)¶
- Parameters:
unit (
Adw.LengthUnit) – the length unit
Sets the length unit for maximum size and tightening threshold.
Allows the sizes to vary depending on the text scale factor.
New in version 1.4.
Property Details¶
- Adw.ClampLayout.props.maximum_size¶
- Name:
maximum-size- Type:
- Default Value:
600- Flags:
The maximum size to allocate to the children.
It is the width if the layout is horizontal, or the height if it is vertical.
- Adw.ClampLayout.props.tightening_threshold¶
- Name:
tightening-threshold- Type:
- Default Value:
400- Flags:
The size above which the children are clamped.
Starting from this size, the layout will tighten its grip on the children, slowly allocating less and less of the available size up to the maximum allocated size. Below that threshold and below the maximum size, the children will be allocated all the available size.
If the threshold is greater than the maximum size to allocate to the children, they will be allocated the whole size up to the maximum. If the threshold is lower than the minimum size to allocate to the children, that size will be used as the tightening threshold.
Effectively, tightening the grip on a child before it reaches its maximum size makes transitions to and from the maximum size smoother when resizing.
- Adw.ClampLayout.props.unit¶
- Name:
unit- Type:
- Default Value:
- Flags:
The length unit for maximum size and tightening threshold.
Allows the sizes to vary depending on the text scale factor.
New in version 1.4.