gtk2/docs/reference/gtk/tmpl/gtkcelllayout.sgml
Matthias Clasen 39ed8a9a9f Add an explanation of attributes. (#349367, Don Anderson)
2006-08-06  Matthias Clasen  <mclasen@redhat.com>

	* gtk/tmpl/gtkcelllayout.sgml: Add an explanation
	of attributes.  (#349367, Don Anderson)
2006-08-06 05:01:17 +00:00

147 lines
2.6 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GtkCellLayout
<!-- ##### SECTION Short_Description ##### -->
An interface for packing cells
<!-- ##### SECTION Long_Description ##### -->
<para>
#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.
</para>
<para>
One of the notable features provided by implementations of GtkCellLayout
are <emphasis>attributes</emphasis>. 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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GtkCellLayout ##### -->
<para>
</para>
<!-- ##### STRUCT GtkCellLayoutIface ##### -->
<para>
</para>
@g_iface:
@pack_start:
@pack_end:
@clear:
@add_attribute:
@set_cell_data_func:
@clear_attributes:
@reorder:
<!-- ##### USER_FUNCTION GtkCellLayoutDataFunc ##### -->
<para>
A function which should set the value of @cell_layout's cell renderer(s)
as appropriate.
</para>
@cell_layout: a #GtkCellLayout
@cell: the cell renderer whose value is to be set
@tree_model: the model
@iter: a #GtkTreeIter indicating the row to set the value for
@data: user data passed to gtk_cell_layout_set_cell_data_func()
<!-- ##### FUNCTION gtk_cell_layout_pack_start ##### -->
<para>
</para>
@cell_layout:
@cell:
@expand:
<!-- ##### FUNCTION gtk_cell_layout_pack_end ##### -->
<para>
</para>
@cell_layout:
@cell:
@expand:
<!-- ##### FUNCTION gtk_cell_layout_reorder ##### -->
<para>
</para>
@cell_layout:
@cell:
@position:
<!-- ##### FUNCTION gtk_cell_layout_clear ##### -->
<para>
</para>
@cell_layout:
<!-- ##### FUNCTION gtk_cell_layout_set_attributes ##### -->
<para>
</para>
@cell_layout:
@cell:
@Varargs:
<!-- ##### FUNCTION gtk_cell_layout_add_attribute ##### -->
<para>
</para>
@cell_layout:
@cell:
@attribute:
@column:
<!-- ##### FUNCTION gtk_cell_layout_set_cell_data_func ##### -->
<para>
</para>
@cell_layout:
@cell:
@func:
@func_data:
@destroy:
<!-- ##### FUNCTION gtk_cell_layout_clear_attributes ##### -->
<para>
</para>
@cell_layout:
@cell: