MxTableChild

MxTableChild — The child property store for MxTable

Synopsis

                    MxTableChild;
gint                mx_table_child_get_column           (MxTable *table,
                                                         ClutterActor *child);
void                mx_table_child_set_column           (MxTable *table,
                                                         ClutterActor *child,
                                                         gint col);
gint                mx_table_child_get_row              (MxTable *table,
                                                         ClutterActor *child);
void                mx_table_child_set_row              (MxTable *table,
                                                         ClutterActor *child,
                                                         gint row);
gint                mx_table_child_get_column_span      (MxTable *table,
                                                         ClutterActor *child);
void                mx_table_child_set_column_span      (MxTable *table,
                                                         ClutterActor *child,
                                                         gint span);
gint                mx_table_child_get_row_span         (MxTable *table,
                                                         ClutterActor *child);
void                mx_table_child_set_row_span         (MxTable *table,
                                                         ClutterActor *child,
                                                         gint span);
gboolean            mx_table_child_get_x_fill           (MxTable *table,
                                                         ClutterActor *child);
void                mx_table_child_set_x_fill           (MxTable *table,
                                                         ClutterActor *child,
                                                         gboolean fill);
gboolean            mx_table_child_get_y_fill           (MxTable *table,
                                                         ClutterActor *child);
void                mx_table_child_set_y_fill           (MxTable *table,
                                                         ClutterActor *child,
                                                         gboolean fill);
gboolean            mx_table_child_get_x_expand         (MxTable *table,
                                                         ClutterActor *child);
void                mx_table_child_set_x_expand         (MxTable *table,
                                                         ClutterActor *child,
                                                         gboolean expand);
gboolean            mx_table_child_get_y_expand         (MxTable *table,
                                                         ClutterActor *child);
void                mx_table_child_set_y_expand         (MxTable *table,
                                                         ClutterActor *child,
                                                         gboolean expand);
MxAlign             mx_table_child_get_x_align          (MxTable *table,
                                                         ClutterActor *child);
void                mx_table_child_set_x_align          (MxTable *table,
                                                         ClutterActor *child,
                                                         MxAlign align);
MxAlign             mx_table_child_get_y_align          (MxTable *table,
                                                         ClutterActor *child);
void                mx_table_child_set_y_align          (MxTable *table,
                                                         ClutterActor *child,
                                                         MxAlign align);

Object Hierarchy

  GObject
   +----ClutterChildMeta
         +----MxTableChild

Properties

  "column"                   gint                  : Read / Write
  "column-span"              gint                  : Read / Write
  "row"                      gint                  : Read / Write
  "row-span"                 gint                  : Read / Write
  "x-align"                  MxAlign               : Read / Write
  "x-expand"                 gboolean              : Read / Write
  "x-fill"                   gboolean              : Read / Write
  "y-align"                  MxAlign               : Read / Write
  "y-expand"                 gboolean              : Read / Write
  "y-fill"                   gboolean              : Read / Write

Description

The ClutterChildMeta implementation for the MxTable container widget.

Details

MxTableChild

typedef struct _MxTableChild MxTableChild;

The contents of this structure is private and should only be accessed using the provided API.


mx_table_child_get_column ()

gint                mx_table_child_get_column           (MxTable *table,
                                                         ClutterActor *child);

Get the column of the child.

table :

an MxTable

child :

a ClutterActor

Returns :

the column of the child

mx_table_child_set_column ()

void                mx_table_child_set_column           (MxTable *table,
                                                         ClutterActor *child,
                                                         gint col);

Set the column of the child

table :

a MxTable

child :

a ClutterActor

col :

the column of the child

mx_table_child_get_row ()

gint                mx_table_child_get_row              (MxTable *table,
                                                         ClutterActor *child);

Get the row of the child.

table :

an MxTable

child :

a ClutterActor

Returns :

the row of the child

mx_table_child_set_row ()

void                mx_table_child_set_row              (MxTable *table,
                                                         ClutterActor *child,
                                                         gint row);

Set the row of the child

table :

a MxTable

child :

a ClutterActor

row :

the row of the child

mx_table_child_get_column_span ()

gint                mx_table_child_get_column_span      (MxTable *table,
                                                         ClutterActor *child);

Get the column span of the child. Defaults to 1.

table :

an MxTable

child :

a ClutterActor

Returns :

the column span of the child

mx_table_child_set_column_span ()

void                mx_table_child_set_column_span      (MxTable *table,
                                                         ClutterActor *child,
                                                         gint span);

Set the column span of the child.

table :

An MxTable

child :

An ClutterActor

span :

The number of columns to span

mx_table_child_get_row_span ()

gint                mx_table_child_get_row_span         (MxTable *table,
                                                         ClutterActor *child);

Get the row span of the child. Defaults to 1.

table :

A MxTable

child :

A ClutterActor

Returns :

the row span of the child

mx_table_child_set_row_span ()

void                mx_table_child_set_row_span         (MxTable *table,
                                                         ClutterActor *child,
                                                         gint span);

Set the row span of the child.

table :

A MxTable

child :

A ClutterActor

span :

the number of rows to span

mx_table_child_get_x_fill ()

