Bis.Album – libbismuth-1 – Vala Binding Reference

Description:

[ CCode ( type_id = "bis_album_get_type ()" ) ]
[ Version ( since = "1.0" ) ]
public sealed class Album : Widget, Swipeable, Accessible, Buildable, ConstraintTarget, Orientable

An adaptive container acting like a box or a stack.

The `BisAlbum` widget can display its children like a [class@Gtk.Box] does or like a [class@Gtk.Stack] does, adapting to size changes by switching between the two modes.

When there is enough space the children are displayed side by side, otherwise only one is displayed and the album is said to be “folded”. The threshold is dictated by the preferred minimum sizes of the children. When a album is folded, the children can be navigated using swipe gestures.

The “over” and “under” transition types stack the children one on top of the other, while the “slide” transition puts the children side by side. While navigating to a child on the side or below can be performed by swiping the current child away, navigating to an upper child requires dragging it from the edge where it resides. This doesn't affect non-dragging swipes.

CSS nodes

`BisAlbum` has a single CSS node with name `album`. The node will get the style classes `.folded` when it is folded, `.unfolded` when it's not, or none if it hasn't computed its fold yet.

Namespace: Bis

Content:

Properties:

public bool can_navigate_back { get; set; }

Whether gestures and shortcuts for navigating backward are enabled.

public bool can_navigate_forward { get; set; }

Whether gestures and shortcuts for navigating forward are enabled.

public bool can_unfold { get; set; }

Whether or not the album can unfold.

public SpringParams child_transition_params { owned get; set; }

The child transition spring parameters.

public bool child_transition_running { get; }

Whether a child transition is currently running.

public FoldThresholdPolicy fold_threshold_policy { get; set; }

Determines when the album will fold.

public bool folded { get; }

Whether the album is folded.

public bool homogeneous { get; set; }

Whether the album allocates the same size for all children when folded.

public uint mode_transition_duration { get; set; }

The mode transition animation duration, in milliseconds.

public SelectionModel pages { owned get; }

A selection model with the album's pages.

public AlbumTransitionType transition_type { get; set; }

The type of animation used for transitions between modes and children.

public Widget visible_child { get; set; }

The widget currently visible when the album is folded.

public string visible_child_name { get; set; }

The name of the widget currently visible when the album is folded.

Creation methods:

public Album ()

Creates a new `BisAlbum`.

Methods:

public unowned AlbumPage append (Widget child)

Adds a child to this.

public unowned Widget? get_adjacent_child (NavigationDirection direction)

Finds the previous or next navigatable child.

public bool get_can_navigate_back ()

Gets whether gestures and shortcuts for navigating backward are enabled.

public bool get_can_navigate_forward ()

Gets whether gestures and shortcuts for navigating forward are enabled.

public bool get_can_unfold ()

Gets whether this can unfold.

public unowned Widget? get_child_by_name (string name)

Finds the child of this with


                  name

public SpringParams get_child_transition_params ()

Gets the child transition spring parameters for this.

public bool get_child_transition_running ()

Gets whether a child transition is currently running for this.

public FoldThresholdPolicy get_fold_threshold_policy ()

Gets the fold threshold policy for this .

public bool get_folded ()

Gets whether this is folded.

public bool get_homogeneous ()

Gets whether this is homogeneous.

public uint get_mode_transition_duration ()

Gets the mode transition animation duration for this.

public unowned AlbumPage get_page (Widget child)

Returns the [class@AlbumPage] object for child.

public SelectionModel get_pages ()

Returns a [iface@Gio.

public AlbumTransitionType get_transition_type ()

Gets the type of animation used for transitions between modes and children.

public unowned Widget? get_visible_child ()

Gets the widget currently visible when the album is folded.

public unowned string? get_visible_child_name ()

Gets the name of the currently visible child widget.

public unowned AlbumPage insert_child_after (Widget child, Widget? sibling)

Inserts child in the position after sibling in the list of children.

public bool navigate (NavigationDirection direction)

Navigates to the previous or next child.

public unowned AlbumPage prepend (Widget child)

Inserts child at the first position in this.

public void remove (Widget child)

Removes a child widget from this.

public void reorder_child_after (Widget child, Widget? sibling)

Moves child to the position after sibling in the list of children.

public void set_can_navigate_back (bool can_navigate_back)

Sets whether gestures and shortcuts for navigating backward are enabled.

public void set_can_navigate_forward (bool can_navigate_forward)

Sets whether gestures and shortcuts for navigating forward are enabled.

public void set_can_unfold (bool can_unfold)

Sets whether this can unfold.

public void set_child_transition_params (SpringParams @params)

Sets the child transition spring parameters for this.

public void set_fold_threshold_policy (FoldThresholdPolicy policy)

Sets the fold threshold policy for this .

public void set_homogeneous (bool homogeneous)

Sets this to be homogeneous or not.

public void set_mode_transition_duration (uint duration)

Sets the mode transition animation duration for this.

public void set_transition_type (AlbumTransitionType transition)

Sets the type of animation used for transitions between modes and children.

public void set_visible_child (Widget visible_child)

Sets the widget currently visible when the album is folded.

public void set_visible_child_name (string name)

Makes the child with the name name visible.

Inherited Members:

All known members inherited from interface Gtk.Orientable

get_orientation

orientation

set_orientation

Album