NbtkTableChild

NbtkTableChild — The child property store for NbtkTable

Synopsis

                    NbtkTableChild;
gint                nbtk_table_child_get_col_span       (NbtkTable *table,
                                                         ClutterActor *child);
void                nbtk_table_child_set_col_span       (NbtkTable *table,
                                                         ClutterActor *child,
                                                         gint span);
gint                nbtk_table_child_get_row_span       (NbtkTable *table,
                                                         ClutterActor *child);
void                nbtk_table_child_set_row_span       (NbtkTable *table,
                                                         ClutterActor *child,
                                                         gint span);
gboolean            nbtk_table_child_get_x_fill         (NbtkTable *table,
                                                         ClutterActor *child);
void                nbtk_table_child_set_x_fill         (NbtkTable *table,
                                                         ClutterActor *child,
                                                         gboolean fill);
gboolean            nbtk_table_child_get_y_fill         (NbtkTable *table,
                                                         ClutterActor *child);
void                nbtk_table_child_set_y_fill         (NbtkTable *table,
                                                         ClutterActor *child,
                                                         gboolean fill);
gboolean            nbtk_table_child_get_x_expand       (NbtkTable *table,
                                                         ClutterActor *child);
void                nbtk_table_child_set_x_expand       (NbtkTable *table,
                                                         ClutterActor *child,
                                                         gboolean expand);
gboolean            nbtk_table_child_get_y_expand       (NbtkTable *table,
                                                         ClutterActor *child);
void                nbtk_table_child_set_y_expand       (NbtkTable *table,
                                                         ClutterActor *child,
                                                         gboolean expand);
NbtkAlign           nbtk_table_child_get_x_align        (NbtkTable *table,
                                                         ClutterActor *child);
void                nbtk_table_child_set_x_align        (NbtkTable *table,
                                                         ClutterActor *child,
                                                         NbtkAlign align);
NbtkAlign           nbtk_table_child_get_y_align        (NbtkTable *table,
                                                         ClutterActor *child);
void                nbtk_table_child_set_y_align        (NbtkTable *table,
                                                         ClutterActor *child,
                                                         NbtkAlign align);
void                nbtk_table_child_set_allocate_hidden
                                                        (NbtkTable *table,
                                                         ClutterActor *child,
                                                         gboolean value);
gboolean            nbtk_table_child_get_allocate_hidden
                                                        (NbtkTable *table,
                                                         ClutterActor *child);

Object Hierarchy

  GObject
   +----ClutterChildMeta
         +----NbtkTableChild

Properties

  "allocate-hidden"          gboolean              : Read / Write
  "col"                      gint                  : Read / Write
  "col-span"                 gint                  : Read / Write
  "row"                      gint                  : Read / Write
  "row-span"                 gint                  : Read / Write
  "x-align"                  gdouble               : Read / Write
  "x-expand"                 gboolean              : Read / Write
  "x-fill"                   gboolean              : Read / Write
  "y-align"                  gdouble               : Read / Write
  "y-expand"                 gboolean              : Read / Write
  "y-fill"                   gboolean              : Read / Write

Description

The ClutterChildMeta implementation for the NbtkTable container widget.

Details

NbtkTableChild

typedef struct _NbtkTableChild NbtkTableChild;

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


nbtk_table_child_get_col_span ()

gint                nbtk_table_child_get_col_span       (NbtkTable *table,
                                                         ClutterActor *child);

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

table :

an NbtkTable

child :

a ClutterActor

Returns :

the column span of the child

nbtk_table_child_set_col_span ()

void                nbtk_table_child_set_col_span       (NbtkTable *table,
                                                         ClutterActor *child,
                                                         gint span);

Set the column span of the child.

table :

An NbtkTable

child :

An ClutterActor

span :

The number of columns to span

nbtk_table_child_get_row_span ()

gint                nbtk_table_child_get_row_span       (NbtkTable *table,
                                                         ClutterActor *child);

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

table :

A NbtkTable

child :

A ClutterActor

Returns :

the row span of the child

nbtk_table_child_set_row_span ()

void                nbtk_table_child_set_row_span       (NbtkTable *table,
                                                         ClutterActor *child,
                                                         gint span);

Set the row span of the child.

table :

A NbtkTable

child :

A ClutterActor

span :

the number of rows to span

nbtk_table_child_get_x_fill ()

