StOverflowBox

StOverflowBox — A vertical box which paints as many actors as it can fit

Synopsis

struct              StOverflowBox;
struct              StOverflowBoxClass;
gboolean            st_overflow_box_get_min_children    (StOverflowBox *box);
guint               st_overflow_box_get_n_children      (StOverflowBox *box);
guint               st_overflow_box_get_n_visible       (StOverflowBox *box);
void                st_overflow_box_set_min_children    (StOverflowBox *self,
                                                         guint min_children);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----StWidget
                     +----StContainer
                           +----StOverflowBox

Implemented Interfaces

StOverflowBox implements ClutterScriptable, ClutterAnimatable, AtkImplementorIface and ClutterContainer.

Properties

  "min-children"             guint                 : Read / Write

Description

This is a "flexible" box which will paint as many actors as it can within its given allocation; its minimum height request will be the sum of the mimimum size for the "min-children" property, which is by default 0.

Every child will be allocated the full width of the box, and always be given its preferred height. Even if not actually painted, every child is counted for overall preferred width/height.

Details

struct StOverflowBox

struct StOverflowBox;

The contents of this structure are private and should only be accessed through the public API.


struct StOverflowBoxClass

struct StOverflowBoxClass {
  StContainerClass parent_class;
};

st_overflow_box_get_min_children ()

gboolean            st_overflow_box_get_min_children    (StOverflowBox *box);

Get the value of the "pack-start" property.

box :

A StOverflowBox

Returns :

TRUE if pack-start is enabled

st_overflow_box_get_n_children ()

guint               st_overflow_box_get_n_children      (StOverflowBox *box);

box :

a StOverflowBox

Returns :

the number of children in this box.

st_overflow_box_get_n_visible ()

guint               st_overflow_box_get_n_visible       (StOverflowBox *box);

box :

a StOverflowBox

Returns :

the number of children we will paint. Only valid after the actor has been allocated.

st_overflow_box_set_min_children ()

void                st_overflow_box_set_min_children    (StOverflowBox *self,
                                                         guint min_children);

Property Details

The "min-children" property

  "min-children"             guint                 : Read / Write

The actor will request a minimum size large enough to include this many children.

Default value: 0