MxBin

MxBin — a simple container with one actor

Synopsis

                    MxBin;
void                mx_bin_allocate_child               (MxBin *bin,
                                                         const ClutterActorBox *box,
                                                         ClutterAllocationFlags flags);
void                mx_bin_set_child                    (MxBin *bin,
                                                         ClutterActor *child);
ClutterActor *      mx_bin_get_child                    (MxBin *bin);
void                mx_bin_set_alignment                (MxBin *bin,
                                                         MxAlign x_align,
                                                         MxAlign y_align);
void                mx_bin_get_alignment                (MxBin *bin,
                                                         MxAlign *x_align,
                                                         MxAlign *y_align);
void                mx_bin_set_fill                     (MxBin *bin,
                                                         gboolean x_fill,
                                                         gboolean y_fill);
void                mx_bin_get_fill                     (MxBin *bin,
                                                         gboolean *x_fill,
                                                         gboolean *y_fill);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----MxWidget
                     +----MxBin
                           +----MxButton
                           +----MxFrame
                           +----MxScrollBar
                           +----MxScrollView
                           +----MxViewport
                           +----MxToolbar
                           +----MxExpander

Implemented Interfaces

MxBin implements ClutterScriptable, MxStylable, ClutterContainer and MxFocusable.

Properties

  "child"                    ClutterActor*         : Read / Write
  "x-align"                  MxAlign               : Read / Write
  "x-fill"                   gboolean              : Read / Write
  "y-align"                  MxAlign               : Read / Write
  "y-fill"                   gboolean              : Read / Write

Description

MxBin is a simple container capable of having only one ClutterActor as a child.

MxBin inherits from MxWidget, so it is fully themable.

Details

MxBin

typedef struct _MxBin MxBin;

The MxBin struct contains only private data

mx_bin_allocate_child ()

void                mx_bin_allocate_child               (MxBin *bin,
                                                         const ClutterActorBox *box,
                                                         ClutterAllocationFlags flags);

bin :

box :

flags :

mx_bin_set_child ()

void                mx_bin_set_child                    (MxBin *bin,
                                                         ClutterActor *child);

Sets child as the child of bin.

If bin already has a child, the previous child is removed.

bin :

 a MxBin

child :

 a ClutterActor, or NULL

mx_bin_get_child ()

ClutterActor *      mx_bin_get_child                    (MxBin *bin);

Retrieves a pointer to the child of bin.

bin :

 a MxBin

Returns :

 a ClutterActor, or NULL. transfer none.

mx_bin_set_alignment ()

void                mx_bin_set_alignment                (MxBin *bin,
                                                         MxAlign x_align,
                                                         MxAlign y_align);

Sets the horizontal and vertical alignment of the child inside a MxBin.

bin :

 a MxBin

x_align :

 horizontal alignment

y_align :

 vertical alignment

mx_bin_get_alignment ()

void                mx_bin_get_alignment                (MxBin *bin,
                                                         MxAlign *x_align,
                                                         MxAlign *y_align);

Retrieves the horizontal and vertical alignment of the child inside a MxBin, as set by mx_bin_set_alignment().

bin :

 a MxBin

x_align :

 return location for the horizontal alignment, or NULL

y_align :

 return location for the vertical alignment, or NULL

mx_bin_set_fill ()

void                mx_bin_set_fill                     (MxBin *bin,
                                                         gboolean x_fill,
                                                         gboolean y_fill);

Sets whether the child of bin should fill out the horizontal and/or vertical allocation of the parent

bin :

 a MxBin

x_fill :

 TRUE if the child should fill horizontally the bin

y_fill :

 TRUE if the child should fill vertically the bin

mx_bin_get_fill ()

void                mx_bin_get_fill                     (MxBin *bin,
                                                         gboolean *x_fill,
                                                         gboolean *y_fill);

Retrieves the horizontal and vertical fill settings

bin :

 a MxBin

x_fill :

 return location for the horizontal fill, or NULL. out.

y_fill :

 return location for the vertical fill, or NULL. out.

Property Details

The "child" property

  "child"                    ClutterActor*         : Read / Write

The child ClutterActor of the MxBin container.

The "x-align" property

  "x-align"                  MxAlign               : Read / Write

The horizontal alignment of the MxBin child.

Default value: MX_ALIGN_MIDDLE

The "x-fill" property

  "x-fill"                   gboolean              : Read / Write

Whether the child should fill the horizontal allocation

Default value: FALSE

The "y-align" property

  "y-align"                  MxAlign               : Read / Write

The vertical alignment of the MxBin child.

Default value: MX_ALIGN_MIDDLE

The "y-fill" property

  "y-fill"                   gboolean              : Read / Write

Whether the child should fill the vertical allocation

Default value: FALSE

Generated by GTK-Doc V1.14