]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtkcellrenderertoggle.c
Add default handlers for all signals; for consistency and for the benefit
[~andy/gtk] / gtk / gtkcellrenderertoggle.c
index fac044d657b1dceff61eb415cde20a74a45f06cf..efce7708be0a6dccbbd941cc56271179f7258578 100644 (file)
  */
 
 #include <stdlib.h>
-#include <gtk/gtkcellrenderertoggle.h>
-#include <gtk/gtksignal.h>
-
-#ifndef _
-#define _(x) x
-#endif
-
+#include "gtkcellrenderertoggle.h"
+#include "gtkintl.h"
+#include "gtkmarshalers.h"
+#include "gtktreeprivate.h"
 
 static void gtk_cell_renderer_toggle_get_property  (GObject                    *object,
                                                    guint                       param_id,
                                                    GValue                     *value,
-                                                   GParamSpec                 *pspec,
-                                                   const gchar                *trailer);
+                                                   GParamSpec                 *pspec);
 static void gtk_cell_renderer_toggle_set_property  (GObject                    *object,
                                                    guint                       param_id,
                                                    const GValue               *value,
-                                                   GParamSpec                 *pspec,
-                                                   const gchar                *trailer);
+                                                   GParamSpec                 *pspec);
 static void gtk_cell_renderer_toggle_init       (GtkCellRendererToggle      *celltext);
 static void gtk_cell_renderer_toggle_class_init (GtkCellRendererToggleClass *class);
 static void gtk_cell_renderer_toggle_get_size   (GtkCellRenderer            *cell,
                                                 GtkWidget                  *widget,
+                                                GdkRectangle               *cell_area,
+                                                gint                       *x_offset,
+                                                gint                       *y_offset,
                                                 gint                       *width,
                                                 gint                       *height);
 static void gtk_cell_renderer_toggle_render     (GtkCellRenderer            *cell,
@@ -48,14 +46,14 @@ static void gtk_cell_renderer_toggle_render     (GtkCellRenderer            *cel
                                                 GdkRectangle               *background_area,
                                                 GdkRectangle               *cell_area,
                                                 GdkRectangle               *expose_area,
-                                                guint                       flags);
-static gint gtk_cell_renderer_toggle_event      (GtkCellRenderer            *cell,
-                                                GdkEvent                   *event,
-                                                GtkWidget                  *widget,
-                                                gchar                      *path,
-                                                GdkRectangle               *background_area,
-                                                GdkRectangle               *cell_area,
-                                                guint                       flags);
+                                                GtkCellRendererState        flags);
+static gboolean gtk_cell_renderer_toggle_activate  (GtkCellRenderer            *cell,
+                                                   GdkEvent                   *event,
+                                                   GtkWidget                  *widget,
+                                                   const gchar                *path,
+                                                   GdkRectangle               *background_area,
+                                                   GdkRectangle               *cell_area,
+                                                   GtkCellRendererState        flags);
 
 
 enum {
@@ -65,20 +63,29 @@ enum {
 
 enum {
   PROP_ZERO,
-  PROP_STATE,
-  PROP_RADIO
+  PROP_ACTIVATABLE,
+  PROP_ACTIVE,
+  PROP_RADIO,
+  PROP_INCONSISTENT
 };
 
-
 #define TOGGLE_WIDTH 12
 
 static guint toggle_cell_signals[LAST_SIGNAL] = { 0 };
 
+#define GTK_CELL_RENDERER_TOGGLE_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_CELL_RENDERER_TOGGLE, GtkCellRendererTogglePrivate))
+
+typedef struct _GtkCellRendererTogglePrivate GtkCellRendererTogglePrivate;
+struct _GtkCellRendererTogglePrivate
+{
+  guint inconsistent : 1;
+};
+
 
-GtkType
+GType
 gtk_cell_renderer_toggle_get_type (void)
 {
-  static GtkType cell_toggle_type = 0;
+  static GType cell_toggle_type = 0;
 
   if (!cell_toggle_type)
     {
@@ -95,7 +102,9 @@ gtk_cell_renderer_toggle_get_type (void)
        (GInstanceInitFunc) gtk_cell_renderer_toggle_init,
       };
 
-      cell_toggle_type = g_type_register_static (GTK_TYPE_CELL_RENDERER, "GtkCellRendererToggle", &cell_toggle_info, 0);
+      cell_toggle_type =
+       g_type_register_static (GTK_TYPE_CELL_RENDERER, "GtkCellRendererToggle",
+                               &cell_toggle_info, 0);
     }
 
   return cell_toggle_type;
@@ -104,8 +113,10 @@ gtk_cell_renderer_toggle_get_type (void)
 static void
 gtk_cell_renderer_toggle_init (GtkCellRendererToggle *celltoggle)
 {
-  celltoggle->state = FALSE;
+  celltoggle->activatable = TRUE;
+  celltoggle->active = FALSE;
   celltoggle->radio = FALSE;
+  GTK_CELL_RENDERER (celltoggle)->mode = GTK_CELL_RENDERER_MODE_ACTIVATABLE;
   GTK_CELL_RENDERER (celltoggle)->xpad = 2;
   GTK_CELL_RENDERER (celltoggle)->ypad = 2;
 }
@@ -121,50 +132,79 @@ gtk_cell_renderer_toggle_class_init (GtkCellRendererToggleClass *class)
 
   cell_class->get_size = gtk_cell_renderer_toggle_get_size;
   cell_class->render = gtk_cell_renderer_toggle_render;
-  cell_class->event = gtk_cell_renderer_toggle_event;
+  cell_class->activate = gtk_cell_renderer_toggle_activate;
   
   g_object_class_install_property (object_class,
-                                  PROP_STATE,
-                                  g_param_spec_boolean ("state",
-                                                        _("Toggle state"),
-                                                        _("The toggle-state of the button."),
+                                  PROP_ACTIVE,
+                                  g_param_spec_boolean ("active",
+                                                        P_("Toggle state"),
+                                                        P_("The toggle state of the button"),
+                                                        FALSE,
+                                                        G_PARAM_READABLE |
+                                                        G_PARAM_WRITABLE));
+
+  g_object_class_install_property (object_class,
+                                  PROP_INCONSISTENT,
+                                  g_param_spec_boolean ("inconsistent",
+                                                        P_("Inconsistent state"),
+                                                        P_("The inconsistent state of the button"),
                                                         FALSE,
                                                         G_PARAM_READABLE |
                                                         G_PARAM_WRITABLE));
   
+  g_object_class_install_property (object_class,
+                                  PROP_ACTIVATABLE,
+                                  g_param_spec_boolean ("activatable",
+                                                        P_("Activatable"),
+                                                        P_("The toggle button can be activated"),
+                                                        TRUE,
+                                                        G_PARAM_READABLE |
+                                                        G_PARAM_WRITABLE));
+
   g_object_class_install_property (object_class,
                                   PROP_RADIO,
                                   g_param_spec_boolean ("radio",
-                                                        _("Radio state"),
-                                                        _("Draw the toggle button as a radio button."),
+                                                        P_("Radio state"),
+                                                        P_("Draw the toggle button as a radio button"),
                                                         FALSE,
                                                         G_PARAM_READABLE |
                                                         G_PARAM_WRITABLE));
 
 
   toggle_cell_signals[TOGGLED] =
-    gtk_signal_new ("toggled",
-                   GTK_RUN_LAST,
-                   GTK_CLASS_TYPE (object_class),
-                   GTK_SIGNAL_OFFSET (GtkCellRendererToggleClass, toggled),
-                   gtk_marshal_VOID__POINTER,
-                   GTK_TYPE_NONE, 1,
-                   GTK_TYPE_POINTER);
+    g_signal_new ("toggled",
+                 G_OBJECT_CLASS_TYPE (object_class),
+                 G_SIGNAL_RUN_LAST,
+                 G_STRUCT_OFFSET (GtkCellRendererToggleClass, toggled),
+                 NULL, NULL,
+                 _gtk_marshal_VOID__STRING,
+                 G_TYPE_NONE, 1,
+                 G_TYPE_STRING);
+
+  g_type_class_add_private (object_class, sizeof (GtkCellRendererTogglePrivate));
 }
 
 static void
 gtk_cell_renderer_toggle_get_property (GObject     *object,
                                       guint        param_id,
                                       GValue      *value,
-                                      GParamSpec  *pspec,
-                                      const gchar *trailer)
+                                      GParamSpec  *pspec)
 {
   GtkCellRendererToggle *celltoggle = GTK_CELL_RENDERER_TOGGLE (object);
+  GtkCellRendererTogglePrivate *priv;
+
+  priv = GTK_CELL_RENDERER_TOGGLE_GET_PRIVATE (object);
   
   switch (param_id)
     {
-    case PROP_STATE:
-      g_value_set_boolean (value, celltoggle->state);
+    case PROP_ACTIVE:
+      g_value_set_boolean (value, celltoggle->active);
+      break;
+    case PROP_INCONSISTENT:
+      g_value_set_boolean (value, priv->inconsistent);
+      break;
+    case PROP_ACTIVATABLE:
+      g_value_set_boolean (value, celltoggle->activatable);
       break;
     case PROP_RADIO:
       g_value_set_boolean (value, celltoggle->radio);
@@ -180,18 +220,30 @@ static void
 gtk_cell_renderer_toggle_set_property (GObject      *object,
                                       guint         param_id,
                                       const GValue *value,
-                                      GParamSpec   *pspec,
-                                      const gchar  *trailer)
+                                      GParamSpec   *pspec)
 {
   GtkCellRendererToggle *celltoggle = GTK_CELL_RENDERER_TOGGLE (object);
+  GtkCellRendererTogglePrivate *priv;
+
+  priv = GTK_CELL_RENDERER_TOGGLE_GET_PRIVATE (object);
   
   switch (param_id)
     {
-    case PROP_STATE:
-      celltoggle->state = g_value_get_boolean (value);
+    case PROP_ACTIVE:
+      celltoggle->active = g_value_get_boolean (value);
+      g_object_notify (G_OBJECT(object), "active");
+      break;
+    case PROP_INCONSISTENT:
+      priv->inconsistent = g_value_get_boolean (value);
+      g_object_notify (G_OBJECT (object), "inconsistent");
+      break;
+    case PROP_ACTIVATABLE:
+      celltoggle->activatable = g_value_get_boolean (value);
+      g_object_notify (G_OBJECT(object), "activatable");
       break;
     case PROP_RADIO:
       celltoggle->radio = g_value_get_boolean (value);
+      g_object_notify (G_OBJECT(object), "radio");
       break;
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
@@ -199,121 +251,219 @@ gtk_cell_renderer_toggle_set_property (GObject      *object,
     }
 }
 
+/**
+ * gtk_cell_renderer_toggle_new:
+ * 
+ * Creates a new #GtkCellRendererToggle. Adjust rendering
+ * parameters using object properties. Object properties can be set
+ * globally (with g_object_set()). Also, with #GtkTreeViewColumn, you
+ * can bind a property to a value in a #GtkTreeModel. For example, you
+ * can bind the "active" property on the cell renderer to a boolean value
+ * in the model, thus causing the check button to reflect the state of
+ * the model.
+ * 
+ * Return value: the new cell renderer
+ **/
 GtkCellRenderer *
 gtk_cell_renderer_toggle_new (void)
 {
-  return GTK_CELL_RENDERER (gtk_type_new (gtk_cell_renderer_toggle_get_type ()));
+  return g_object_new (GTK_TYPE_CELL_RENDERER_TOGGLE, NULL);
 }
 
 static void
 gtk_cell_renderer_toggle_get_size (GtkCellRenderer *cell,
                                   GtkWidget       *widget,
+                                  GdkRectangle    *cell_area,
+                                  gint            *x_offset,
+                                  gint            *y_offset,
                                   gint            *width,
                                   gint            *height)
 {
+  gint calc_width;
+  gint calc_height;
+
+  calc_width = (gint) cell->xpad * 2 + TOGGLE_WIDTH;
+  calc_height = (gint) cell->ypad * 2 + TOGGLE_WIDTH;
+
   if (width)
-    *width = (gint) cell->xpad * 2 + TOGGLE_WIDTH;
+    *width = calc_width;
 
   if (height)
-    *height = (gint) cell->ypad * 2 + TOGGLE_WIDTH;
+    *height = calc_height;
+
+  if (cell_area)
+    {
+      if (x_offset)
+       {
+         *x_offset = ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL) ?
+                      (1.0 - cell->xalign) : cell->xalign) * (cell_area->width - calc_width);
+         *x_offset = MAX (*x_offset, 0);
+       }
+      if (y_offset)
+       {
+         *y_offset = cell->yalign * (cell_area->height - calc_height);
+         *y_offset = MAX (*y_offset, 0);
+       }
+    }
 }
 
 static void
-gtk_cell_renderer_toggle_render (GtkCellRenderer *cell,
-                                GdkWindow       *window,
-                                GtkWidget       *widget,
-                                GdkRectangle    *background_area,
-                                GdkRectangle    *cell_area,
-                                GdkRectangle    *expose_area,
-                                guint            flags)
+gtk_cell_renderer_toggle_render (GtkCellRenderer      *cell,
+                                GdkDrawable          *window,
+                                GtkWidget            *widget,
+                                GdkRectangle         *background_area,
+                                GdkRectangle         *cell_area,
+                                GdkRectangle         *expose_area,
+                                GtkCellRendererState  flags)
 {
   GtkCellRendererToggle *celltoggle = (GtkCellRendererToggle *) cell;
+  GtkCellRendererTogglePrivate *priv;
   gint width, height;
-  gint real_xoffset, real_yoffset;
+  gint x_offset, y_offset;
+  GtkShadowType shadow;
+  GtkStateType state = 0;
+
+  priv = GTK_CELL_RENDERER_TOGGLE_GET_PRIVATE (cell);
 
-  width = MIN (TOGGLE_WIDTH, cell_area->width - cell->xpad * 2);
-  height = MIN (TOGGLE_WIDTH, cell_area->height - cell->ypad * 2);
+  gtk_cell_renderer_toggle_get_size (cell, widget, cell_area,
+                                    &x_offset, &y_offset,
+                                    &width, &height);
+  width -= cell->xpad*2;
+  height -= cell->ypad*2;
 
   if (width <= 0 || height <= 0)
     return;
 
-  real_xoffset = cell->xalign * (cell_area->width - width - (2 * cell->xpad));
-  real_xoffset = MAX (real_xoffset, 0) + cell->xpad;
-  real_yoffset = cell->yalign * (cell_area->height - height - (2 * cell->ypad));
-  real_yoffset = MAX (real_yoffset, 0) + cell->ypad;
-
-  gdk_gc_set_clip_rectangle (widget->style->black_gc, cell_area);
+  if (priv->inconsistent)
+    shadow = GTK_SHADOW_ETCHED_IN;
+  else
+    shadow = celltoggle->active ? GTK_SHADOW_IN : GTK_SHADOW_OUT;
 
-  if (!celltoggle->radio)
+  if ((flags & GTK_CELL_RENDERER_SELECTED) == GTK_CELL_RENDERER_SELECTED)
     {
-      gdk_draw_rectangle (window,
-                         widget->style->black_gc,
-                         FALSE,
-                         cell_area->x + real_xoffset,
-                         cell_area->y + real_yoffset,
-                         width, height);
-      if (celltoggle->state)
-       {
-         gdk_draw_line (window,
-                        widget->style->black_gc,
-                        cell_area->x + real_xoffset,
-                        cell_area->y + real_yoffset,
-                        cell_area->x + real_xoffset + width,
-                        cell_area->y + real_yoffset + height);
-         gdk_draw_line (window,
-                        widget->style->black_gc,
-                        cell_area->x + real_xoffset + width,
-                        cell_area->y + real_yoffset,
-                        cell_area->x + real_xoffset,
-                        cell_area->y + real_yoffset + height);
-       }
+      if (GTK_WIDGET_HAS_FOCUS (widget))
+       state = GTK_STATE_SELECTED;
+      else
+       state = GTK_STATE_ACTIVE;
     }
   else
     {
-      gdk_draw_arc (window,
-                   widget->style->black_gc,
-                   FALSE,
-                   cell_area->x + real_xoffset,
-                   cell_area->y + real_yoffset,
-                   width,
-                   height,
-                   0, 360*64);
-      if (celltoggle->state)
-       {
-         gdk_draw_arc (window,
-                       widget->style->black_gc,
-                       TRUE,
-                       cell_area->x + real_xoffset + 2,
-                       cell_area->y + real_yoffset + 2,
-                       width - 4,
-                       height - 4,
-                       0, 360*64);
-       }
+      if (celltoggle->activatable)
+        state = GTK_STATE_NORMAL;
+      else
+        state = GTK_STATE_INSENSITIVE;
     }
 
-
-  gdk_gc_set_clip_rectangle (widget->style->black_gc, NULL);
+  if (celltoggle->radio)
+    {
+      gtk_paint_option (widget->style,
+                        window,
+                        state, shadow,
+                        expose_area, widget, "cellradio",
+                        cell_area->x + x_offset + cell->xpad,
+                        cell_area->y + y_offset + cell->ypad,
+                        width - 1, height - 1);
+    }
+  else
+    {
+      gtk_paint_check (widget->style,
+                       window,
+                       state, shadow,
+                       expose_area, widget, "cellcheck",
+                       cell_area->x + x_offset + cell->xpad,
+                       cell_area->y + y_offset + cell->ypad,
+                       width - 1, height - 1);
+    }
 }
 
 static gint
-gtk_cell_renderer_toggle_event (GtkCellRenderer *cell,
-                               GdkEvent        *event,
-                               GtkWidget       *widget,
-                               gchar           *path,
-                               GdkRectangle    *background_area,
-                               GdkRectangle    *cell_area,
-                               guint            flags)
+gtk_cell_renderer_toggle_activate (GtkCellRenderer      *cell,
+                                  GdkEvent             *event,
+                                  GtkWidget            *widget,
+                                  const gchar          *path,
+                                  GdkRectangle         *background_area,
+                                  GdkRectangle         *cell_area,
+                                  GtkCellRendererState  flags)
 {
-  gtk_signal_emit (GTK_OBJECT (cell), toggle_cell_signals[TOGGLED], path);
-  return TRUE;
+  GtkCellRendererToggle *celltoggle;
+  
+  celltoggle = GTK_CELL_RENDERER_TOGGLE (cell);
+  if (celltoggle->activatable)
+    {
+      g_signal_emit (cell, toggle_cell_signals[TOGGLED], 0, path);
+      return TRUE;
+    }
+
+  return FALSE;
 }
 
+/**
+ * gtk_cell_renderer_toggle_set_radio:
+ * @toggle: a #GtkCellRendererToggle
+ * @radio: %TRUE to make the toggle look like a radio button
+ * 
+ * If @radio is %TRUE, the cell renderer renders a radio toggle
+ * (i.e. a toggle in a group of mutually-exclusive toggles).
+ * If %FALSE, it renders a check toggle (a standalone boolean option).
+ * This can be set globally for the cell renderer, or changed just
+ * before rendering each cell in the model (for #GtkTreeView, you set
+ * up a per-row setting using #GtkTreeViewColumn to associate model
+ * columns with cell renderer properties).
+ **/
 void
 gtk_cell_renderer_toggle_set_radio (GtkCellRendererToggle *toggle,
                                    gboolean               radio)
 {
-  g_return_if_fail (toggle != NULL);
   g_return_if_fail (GTK_IS_CELL_RENDERER_TOGGLE (toggle));
 
   toggle->radio = radio;
 }
+
+/**
+ * gtk_cell_renderer_toggle_get_radio:
+ * @toggle: a #GtkCellRendererToggle
+ *
+ * Returns wether we're rendering radio toggles rather than checkboxes. 
+ * 
+ * Return value: %TRUE if we're rendering radio toggles rather than checkboxes
+ **/
+gboolean
+gtk_cell_renderer_toggle_get_radio (GtkCellRendererToggle *toggle)
+{
+  g_return_val_if_fail (GTK_IS_CELL_RENDERER_TOGGLE (toggle), FALSE);
+
+  return toggle->radio;
+}
+
+/**
+ * gtk_cell_renderer_toggle_get_active:
+ * @toggle: a #GtkCellRendererToggle
+ *
+ * Returns whether the cell renderer is active. See
+ * gtk_cell_renderer_toggle_set_active().
+ *
+ * Return value: %TRUE if the cell renderer is active.
+ **/
+gboolean
+gtk_cell_renderer_toggle_get_active (GtkCellRendererToggle *toggle)
+{
+  g_return_val_if_fail (GTK_IS_CELL_RENDERER_TOGGLE (toggle), FALSE);
+
+  return toggle->active;
+}
+
+/**
+ * gtk_cell_renderer_toggle_set_active:
+ * @toggle: a #GtkCellRendererToggle.
+ * @setting: the value to set.
+ *
+ * Activates or deactivates a cell renderer.
+ **/
+void
+gtk_cell_renderer_toggle_set_active (GtkCellRendererToggle *toggle,
+                                    gboolean               setting)
+{
+  g_return_if_fail (GTK_IS_CELL_RENDERER_TOGGLE (toggle));
+
+  g_object_set (toggle, "active", setting ? TRUE : FALSE, NULL);
+}