gboolean            nbtk_table_child_get_x_fill         (NbtkTable *table,
                                                         ClutterActor *child);

Get the x-fill state of the child

table :

A NbtkTable

child :

A ClutterActor

Returns :

TRUE if the child is set to x-fill

nbtk_table_child_set_x_fill ()

void                nbtk_table_child_set_x_fill         (NbtkTable *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 NbtkTable

child :

A ClutterActor

fill :

the fill state

nbtk_table_child_get_y_fill ()

gboolean            nbtk_table_child_get_y_fill         (NbtkTable *table,
                                                         ClutterActor *child);

Get the y-fill state of the child

table :

A NbtkTable

child :

A ClutterActor

Returns :

TRUE if the child is set to y-fill

nbtk_table_child_set_y_fill ()

void                nbtk_table_child_set_y_fill         (NbtkTable *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 NbtkTable

child :

A ClutterActor

fill :

the fill state

nbtk_table_child_get_x_expand ()

gboolean            nbtk_table_child_get_x_expand       (NbtkTable *table,
                                                         ClutterActor *child);

Get the x-expand property of the child

table :

A NbtkTable

child :

A ClutterActor

Returns :

TRUE if the child is set to x-expand

nbtk_table_child_set_x_expand ()

void                nbtk_table_child_set_x_expand       (NbtkTable *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 NbtkTable

child :

A ClutterActor

expand :

the new value of the x expand child property

nbtk_table_child_get_y_expand ()

gboolean            nbtk_table_child_get_y_expand       (NbtkTable *table,
                                                         ClutterActor *child);

Get the y-expand property of the child.

table :

A NbtkTable

child :

A ClutterActor

Returns :

TRUE if the child is set to y-expand

nbtk_table_child_set_y_expand ()

void                nbtk_table_child_set_y_expand       (NbtkTable *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 NbtkTable

child :

A ClutterActor

expand :

the new value of the y-expand child property

nbtk_table_child_get_x_align ()

NbtkAlign           nbtk_table_child_get_x_align        (NbtkTable *table,
                                                         ClutterActor *child);

Get the x-align value of the child

table :

A NbtkTable

child :

A ClutterActor

Returns :

An NbtkAlign value

nbtk_table_child_set_x_align ()

void                nbtk_table_child_set_x_align        (NbtkTable *table,
                                                         ClutterActor *child,
                                                         NbtkAlign 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 NbtkTable

child :

A ClutterActor

align :

A NbtkAlign value

nbtk_table_child_get_y_align ()

NbtkAlign           nbtk_table_child_get_y_align        (NbtkTable *table,
                                                         ClutterActor *child);

Get the y-align value of the child

table :

A NbtkTable

child :

A ClutterActor

Returns :

An NbtkAlign value

nbtk_table_child_set_y_align ()

void                nbtk_table_child_set_y_align        (NbtkTable *table,
                                                         ClutterActor *child,
                                                         NbtkAlign 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 NbtkTable

child :

A ClutterActor

align :

A NbtkAlign value

nbtk_table_child_set_allocate_hidden ()

void                nbtk_table_child_set_allocate_hidden
                                                        (NbtkTable *table,
                                                         ClutterActor *child,
                                                         gboolean value);

Set whether the child should be allocate even if it is hidden

table :

A NbtkTable

child :

A ClutterActor

value :

TRUE if the actor should be allocated when hidden

nbtk_table_child_get_allocate_hidden ()

gboolean            nbtk_table_child_get_allocate_hidden
                                                        (NbtkTable *table,
                                                         ClutterActor *child);

Determine if the child is allocated even if it is hidden

table :

A NbtkTable

child :

A ClutterActor

Returns :

TRUE if the actor is allocated when hidden

Property Details

The "allocate-hidden" property

  "allocate-hidden"          gboolean              : Read / Write

Whether the child should be allocate even if it is hidden.

Default value: TRUE


The "col" property

  "col"                      gint                  : Read / Write

The column the widget resides in.

Allowed values: >= 0

Default value: 0


The "col-span" property

  "col-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"                  gdouble               : Read / Write

X alignment of the widget within the cell.

Allowed values: [0,1]

Default value: 0.5


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"                  gdouble               : Read / Write

Y alignment of the widget within the cell.

Allowed values: [0,1]

Default value: 0.5


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