Struct gtk::FlowBox

#[repr(transparent)]
pub struct FlowBox { /* private fields */ }

A GtkFlowBox positions child widgets in sequence according to its orientation.

For instance, with the horizontal orientation, the widgets will be arranged from left to right, starting a new row under the previous row when necessary. Reducing the width in this case will require more rows, so a larger height will be requested.

Likewise, with the vertical orientation, the widgets will be arranged from top to bottom, starting a new column to the right when necessary. Reducing the height will require more columns, so a larger width will be requested.

The size request of a GtkFlowBox alone may not be what you expect; if you need to be able to shrink it along both axes and dynamically reflow its children, you may have to wrap it in a ScrolledWindow to enable that.

The children of a GtkFlowBox can be dynamically sorted and filtered.

Although a GtkFlowBox must have only FlowBoxChild children, you can add any kind of widget to it via ContainerExt::add(), and a GtkFlowBoxChild widget will automatically be inserted between the box and the widget.

Also see ListBox.

GtkFlowBox was added in GTK+ 3.12.

CSS nodes

⚠️ The following code is in plain ⚠️

flowbox
├── flowboxchild
│   ╰── <child>
├── flowboxchild
│   ╰── <child>
┊
╰── [rubberband]

GtkFlowBox uses a single CSS node with name flowbox. GtkFlowBoxChild uses a single CSS node with name flowboxchild. For rubberband selection, a subnode with name rubberband is used.

Implements

FlowBoxExt, ContainerExt, WidgetExt, glib::ObjectExt, BuildableExt, OrientableExt, FlowBoxExtManual, ContainerExtManual, WidgetExtManual, BuildableExtManual

Implementations

impl FlowBox

pub const NONE: Option<&'static FlowBox> = None

pub fn new() -> FlowBox

Creates a GtkFlowBox.

Returns

a new FlowBox container

pub fn builder() -> FlowBoxBuilder

Creates a new builder-pattern struct instance to construct FlowBox objects.

This method returns an instance of FlowBoxBuilder which can be used to create FlowBox objects.

Trait Implementations

impl Clone for FlowBox

fn clone(&self) -> Self

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FlowBox

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FlowBox

fn default() -> Self

Returns the “default value” for a type.

impl Display for FlowBox

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for FlowBox

fn hash<H>(&self, state: &mut H)where
    H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl Ord for FlowBox

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for FlowBox

type Parent = Container

impl<OT: ObjectType> PartialEq<OT> for FlowBox

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for FlowBox

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

const fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

const fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

const fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

const fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for FlowBox

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FlowBox

impl IsA<Buildable> for FlowBox

impl IsA<Container> for FlowBox

impl IsA<Orientable> for FlowBox

impl IsA<Widget> for FlowBox