aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/table/e-cell-checkbox.c
diff options
context:
space:
mode:
authorMiguel de Icaza <miguel@helixcode.com>2000-11-25 13:05:40 +0800
committerMiguel de Icaza <miguel@src.gnome.org>2000-11-25 13:05:40 +0800
commita2ad62af11dbff0880909b0039253f8ab29d9a52 (patch)
treeb93ec9a2807f0418cdbebc210b0376c510ad5501 /widgets/table/e-cell-checkbox.c
parent0c3908d771f165fdee675c5595986f113a06de86 (diff)
downloadgsoc2013-evolution-a2ad62af11dbff0880909b0039253f8ab29d9a52.tar.gz
gsoc2013-evolution-a2ad62af11dbff0880909b0039253f8ab29d9a52.tar.zst
gsoc2013-evolution-a2ad62af11dbff0880909b0039253f8ab29d9a52.zip
Documented.
2000-11-25 Miguel de Icaza <miguel@helixcode.com> * e-cell.c: Documented. 2000-11-24 Miguel de Icaza <miguel@helixcode.com> * e-cell-toggle.c (etog_queue_redraw): Documented. * e-cell-text.c: Removed list of unused arguments. Add docs. * e-cell-checkbox.c (e_cell_checkbox_new): Add docs. * e-table-simple.c (e_table_simple_new): Add docs. svn path=/trunk/; revision=6665
Diffstat (limited to 'widgets/table/e-cell-checkbox.c')
-rw-r--r--widgets/table/e-cell-checkbox.c11
1 files changed, 10 insertions, 1 deletions
diff --git a/widgets/table/e-cell-checkbox.c b/widgets/table/e-cell-checkbox.c
index 4d31b53784..cb0c66df94 100644
--- a/widgets/table/e-cell-checkbox.c
+++ b/widgets/table/e-cell-checkbox.c
@@ -4,7 +4,7 @@
* Author:
* Miguel de Icaza (miguel@kernel.org)
*
- * (C) 1999 Helix Code, Inc
+ * (C) 1999, 2000 Helix Code, Inc
*/
#include <config.h>
#include <gtk/gtkenums.h>
@@ -33,6 +33,15 @@ e_cell_checkbox_class_init (GtkObjectClass *object_class)
E_MAKE_TYPE(e_cell_checkbox, "ECellCheckbox", ECellCheckbox, e_cell_checkbox_class_init, NULL, PARENT_TYPE);
+/**
+ * e_cell_checkbox_new:
+ *
+ * Creates a new ECell renderer that can be used to render check
+ * boxes. the data provided from the model is cast to an integer.
+ * zero is used for the off display, and non-zero for checked status.
+ *
+ * Returns: an ECell object that can be used to render checkboxes.
+ */
ECell *
e_cell_checkbox_new (void)
{