aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/table/e-cell-toggle.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-toggle.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-toggle.c')
-rw-r--r--widgets/table/e-cell-toggle.c24
1 files changed, 24 insertions, 0 deletions
diff --git a/widgets/table/e-cell-toggle.c b/widgets/table/e-cell-toggle.c
index 0dd4fe8d20..9c5f7b391b 100644
--- a/widgets/table/e-cell-toggle.c
+++ b/widgets/table/e-cell-toggle.c
@@ -280,6 +280,16 @@ e_cell_toggle_class_init (GtkObjectClass *object_class)
E_MAKE_TYPE(e_cell_toggle, "ECellToggle", ECellToggle, e_cell_toggle_class_init, NULL, PARENT_TYPE);
+/**
+ * e_cell_toggle_construct:
+ * @etog: a fresh ECellToggle object
+ * @border: number of pixels used as a border
+ * @n_states: number of states the toggle will have
+ * @images: a collection of @n_states images, one for each state.
+ *
+ * Constructs the @etog object with the @border, @n_staes, and @images
+ * arguments.
+ */
void
e_cell_toggle_construct (ECellToggle *etog, int border, int n_states, GdkPixbuf **images)
{
@@ -302,6 +312,20 @@ e_cell_toggle_construct (ECellToggle *etog, int border, int n_states, GdkPixbuf
etog->height = max_height;
}
+/**
+ * e_cell_checkbox_new:
+ * @border: number of pixels used as a border
+ * @n_states: number of states the toggle will have
+ * @images: a collection of @n_states images, one for each state.
+ *
+ * Creates a new ECell renderer that can be used to render toggle
+ * buttons with the images specified in @images. The value returned
+ * by ETableModel::get_value is typecase into an integer and clamped
+ * to the [0..n_states) range. That will select the image rendered.
+ *
+ * Returns: an ECell object that can be used to render multi-state
+ * toggle cells.
+ */
ECell *
e_cell_toggle_new (int border, int n_states, GdkPixbuf **images)
{