adw.squeezer

Module for [Squeezer] class

class Squeezer SqueezerGidBuilder SqueezerGidBuilderImpl

Types 3

classSqueezer : gtk.widget.Widget, gtk.orientable.Orientable

A best fit container.

squeezer-wide squeezer-narrow

The [adw.squeezer.Squeezer] widget is a container which only shows the first of its children that fits in the available size. It is convenient to offer different widgets to represent the same data with different levels of detail, making the widget seem to squeeze itself to fit in the available space.

Transitions between children can be animated as fades. This can be controlled with property@Squeezer:transition-type.

CSS nodes

[adw.squeezer.Squeezer] has a single CSS node with name squeezer.

Deprecated

See the migration guide
Methods
GType _getGType()
GType _gType() @property
Squeezer self()Returns `this`, for use in `with` statements.
SqueezerGidBuilder builder()Get builder for [adw.squeezer.Squeezer] Returns: New builder object
bool allowNone() @propertyGet `allowNone` property. Returns: Whether to allow squeezing beyond the last child's minimum size.
void allowNone(bool propval) @propertySet `allowNone` property. Params: propval = Whether to allow squeezing beyond the last child's minimum size.
bool homogeneous() @propertyGet `homogeneous` property. Returns: Whether all children have the same size for the opposite orientation.
void homogeneous(bool propval) @propertySet `homogeneous` property. Params: propval = Whether all children have the same size for the opposite orientation.
bool interpolateSize() @propertyGet `interpolateSize` property. Returns: Whether the squeezer interpolates its size when changing the visible child.
void interpolateSize(bool propval) @propertySet `interpolateSize` property. Params: propval = Whether the squeezer interpolates its size when changing the visible child.
gtk.selection_model.SelectionModel pages() @propertyGet `pages` property. Returns: A selection model with the squeezer's pages.
adw.types.FoldThresholdPolicy switchThresholdPolicy() @propertyGet `switchThresholdPolicy` property. Returns: The switch threshold policy.
void switchThresholdPolicy(adw.types.FoldThresholdPolicy propval) @propertySet `switchThresholdPolicy` property. Params: propval = The switch threshold policy.
uint transitionDuration() @propertyGet `transitionDuration` property. Returns: The transition animation duration, in milliseconds.
void transitionDuration(uint propval) @propertySet `transitionDuration` property. Params: propval = The transition animation duration, in milliseconds.
bool transitionRunning() @propertyGet `transitionRunning` property. Returns: Whether a transition is currently running.
adw.types.SqueezerTransitionType transitionType() @propertyGet `transitionType` property. Returns: The type of animation used for transitions between children.
void transitionType(adw.types.SqueezerTransitionType propval) @propertySet `transitionType` property. Params: propval = The type of animation used for transitions between children.
gtk.widget.Widget visibleChild() @propertyGet `visibleChild` property. Returns: The currently visible child.
float xalign() @propertyGet `xalign` property. Returns: The horizontal alignment, from 0 (start) to 1 (end).
void xalign(float propval) @propertySet `xalign` property. Params: propval = The horizontal alignment, from 0 (start) to 1 (end).
float yalign() @propertyGet `yalign` property. Returns: The vertical alignment, from 0 (top) to 1 (bottom).
void yalign(float propval) @propertySet `yalign` property. Params: propval = The vertical alignment, from 0 (top) to 1 (bottom).
adw.squeezer_page.SqueezerPage add(gtk.widget.Widget child)Adds a child to self.
bool getAllowNone()Gets whether to allow squeezing beyond the last child's minimum size. Returns: whether self allows squeezing beyond the last child
bool getHomogeneous()Gets whether all children have the same size for the opposite orientation. Returns: whether self is homogeneous
bool getInterpolateSize()Gets whether self interpolates its size when changing the visible child. Returns: whether the size is interpolated
adw.squeezer_page.SqueezerPage getPage(gtk.widget.Widget child)Returns the `classSqueezerPage` object for child.
gtk.selection_model.SelectionModel getPages()Returns a [gio.list_model.ListModel] that contains the pages of self.
adw.types.FoldThresholdPolicy getSwitchThresholdPolicy()Gets the switch threshold policy for self. Returns: the fold threshold policy
uint getTransitionDuration()Gets the transition animation duration for self. Returns: the transition duration, in milliseconds
bool getTransitionRunning()Gets whether a transition is currently running for self.
adw.types.SqueezerTransitionType getTransitionType()Gets the type of animation used for transitions between children in self. Returns: the current transition type of self
gtk.widget.Widget getVisibleChild()Gets the currently visible child of self. Returns: the visible child
float getXalign()Gets the horizontal alignment, from 0 (start) to 1 (end). Returns: the alignment value
float getYalign()Gets the vertical alignment, from 0 (top) to 1 (bottom). Returns: the alignment value
void remove(gtk.widget.Widget child)Removes a child widget from self.
void setAllowNone(bool allowNone)Sets whether to allow squeezing beyond the last child's minimum size.
void setHomogeneous(bool homogeneous)Sets whether all children have the same size for the opposite orientation.
void setInterpolateSize(bool interpolateSize)Sets whether self interpolates its size when changing the visible child.
void setSwitchThresholdPolicy(adw.types.FoldThresholdPolicy policy)Sets the switch threshold policy for self.
void setTransitionDuration(uint duration)Sets the transition animation duration for self.
void setTransitionType(adw.types.SqueezerTransitionType transition)Sets the type of animation used for transitions between children in self.
void setXalign(float xalign)Sets the horizontal alignment, from 0 (start) to 1 (end).
void setYalign(float yalign)Sets the vertical alignment, from 0 (top) to 1 (bottom).
Constructors
this(void * ptr, Flag!"Take" take)
this()Creates a new [adw.squeezer.Squeezer]. Returns: the newly created [adw.squeezer.Squeezer]
classSqueezerGidBuilderImpl(T) : gtk.widget.WidgetGidBuilderImpl!T, gtk.orientable.OrientableGidBuilderImpl!T
Methods
T allowNone(bool propval)Set `allowNone` property. Params: propval = Whether to allow squeezing beyond the last child's minimum size.
T homogeneous(bool propval)Set `homogeneous` property. Params: propval = Whether all children have the same size for the opposite orientation.
T interpolateSize(bool propval)Set `interpolateSize` property. Params: propval = Whether the squeezer interpolates its size when changing the visible child.
T switchThresholdPolicy(adw.types.FoldThresholdPolicy propval)Set `switchThresholdPolicy` property. Params: propval = The switch threshold policy.
T transitionDuration(uint propval)Set `transitionDuration` property. Params: propval = The transition animation duration, in milliseconds. Returns: Builder instance for fluent chaining
T transitionType(adw.types.SqueezerTransitionType propval)Set `transitionType` property. Params: propval = The type of animation used for transitions between children. Returns: Builder instance for fluent chaining
T xalign(float propval)Set `xalign` property. Params: propval = The horizontal alignment, from 0 (start) to 1 (end).
T yalign(float propval)Set `yalign` property. Params: propval = The vertical alignment, from 0 (top) to 1 (bottom).
classSqueezerGidBuilder : SqueezerGidBuilderImpl!SqueezerGidBuilder

Fluent builder for [adw.squeezer.Squeezer]

Methods
Squeezer build()