Add support for EWMH "Above" and "Below" window states. (105100, Manuel Clos)

[~andy/gtk] / docs / reference / gtk / tmpl / gtktreeviewcolumn.sgml

diff --git a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml
index ff4911e87f150a0987777e6313eee6895da9730f..a65dc1b1a3f5ea59b109d0d3bf9730406bdf41b0 100644 (file)
--- a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml
+++ b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml
@@ -2,23 +2,46 @@
 GtkTreeViewColumn
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A visible column in a #GtkTreeView widget
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+The GtkTreeViewColumn object is a visible column in a #GtkTreeView
+widget.  It determines the geometry, type 
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
+#GtkTreeView, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable, #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
 
 </para>
 
-<!-- ##### MACRO GTK_TYPE_TREE_COLUMN ##### -->
+<!-- ##### ENUM GtkTreeViewColumnSizing ##### -->
 <para>
+The sizing method the column uses to determine its width.  Please note
+that @GTK_TREE_VIEW_COLUMN_AUTOSIZE are inefficient for large views, and
+can make columns appear choppy.
+</para>
+
+@GTK_TREE_VIEW_COLUMN_GROW_ONLY: Columns only get bigger in reaction to changes in the model
+@GTK_TREE_VIEW_COLUMN_AUTOSIZE: Columns resize to be the optimal size everytime the model changes.
+@GTK_TREE_VIEW_COLUMN_FIXED: Columns are a fixed numbers of pixels wide.
 
+<!-- ##### USER_FUNCTION GtkTreeCellDataFunc ##### -->
+<para>
+A function to set the properties of a cell instead of just using the
+straight mapping between the cell and the model.  This is useful for
+customizing the cell renderer.  For example, a function might get an
+integer from the @tree_model, and render it to the "text" attribute of
+"cell" by converting it to its written equivilent.  This is set by
+calling gtk_tree_view_column_set_cell_data_func()
 </para>
 
+@tree_column: A #GtkTreeColumn
+@cell: The #GtkCellRenderer that is being rendered by @tree_column
+@tree_model: The #GtkTreeModel being rendered
+@iter: A #GtkTreeIter of the current row rendered
+@data: user data
 
 
 <!-- ##### STRUCT GtkTreeViewColumn ##### -->
@@ -26,73 +49,61 @@ GtkTreeViewColumn
 
 </para>
 
-@parent: 
-@tree_view: 
-@button: 
-@child: 
-@window: 
-@justification: 
-@id: 
-@width: 
-@min_width: 
-@max_width: 
-@func: 
-@func_data: 
-@title: 
-@cell: 
-@attributes: 
-@column_type: 
-@visible: 
-@button_active: 
-@dirty: 
 
-<!-- ##### ENUM GtkTreeViewColumnSizing ##### -->
+<!-- ##### FUNCTION gtk_tree_view_column_new ##### -->
 <para>
 
 </para>
 
-@GTK_TREE_VIEW_COLUMN_RESIZEABLE: 
-@GTK_TREE_VIEW_COLUMN_AUTOSIZE: 
-@GTK_TREE_VIEW_COLUMN_FIXED: 
+@Returns: 
+
 
-<!-- ##### USER_FUNCTION GtkTreeViewColumnFunc ##### -->
+<!-- ##### FUNCTION gtk_tree_view_column_new_with_attributes ##### -->
 <para>
 
 </para>
 
-@tree_column: 
-@tree_model: 
-@iter: 
-@data: 
+@title: 
+@cell: 
+@Varargs: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_tree_view_column_new ##### -->
+<!-- ##### FUNCTION gtk_tree_view_column_pack_start ##### -->
 <para>
 
 </para>
 
-@Returns: 
+@tree_column: 
+@cell: 
+@expand: 
 
 
-<!-- ##### FUNCTION gtk_tree_view_column_new_with_attributes ##### -->
+<!-- ##### FUNCTION gtk_tree_view_column_pack_end ##### -->
 <para>
 
 </para>
 
-@title: 
+@tree_column: 
 @cell: 
-@Varargs: 
-@Returns: 
+@expand: 
 
 
-<!-- ##### FUNCTION gtk_tree_view_column_set_cell_renderer ##### -->
+<!-- ##### FUNCTION gtk_tree_view_column_clear ##### -->
 <para>
 
 </para>
 
 @tree_column: 
