ClutterBox

ClutterBox — Base class for layout containers

Synopsis




                    ClutterBox;
                    ClutterBoxClass;
void                clutter_box_set_spacing             (ClutterBox *box,
                                                         guint spacing);
guint               clutter_box_get_spacing             (ClutterBox *box);
enum                ClutterPackType;
void                clutter_box_pack_start              (ClutterBox *box,
                                                         ClutterActor *actor);
void                clutter_box_pack_end                (ClutterBox *box,
                                                         ClutterActor *actor);
                    ClutterBoxChild;
gboolean            clutter_box_query_child             (ClutterBox *box,
                                                         ClutterActor *actor,
                                                         ClutterBoxChild *child);
gboolean            clutter_box_query_nth_child         (ClutterBox *box,
                                                         gint index,
                                                         ClutterBoxChild *child);


Object Hierarchy


  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----ClutterBox
                     +----ClutterHBox
                     +----ClutterVBox

Implemented Interfaces

ClutterBox implements ClutterContainer.

Properties


  "spacing"                  guint                 : Read / Write

Description

FIXME

ClutterBox is available since Clutter 0.4

Details

ClutterBox

typedef struct _ClutterBox ClutterBox;


ClutterBoxClass

typedef struct {
  ClutterActorClass parent_class;

  /* vfuncs, not signals */
  void (* pack_child)   (ClutterBox      *box,
                         ClutterBoxChild *child);
  void (* unpack_child) (ClutterBox      *box,
                         ClutterBoxChild *child);

  /* padding, for future expansion */
  void (*_clutter_reserved1) (void);
  void (*_clutter_reserved2) (void);
  void (*_clutter_reserved3) (void);
  void (*_clutter_reserved4) (void);
  void (*_clutter_reserved5) (void);
  void (*_clutter_reserved6) (void);
  void (*_clutter_reserved7) (void);
  void (*_clutter_reserved8) (void);
} ClutterBoxClass;


clutter_box_set_spacing ()

void                clutter_box_set_spacing             (ClutterBox *box,
                                                         guint spacing);

Sets the spacing, in pixels, between the children of box.

box : a ClutterBox
spacing : the spacing between children

Since 0.4


clutter_box_get_spacing ()

guint               clutter_box_get_spacing             (ClutterBox *box);

Gets the value set using clutter_box_set_spacing().

box : a ClutterBox
Returns : the spacing between children of the box

Since 0.4


enum ClutterPackType

typedef enum {
  CLUTTER_PACK_START,
  CLUTTER_PACK_END
} ClutterPackType;

Pack order for a ClutterBox child.

CLUTTER_PACK_START: append child from the start CLUTTER_PACK_END: append child from the end

Since 0.4


clutter_box_pack_start ()

void                clutter_box_pack_start              (ClutterBox *box,
                                                         ClutterActor *actor);

Packs actor into box

box : a ClutterBox
actor : a ClutterActor

Since 0.4


clutter_box_pack_end ()

void                clutter_box_pack_end                (ClutterBox *box,
                                                         ClutterActor *actor);

Packs actor into box

box : a ClutterBox
actor : a ClutterActor

Since 0.4


ClutterBoxChild

typedef struct {
  ClutterActor *actor;

  ClutterPackType pack_type;
} ClutterBoxChild;

Packing data for children of a ClutterBox.

actor: the child ClutterActor pack_type: the type of packing used

Since 0.4


clutter_box_query_child ()

gboolean            clutter_box_query_child             (ClutterBox *box,
                                                         ClutterActor *actor,
                                                         ClutterBoxChild *child);

Queries box for the packing data of actor.

box : a ClutterBox
actor : child to query
child : return location for a ClutterBoxChild or NULL
Returns : TRUE if actor is a child of box

Since 0.4


clutter_box_query_nth_child ()

gboolean            clutter_box_query_nth_child         (ClutterBox *box,
                                                         gint index,
                                                         ClutterBoxChild *child);

Queries the child of box at index and puts the packing informations inside child.

box : a ClutterBox
index : position of the child
child : return value for a ClutterBoxChild, or NULL
Returns : TRUE if an actor was found at index

Since 0.4

Property Details

The "spacing" property

  "spacing"                  guint                 : Read / Write

Space between each child actor.

Default value: 0