gboolean            mx_table_child_get_x_fill           (MxTable *table,
                                                         ClutterActor *child);

Get the x-fill state of the child

table :

A MxTable

child :

A ClutterActor

Returns :

TRUE if the child is set to x-fill

mx_table_child_set_x_fill ()

void                mx_table_child_set_x_fill           (MxTable *table,
                                                         ClutterActor *child,
                                                         gboolean fill);

Set the fill state of the child on the x-axis. This will cause the child to be allocated the maximum available space.

table :

A MxTable

child :

A ClutterActor

fill :

the fill state

mx_table_child_get_y_fill ()

gboolean            mx_table_child_get_y_fill           (MxTable *table,
                                                         ClutterActor *child);

Get the y-fill state of the child

table :

A MxTable

child :

A ClutterActor

Returns :

TRUE if the child is set to y-fill

mx_table_child_set_y_fill ()

void                mx_table_child_set_y_fill           (MxTable *table,
                                                         ClutterActor *child,
                                                         gboolean fill);

Set the fill state of the child on the y-axis. This will cause the child to be allocated the maximum available space.

table :

A MxTable

child :

A ClutterActor

fill :

the fill state

mx_table_child_get_x_expand ()

gboolean            mx_table_child_get_x_expand         (MxTable *table,
                                                         ClutterActor *child);

Get the x-expand property of the child

table :

A MxTable

child :

A ClutterActor

Returns :

TRUE if the child is set to x-expand

mx_table_child_set_x_expand ()

void                mx_table_child_set_x_expand         (MxTable *table,
                                                         ClutterActor *child,
                                                         gboolean expand);

Set x-expand on the child. This causes the column which the child resides in to be allocated any extra space if the allocation of the table is larger than the preferred size.

table :

A MxTable

child :

A ClutterActor

expand :

the new value of the x expand child property

mx_table_child_get_y_expand ()

gboolean            mx_table_child_get_y_expand         (MxTable *table,
                                                         ClutterActor *child);

Get the y-expand property of the child.

table :

A MxTable

child :

A ClutterActor

Returns :

TRUE if the child is set to y-expand

mx_table_child_set_y_expand ()

void                mx_table_child_set_y_expand         (MxTable *table,
                                                         ClutterActor *child,
                                                         gboolean expand);

Set y-expand on the child. This causes the row which the child resides in to be allocated any extra space if the allocation of the table is larger than the preferred size.

table :

A MxTable

child :

A ClutterActor

expand :

the new value of the y-expand child property

mx_table_child_get_x_align ()

MxAlign             mx_table_child_get_x_align          (MxTable *table,
                                                         ClutterActor *child);

Get the x-align value of the child

table :

A MxTable

child :

A ClutterActor

Returns :

An MxAlign value

mx_table_child_set_x_align ()

void                mx_table_child_set_x_align          (MxTable *table,
                                                         ClutterActor *child,
                                                         MxAlign align);

Set the alignment of the child within its cell. This will only have an effect if the the x-fill property is FALSE.

table :

A MxTable

child :

A ClutterActor

align :

A MxAlign value

mx_table_child_get_y_align ()

MxAlign             mx_table_child_get_y_align          (MxTable *table,
                                                         ClutterActor *child);

Get the y-align value of the child

table :

A MxTable

child :

A ClutterActor

Returns :

An MxAlign value

mx_table_child_set_y_align ()

void                mx_table_child_set_y_align          (MxTable *table,
                                                         ClutterActor *child,
                                                         MxAlign align);

Set the value of the y-align property. This will only have an effect if y-fill value is set to FALSE.

table :

A MxTable

child :

A ClutterActor

align :

A MxAlign value

Property Details

The "column" property

  "column"                   gint                  : Read / Write

The column the widget resides in.

Allowed values: >= 0

Default value: 0


The "column-span" property

  "column-span"              gint                  : Read / Write

The number of columns the widget should span.

Allowed values: >= 1

Default value: 1


The "row" property

  "row"                      gint                  : Read / Write

The row the widget resides in.

Allowed values: >= 0

Default value: 0


The "row-span" property

  "row-span"                 gint                  : Read / Write

The number of rows the widget should span.

Allowed values: >= 1

Default value: 1


The "x-align" property

  "x-align"                  MxAlign               : Read / Write

X alignment of the widget within the cell.

Default value: MX_ALIGN_MIDDLE


The "x-expand" property

  "x-expand"                 gboolean              : Read / Write

Whether the child should receive priority when the container is allocating spare space on the horizontal axis.

Default value: TRUE


The "x-fill" property

  "x-fill"                   gboolean              : Read / Write

Whether the child should be allocated its entire available space, or whether it should be squashed and aligned.

Default value: TRUE


The "y-align" property

  "y-align"                  MxAlign               : Read / Write

Y alignment of the widget within the cell.

Default value: MX_ALIGN_MIDDLE


The "y-expand" property

  "y-expand"                 gboolean              : Read / Write

Whether the child should receive priority when the container is allocating spare space on the vertical axis.

Default value: TRUE


The "y-fill" property

  "y-fill"                   gboolean              : Read / Write

Whether the child should be allocated its entire available space, or whether it should be squashed and aligned.

Default value: TRUE