CtkCellAreaBox

CtkCellAreaBox — A cell area that renders CtkCellRenderers into a row or a column

Functions

CtkCellArea * ctk_cell_area_box_new ()
void ctk_cell_area_box_pack_start ()
void ctk_cell_area_box_pack_end ()
gint ctk_cell_area_box_get_spacing ()
void ctk_cell_area_box_set_spacing ()

Properties

int spacing Read / Write

Types and Values

struct CtkCellAreaBox
struct CtkCellAreaBoxClass

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── CtkCellArea
            ╰── CtkCellAreaBox

Implemented Interfaces

CtkCellAreaBox implements CtkCellLayout, CtkBuildable and CtkOrientable.

Includes

#include <ctk/ctk.h>

Description

The CtkCellAreaBox renders cell renderers into a row or a column depending on its CtkOrientation.

CtkCellAreaBox uses a notion of packing. Packing refers to adding cell renderers with reference to a particular position in a CtkCellAreaBox. There are two reference positions: the start and the end of the box. When the CtkCellAreaBox is oriented in the CTK_ORIENTATION_VERTICAL orientation, the start is defined as the top of the box and the end is defined as the bottom. In the CTK_ORIENTATION_HORIZONTAL orientation start is defined as the left side and the end is defined as the right side.

Alignments of CtkCellRenderers rendered in adjacent rows can be configured by configuring the CtkCellAreaBox align child cell property with ctk_cell_area_cell_set_property() or by specifying the "align" argument to ctk_cell_area_box_pack_start() and ctk_cell_area_box_pack_end().

Functions

ctk_cell_area_box_new ()

CtkCellArea *
ctk_cell_area_box_new (void);

Creates a new CtkCellAreaBox.

Returns

a newly created CtkCellAreaBox

Since: 3.0

ctk_cell_area_box_pack_start ()

void
ctk_cell_area_box_pack_start (CtkCellAreaBox *box,
                              CtkCellRenderer *renderer,
                              gboolean expand,
                              gboolean align,
                              gboolean fixed);

Adds renderer to box , packed with reference to the start of box .

The renderer is packed after any other CtkCellRenderer packed with reference to the start of box .

Parameters

box

a CtkCellAreaBox

  

renderer

the CtkCellRenderer to add

  

expand

whether renderer should receive extra space when the area receives more than its natural size

  

align

whether renderer should be aligned in adjacent rows

  

fixed

whether renderer should have the same size in all rows

  

Since: 3.0

ctk_cell_area_box_pack_end ()

void
ctk_cell_area_box_pack_end (CtkCellAreaBox *box,
                            CtkCellRenderer *renderer,
                            gboolean expand,
                            gboolean align,
                            gboolean fixed);

Adds renderer to box , packed with reference to the end of box .

The renderer is packed after (away from end of) any other CtkCellRenderer packed with reference to the end of box .

Parameters

box

a CtkCellAreaBox

  

renderer

the CtkCellRenderer to add

  

expand

whether renderer should receive extra space when the area receives more than its natural size

  

align

whether renderer should be aligned in adjacent rows

  

fixed

whether renderer should have the same size in all rows

  

Since: 3.0

ctk_cell_area_box_get_spacing ()

gint
ctk_cell_area_box_get_spacing (CtkCellAreaBox *box);

Gets the spacing added between cell renderers.

Parameters

box

a CtkCellAreaBox

  

Returns

the space added between cell renderers in box .

Since: 3.0

ctk_cell_area_box_set_spacing ()

void
ctk_cell_area_box_set_spacing (CtkCellAreaBox *box,
                               gint spacing);

Sets the spacing to add between cell renderers in box .

Parameters

box

a CtkCellAreaBox

  

spacing

the space to add between CtkCellRenderers

  

Since: 3.0

Types and Values

struct CtkCellAreaBox

struct CtkCellAreaBox;

struct CtkCellAreaBoxClass

struct CtkCellAreaBoxClass {
};

Property Details

The “spacing” property

  “spacing”                  int

The amount of space to reserve between cells.

Owner: CtkCellAreaBox

Flags: Read / Write

Allowed values: >= 0

Default value: 0

Since: 3.0

Generated by GTK-Doc V1.36.1