/**
* gtk_cell_layout_get_cells:
* @cell_layout: a #GtkCellLayout
*
* Returns the cell renderers which have been added to @cell_layout.
*
* Returns: (element-type GtkCellRenderer) (transfer container):
* a list of cell renderers. The list, but not the renderers has
* been newly allocated and should be freed with g_list_free()
* when no longer needed.
*/
GList *
gtk_cell_layout_get_cells (GtkCellLayout *cell_layout)
{
g_return_val_if_fail (GTK_IS_CELL_LAYOUT (cell_layout), NULL);
return GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->get_cells (cell_layout);
}
/**
* gtk_cell_layout_clear:
* @cell_layout: a #GtkCellLayout
*
* Unsets all the mappings on all renderers on @cell_layout and
* removes all renderers from @cell_layout.
*/
void
gtk_cell_layout_clear (GtkCellLayout *cell_layout)
{
g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));
GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->clear (cell_layout);
}
/**
* gtk_cell_layout_clear_attributes:
* @cell_layout: a #GtkCellLayout
* @cell: a #GtkCellRenderer to clear the attribute mapping on
*
* Clears all existing attributes previously set with
* gtk_cell_layout_set_attributes().
*/
void
gtk_cell_layout_clear_attributes (GtkCellLayout *cell_layout,
GtkCellRenderer *cell)
{
g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));
g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->clear_attributes (cell_layout, cell);
}
/**
* gtk_cell_layout_reorder:
* @cell_layout: a #GtkCellLayout
* @cell: a #GtkCellRenderer to reorder
* @position: new position to insert @cell at
*
* Re-inserts @cell at @position.
*
* Note that @cell has already to be packed into @cell_layout
* for this to function properly.
*/
void
gtk_cell_layout_reorder (GtkCellLayout *cell_layout,
GtkCellRenderer *cell,
gint position)
{
g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));
g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->reorder (cell_layout, cell, position);
}
/**
* gtk_cell_layout_pack_end:
* @cell_layout: a #GtkCellLayout
* @cell: a #GtkCellRenderer
* @expand: %TRUE if @cell is to be given extra space allocated to @cell_layout
*
* Adds the @cell to the end of @cell_layout. If @expand is %FALSE, then the
* @cell is allocated no more space than it needs. Any unused space is
* divided evenly between cells for which @expand is %TRUE.
*
* Note that reusing the same cell renderer is not supported.
*/
void
gtk_cell_layout_pack_end (GtkCellLayout *cell_layout,
GtkCellRenderer *cell,
gboolean expand)
{
g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));
g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->pack_end (cell_layout, cell, expand);
}
/**
* gtk_cell_layout_get_area:
* @cell_layout: a #GtkCellLayout
*
* Returns the underlying #GtkCellArea which might be @cell_layout
* if called on a #GtkCellArea or might be %NULL if no #GtkCellArea
* is used by @cell_layout.
*
* Returns: (transfer none) (nullable): the cell area used by @cell_layout,
* or %NULL in case no cell area is used.
*/
GtkCellArea *
gtk_cell_layout_get_area (GtkCellLayout *cell_layout)
{
GtkCellLayoutIface *iface;
g_return_val_if_fail (GTK_IS_CELL_LAYOUT (cell_layout), NULL);
iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);
if (iface->get_area)
return iface->get_area (cell_layout);
return NULL;
}
/**
* gtk_cell_layout_set_cell_data_func:
* @cell_layout: a #GtkCellLayout
* @cell: a #GtkCellRenderer
* @func: (allow-none): the #GtkCellLayoutDataFunc to use, or %NULL
* @func_data: (closure): user data for @func
* @destroy: destroy notify for @func_data
*
* Sets the #GtkCellLayoutDataFunc to use for @cell_layout.
*
* This function is used instead of the standard attributes mapping
* for setting the column value, and should set the value of @cell_layout’s
* cell renderer(s) as appropriate.
*
* @func may be %NULL to remove a previously set function.
*/
void
gtk_cell_layout_set_cell_data_func (GtkCellLayout *cell_layout,
GtkCellRenderer *cell,
GtkCellLayoutDataFunc func,
gpointer func_data,
GDestroyNotify destroy)
{
g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));
g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
GTK_CELL_LAYOUT_GET_IFACE
(cell_layout)->set_cell_data_func (cell_layout, cell, func, func_data, destroy);
}
/**
* gtk_cell_layout_add_attribute:
* @cell_layout: a #GtkCellLayout
* @cell: a #GtkCellRenderer
* @attribute: an attribute on the renderer
* @column: the column position on the model to get the attribute from
*
* Adds an attribute mapping to the list in @cell_layout.
*
* The @column is the column of the model to get a value from, and the
* @attribute is the parameter on @cell to be set from the value. So for
* example if column 2 of the model contains strings, you could have the
* “text” attribute of a #GtkCellRendererText get its values from column 2.
*/
void
gtk_cell_layout_add_attribute (GtkCellLayout *cell_layout,
GtkCellRenderer *cell,
const gchar *attribute,
gint column)
{
g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));
g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
g_return_if_fail (attribute != NULL);
g_return_if_fail (column >= 0);
GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->add_attribute (cell_layout, cell, attribute, column);
}
static void
gtk_cell_layout_default_clear (GtkCellLayout *cell_layout)
{
GtkCellLayoutIface *iface;
GtkCellArea *area;
iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);
if (iface->get_area)
{
area = iface->get_area (cell_layout);
if (area)
gtk_cell_layout_clear (GTK_CELL_LAYOUT (area));
else
warn_no_cell_area ("GtkCellLayoutIface->clear()");
}
}
static GList *
gtk_cell_layout_default_get_cells (GtkCellLayout *cell_layout)
{
GtkCellLayoutIface *iface;
GtkCellArea *area;
iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);
if (iface->get_area)
{
area = iface->get_area (cell_layout);
if (area)
return gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (area));
else
warn_no_cell_area ("GtkCellLayoutIface->get_cells()");
}
return NULL;
}
static void
gtk_cell_layout_default_reorder (GtkCellLayout *cell_layout,
GtkCellRenderer *cell,
gint position)
{
GtkCellLayoutIface *iface;
GtkCellArea *area;
iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);
if (iface->get_area)
{
area = iface->get_area (cell_layout);
if (area)
gtk_cell_layout_reorder (GTK_CELL_LAYOUT (area), cell, position);
else
warn_no_cell_area ("GtkCellLayoutIface->reorder()");
}
}
static void
gtk_cell_layout_default_pack_end (GtkCellLayout *cell_layout,
GtkCellRenderer *cell,
gboolean expand)
{
GtkCellLayoutIface *iface;
GtkCellArea *area;
iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);
if (iface->get_area)
{
area = iface->get_area (cell_layout);
if (area)
gtk_cell_layout_pack_end (GTK_CELL_LAYOUT (area), cell, expand);
else
warn_no_cell_area ("GtkCellLayoutIface->pack_end()");
}
}
static void
gtk_cell_layout_default_add_attribute (GtkCellLayout *cell_layout,
GtkCellRenderer *cell,
const gchar *attribute,
gint column)
{
GtkCellLayoutIface *iface;
GtkCellArea *area;
iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);
if (iface->get_area)
{
area = iface->get_area (cell_layout);
if (area)
gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (area), cell, attribute, column);
else
warn_no_cell_area ("GtkCellLayoutIface->add_attribute()");
}
}
static void
gtk_cell_layout_set_attributesv (GtkCellLayout *cell_layout,
GtkCellRenderer *cell,
va_list args)
{
gchar *attribute;
gint column;
GtkCellLayoutIface *iface;
attribute = va_arg (args, gchar *);
iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);
(* iface->clear_attributes) (cell_layout, cell);
while (attribute != NULL)
{
column = va_arg (args, gint);
(* iface->add_attribute) (cell_layout, cell, attribute, column);
attribute = va_arg (args, gchar *);
}
}
static void
gtk_cell_layout_default_set_cell_data_func (GtkCellLayout *cell_layout,
GtkCellRenderer *cell,
GtkCellLayoutDataFunc func,
gpointer func_data,
GDestroyNotify destroy)
{
GtkCellLayoutIface *iface;
GtkCellArea *area;
iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);
if (iface->get_area)
{
area = iface->get_area (cell_layout);
if (area)
_gtk_cell_area_set_cell_data_func_with_proxy (area, cell,
(GFunc)func, func_data, destroy,
cell_layout);
else
warn_no_cell_area ("GtkCellLayoutIface->set_cell_data_func()");
}
}