-@cell: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_get_cell_renderers ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gtk_tree_view_column_add_attribute ##### -->
@@ -101,6 +112,7 @@ GtkTreeViewColumn
 </para>
 
 @tree_column: 
+@cell_renderer: 
 @attribute: 
 @column: 
 
@@ -111,17 +123,47 @@ GtkTreeViewColumn
 </para>
 
 @tree_column: 
+@cell_renderer: 
 @Varargs: 
 
 
-<!-- ##### FUNCTION gtk_tree_view_column_set_cell_data ##### -->
+<!-- ##### FUNCTION gtk_tree_view_column_set_cell_data_func ##### -->
 <para>
 
 </para>
 
 @tree_column: 
-@tree_model: 
-@iter: 
+@cell_renderer: 
+@func: 
+@func_data: 
+@destroy: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_clear_attributes ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@cell_renderer: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_set_spacing ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@spacing: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_get_spacing ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gtk_tree_view_column_set_visible ##### -->
@@ -142,6 +184,24 @@ GtkTreeViewColumn
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_tree_view_column_set_resizable ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@resizable: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_get_resizable ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_tree_view_column_set_sizing ##### -->
 <para>
 
@@ -151,13 +211,40 @@ GtkTreeViewColumn
 @type: 
 
 
-<!-- ##### FUNCTION gtk_tree_view_column_set_width ##### -->
+<!-- ##### FUNCTION gtk_tree_view_column_get_sizing ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_get_width ##### -->
 <para>
 
 </para>
 
 @tree_column: 
-@size: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_get_fixed_width ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_set_fixed_width ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@fixed_width: 
 
 
 <!-- ##### FUNCTION gtk_tree_view_column_set_min_width ##### -->
@@ -196,6 +283,14 @@ GtkTreeViewColumn
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_tree_view_column_clicked ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+
+
 <!-- ##### FUNCTION gtk_tree_view_column_set_title ##### -->
 <para>
 
@@ -214,6 +309,44 @@ GtkTreeViewColumn
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_tree_view_column_set_expand ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@expand: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_get_expand ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_set_clickable ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@clickable: 
+<!-- # Unused Parameters # -->
+@active: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_get_clickable ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_tree_view_column_set_widget ##### -->
 <para>
 
@@ -232,16 +365,16 @@ GtkTreeViewColumn
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_tree_view_column_set_justification ##### -->
+<!-- ##### FUNCTION gtk_tree_view_column_set_alignment ##### -->
 <para>
 
 </para>
 
 @tree_column: 
-@justification: 
+@xalign: 
 
 
-<!-- ##### FUNCTION gtk_tree_view_column_get_justification ##### -->
+<!-- ##### FUNCTION gtk_tree_view_column_get_alignment ##### -->
 <para>
 
 </para>
@@ -250,11 +383,212 @@ GtkTreeViewColumn
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_tree_view_column_clicked ##### -->
+<!-- ##### FUNCTION gtk_tree_view_column_set_reorderable ##### -->
 <para>
 
 </para>
 
 @tree_column: 
+@reorderable: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_get_reorderable ##### -->
+<para>
 
+</para>
+
+@tree_column: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_set_sort_column_id ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@sort_column_id: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_get_sort_column_id ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_set_sort_indicator ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@setting: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_get_sort_indicator ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_set_sort_order ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@order: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_get_sort_order ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_cell_set_cell_data ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@tree_model: 
+@iter: 
+@is_expander: 
+@is_expanded: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_cell_get_size ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@cell_area: 
+@x_offset: 
+@y_offset: 
+@width: 
+@height: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_cell_get_position ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@cell_renderer: 
+@start_pos: 
+@width: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_cell_is_visible ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_tree_view_column_focus_cell ##### -->
+<para>
+
+</para>
+
+@tree_column: 
+@cell: 
+
+
+<!-- ##### SIGNAL GtkTreeViewColumn::clicked ##### -->
+<para>
+
+</para>
+
+@treeviewcolumn: the object which received the signal.
+
+<!-- ##### ARG GtkTreeViewColumn:alignment ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeViewColumn:clickable ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeViewColumn:expand ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeViewColumn:fixed-width ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeViewColumn:max-width ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeViewColumn:min-width ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeViewColumn:reorderable ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeViewColumn:resizable ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeViewColumn:sizing ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeViewColumn:sort-indicator ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeViewColumn:sort-order ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeViewColumn:title ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeViewColumn:visible ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeViewColumn:widget ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkTreeViewColumn:width ##### -->
+<para>
+
+</para>