GtkCellLayout
[Tree, List and Icon Grid Widgets]

Detailed Description

GtkCellLayout is an interface to be implemented by all objects which want to provide a GtkTreeViewColumn-like API for packing cells, setting attributes and data funcs.

One of the notable features provided by implementations of GtkCellLayout are attributes. Attributes let you set the properties in flexible ways. They can just be set to constant values like regular properties. But they can also be mapped to a column of the underlying tree model with gtk_cell_layout_set_attributes(), which means that the value of the attribute can change from cell to cell as they are rendered by the cell renderer. Finally, it is possible to specify a function with gtk_cell_layout_set_cell_data_func() that is called to determine the value of the attribute for each cell that is rendered.


Data Structures
struct	_GtkCellLayoutIface
	GtkCellLayout interface structure. More...
Functions
void	gtk_cell_layout_pack_start (GtkCellLayout cell_layout, GtkCellRenderer cell, gboolean expand)
	Packs the cell into the beginning of cell_layout.
void	gtk_cell_layout_pack_end (GtkCellLayout cell_layout, GtkCellRenderer cell, gboolean expand)
	Adds the cell to the end of cell_layout.
void	gtk_cell_layout_clear (GtkCellLayout *cell_layout)
	Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout.
void	gtk_cell_layout_set_attributes (GtkCellLayout cell_layout, GtkCellRenderer cell,...) G_GNUC_NULL_TERMINATED
	Sets the attributes in list as the attributes of cell_layout.
void	gtk_cell_layout_add_attribute (GtkCellLayout cell_layout, GtkCellRenderer cell, const gchar *attribute, gint column)
	Adds an attribute mapping to the list in cell_layout.
void	gtk_cell_layout_set_cell_data_func (GtkCellLayout cell_layout, GtkCellRenderer cell, GtkCellLayoutDataFunc func, gpointer func_data, GDestroyNotify destroy)
	Sets the GtkCellLayoutDataFunc to use for cell_layout.
void	gtk_cell_layout_clear_attributes (GtkCellLayout cell_layout, GtkCellRenderer cell)
	Clears all existing attributes previously set with gtk_cell_layout_set_attributes().
void	gtk_cell_layout_reorder (GtkCellLayout cell_layout, GtkCellRenderer cell, gint position)
	Re-inserts cell at position.
void	gtk_cell_layout_pack_next_line (GtkCellLayout cell_layout, GtkCellRenderer cell, gboolean expand)
	Pack a GtkCellRenderer in the next line of a GtkCellLayout.
void	gtk_cell_layout_pack_next_line_start (GtkCellLayout cell_layout, GtkCellRenderer cell, gboolean expand)
	Pack a GtkCellRenderer in the next line of a GtkCellLayout, to the start of the left room.

Function Documentation

void gtk_cell_layout_add_attribute	(	GtkCellLayout *	cell_layout,
		GtkCellRenderer *	cell,
		const gchar *	attribute,
		gint	column
	)

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.

Parameters:

	cell_layout	[in] A GtkCellLayout.
	cell	[in] A GtkCellRenderer.
	attribute	[in] An attribute on the renderer.
	column	[in] The column position on the model to get the attribute from.

Returns:: void

void gtk_cell_layout_clear ( GtkCellLayout * cell_layout )

Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout.

Parameters:

cell_layout

[in] A GtkCellLayout.

Returns:: void

void gtk_cell_layout_clear_attributes	(	GtkCellLayout *	cell_layout,
		GtkCellRenderer *	cell
	)

Clears all existing attributes previously set with gtk_cell_layout_set_attributes().

Parameters:

	cell_layout	[in] A GtkCellLayout.
	cell	[in] A GtkCellRenderer to clear the attribute mapping on.

Returns:: void

void gtk_cell_layout_pack_end	(	GtkCellLayout *	cell_layout,
		GtkCellRenderer *	cell,
		gboolean	expand
	)

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.

Parameters:

	cell_layout	[in] A GtkCellLayout.
	cell	[in] A GtkCellRenderer.
	expand	[in] TRUE if cell is to be given extra space allocated to cell_layout.

Returns:: void

void gtk_cell_layout_pack_next_line	(	GtkCellLayout *	cell_layout,
		GtkCellRenderer *	cell,
		gboolean	expand
	)

Pack a GtkCellRenderer in the next line of a GtkCellLayout.

This function is normally called by gtk_tree_view_column_pack_end().

Parameters:

	cell_layout	[in] A GtkCellLayout.
	cell	[in] A GtkCellRenderer.
	expand	[in] gboolean, If TRUE, cell is to be given extra space allocated to cell_layout.

Returns:: void

Since:: LIMO R1

void gtk_cell_layout_pack_next_line_start	(	GtkCellLayout *	cell_layout,
		GtkCellRenderer *	cell,
		gboolean	expand
	)

Pack a GtkCellRenderer in the next line of a GtkCellLayout, to the start of the left room.

Parameters:

	cell_layout	[in] A GtkCellLayout.
	cell	[in] A GtkCellRenderer.
	expand	[in] gboolean, If TRUE, the cell is to be given extra space allocated to cell_layout.

Returns:: void

Since:: LIMO R1

void gtk_cell_layout_pack_start	(	GtkCellLayout *	cell_layout,
		GtkCellRenderer *	cell,
		gboolean	expand
	)

Packs the cell into the beginning 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.

Parameters:

	cell_layout	[in] A GtkCellLayout.
	cell	[in] A GtkCellRenderer.
	expand	[in] TRUE if cell is to be given extra space allocated to cell_layout.

Returns:: void

void gtk_cell_layout_reorder	(	GtkCellLayout *	cell_layout,
		GtkCellRenderer *	cell,
		gint	position
	)

Re-inserts cell at position.

Note that cell has already to be packed into cell_layout for this to function properly.

Parameters:

	cell_layout	[in] A GtkCellLayout.
	cell	[in] A GtkCellRenderer to reorder.
	position	[in] New position to insert cell at.

Returns:: void

void gtk_cell_layout_set_attributes	(	GtkCellLayout *	cell_layout,
		GtkCellRenderer *	cell,
			...
	)

Sets the attributes in list as the attributes of cell_layout.

The attributes should be in attribute/column order, as in gtk_cell_layout_add_attribute(). All existing attributes are removed, and replaced with the new attributes.

Parameters:

	cell_layout	[in] A GtkCellLayout.
	cell	[in] A GtkCellRenderer.
	...	[in] A NULL-terminated list of attributes.

Returns:: void

void gtk_cell_layout_set_cell_data_func	(	GtkCellLayout *	cell_layout,
		GtkCellRenderer *	cell,
		GtkCellLayoutDataFunc	func,
		gpointer	func_data,
		GDestroyNotify	destroy
	)

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 and older one.

Parameters:

	cell_layout	[in] A GtkCellLayout.
	cell	[in] A GtkCellRenderer.
	func	[in] The GtkCellLayoutDataFunc to use.
	func_data	[in] The user data for func.
	destroy	[in] The destroy notification for func_data.

Returns:: void

Generated on Mon Mar 31 01:01:00 2008 by

1.5.4

LiMo Foundation

GtkCellLayout [Tree, List and Icon Grid Widgets]

Detailed Description

Data Structures

Functions

Function Documentation

GtkCellLayout
[Tree, List and Icon Grid Widgets]