diff options
author | Tristan Van Berkom <tristan.van.berkom@gmail.com> | 2010-12-04 15:02:53 +0900 |
---|---|---|
committer | Tristan Van Berkom <tristan.van.berkom@gmail.com> | 2010-12-04 15:02:53 +0900 |
commit | 7e2571a3580673696dda82138b637b01e76d0a0e (patch) | |
tree | cc6e62110f4e3cf7ca5651292ae37d3c53c6a10f /gtk/gtkcellarea.c | |
parent | 2a41de70b149050bbeb4cf2b49be1942f29e3ea4 (diff) | |
download | gtk+-7e2571a3580673696dda82138b637b01e76d0a0e.tar.gz |
Added "Cell Properties" section to the GtkCellArea documentation.
Diffstat (limited to 'gtk/gtkcellarea.c')
-rw-r--r-- | gtk/gtkcellarea.c | 28 |
1 files changed, 26 insertions, 2 deletions
diff --git a/gtk/gtkcellarea.c b/gtk/gtkcellarea.c index a5e8ab9428..b80c2eaf31 100644 --- a/gtk/gtkcellarea.c +++ b/gtk/gtkcellarea.c @@ -231,7 +231,9 @@ * customized derived areas can be implemented who are interested in handling * other events. Handling an event can trigger the #GtkCellArea::focus-changed * signal to fire as well as #GtkCellArea::add-editable in the case that - * an editable cell was clicked and needs to start editing. + * an editable cell was clicked and needs to start editing. You can call + * gtk_cell_area_stop_editing() at any time to cancel any cell editing + * that is currently in progress. * * The #GtkCellArea drives keyboard focus from cell to cell in a way similar * to #GtkWidget. For layouting widgets that support giving focus to cells it's @@ -294,7 +296,7 @@ * else * { * if (focus_row == last_row) - * break; + * break; * else * { * focus_row++; @@ -309,6 +311,28 @@ * </example> * </para> * </refsect2> + * <refsect2 id="cell-properties"> + * <title>Cell Properties</title> + * <para> + * The #GtkCellArea introduces <emphasis>cell properties</emphasis> for #GtkCellRenderers in very + * much the same way that #GtkContainer introduces <link linkend="child-properties">child properties</link> + * for #GtkWidgets. This provides some general interfaces for defining the relationship cell areas + * have with thier cells. For instance in a #GtkCellAreaBox a cell might "expand" and recieve extra + * space when the area is allocated more than it's full natural request, or a cell might be configured + * to "align" with adjacent rows which were requested and rendered with the same #GtkCellAreaContext. + * + * Use gtk_cell_area_class_install_cell_property() to install cell properties + * for a cell area class and gtk_cell_area_class_find_cell_property() or + * gtk_cell_area_class_list_cell_properties() to get information about existing + * cell properties. + * + * To set the value of a cell property, use gtk_cell_area_cell_set_property(), + * gtk_cell_area_cell_set() or gtk_cell_area_cell_set_valist(). + * To obtain the value of a cell property, use + * gtk_cell_area_cell_get_property(), gtk_cell_area_cell_get() or + * gtk_cell_area_cell_get_valist(). + * </para> + * </refsect2> * */ |