cut-n-paste/gimpcellrenderertoggle/gimpcellrenderertoggle.c

   1 /* LIBGIMP - The GIMP Library
   2  * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
   3  *
   4  * gimpcellrenderertoggle.c
   5  * Copyright (C) 2003-2004  Sven Neumann <sven@gimp.org>
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #include <config.h>
  24
  25 #include "gimpwidgetsmarshal.h"
  26 #include "gimpcellrenderertoggle.h"
  27
  28
  29 #define DEFAULT_ICON_SIZE  GTK_ICON_SIZE_BUTTON
  30
  31
  32 enum
  33 {
  34   CLICKED,
  35   LAST_SIGNAL
  36 };
  37
  38 enum
  39 {
  40   PROP_0,
  41   PROP_STOCK_ID,
  42   PROP_STOCK_SIZE
  43 };
  44
  45
  46 static void gimp_cell_renderer_toggle_finalize     (GObject         *object);
  47 static void gimp_cell_renderer_toggle_get_property (GObject         *object,
  48                                                     guint            param_id,
  49                                                     GValue          *value,
  50                                                     GParamSpec      *pspec);
  51 static void gimp_cell_renderer_toggle_set_property (GObject         *object,
  52                                                     guint            param_id,
  53                                                     const GValue    *value,
  54                                                     GParamSpec      *pspec);
  55 static void gimp_cell_renderer_toggle_get_size     (GtkCellRenderer *cell,
  56                                                     GtkWidget       *widget,
  57                                                     GdkRectangle    *rectangle,
  58                                                     gint            *x_offset,
  59                                                     gint            *y_offset,
  60                                                     gint            *width,
  61                                                     gint            *height);
  62 static void gimp_cell_renderer_toggle_render       (GtkCellRenderer *cell,
  63                                                     cairo_t         *cr,
  64                                                     GtkWidget       *widget,
  65                                                     const GdkRectangle  *background_area,
  66                                                     const GdkRectangle  *cell_area,
  67                                                     GtkCellRendererState flags);
  68 static gboolean gimp_cell_renderer_toggle_activate (GtkCellRenderer *cell,
  69                                                     GdkEvent        *event,
  70                                                     GtkWidget       *widget,
  71                                                     const gchar     *path,
  72                                                     GdkRectangle    *background_area,
  73                                                     GdkRectangle    *cell_area,
  74                                                     GtkCellRendererState  flags);
  75 static void gimp_cell_renderer_toggle_create_pixbuf (GimpCellRendererToggle *toggle,
  76                                                      GtkWidget              *widget);
  77
  78
  79 G_DEFINE_TYPE (GimpCellRendererToggle, gimp_cell_renderer_toggle,
  80                GTK_TYPE_CELL_RENDERER_TOGGLE)
  81
  82 #define parent_class gimp_cell_renderer_toggle_parent_class
  83
  84 static guint toggle_cell_signals[LAST_SIGNAL] = { 0 };
  85
  86
  87 static void
  88 gimp_cell_renderer_toggle_class_init (GimpCellRendererToggleClass *klass)
  89 {
  90   GObjectClass         *object_class = G_OBJECT_CLASS (klass);
  91   GtkCellRendererClass *cell_class   = GTK_CELL_RENDERER_CLASS (klass);
  92
  93   toggle_cell_signals[CLICKED] =
  94     g_signal_new ("clicked",
  95                   G_OBJECT_CLASS_TYPE (object_class),
  96                   G_SIGNAL_RUN_LAST,
  97                   G_STRUCT_OFFSET (GimpCellRendererToggleClass, clicked),
  98                   NULL, NULL,
  99                   _gimp_widgets_marshal_VOID__STRING_FLAGS,
 100                   G_TYPE_NONE, 2,
 101                   G_TYPE_STRING,
 102                   GDK_TYPE_MODIFIER_TYPE);
 103
 104   object_class->finalize     = gimp_cell_renderer_toggle_finalize;
 105   object_class->get_property = gimp_cell_renderer_toggle_get_property;
 106   object_class->set_property = gimp_cell_renderer_toggle_set_property;
 107
 108   cell_class->get_size       = gimp_cell_renderer_toggle_get_size;
 109   cell_class->render         = gimp_cell_renderer_toggle_render;
 110   cell_class->activate       = gimp_cell_renderer_toggle_activate;
 111
 112   g_object_class_install_property (object_class,
 113                                    PROP_STOCK_ID,
 114                                    g_param_spec_string ("stock-id",
 115                                                         NULL, NULL,
 116                                                         NULL,
 117                                                         G_PARAM_READWRITE |
 118                                                         G_PARAM_CONSTRUCT));
 119   g_object_class_install_property (object_class,
 120                                    PROP_STOCK_SIZE,
 121                                    g_param_spec_int ("stock-size",
 122                                                      NULL, NULL,
 123                                                      0, G_MAXINT,
 124                                                      DEFAULT_ICON_SIZE,
 125                                                      G_PARAM_READWRITE |
 126                                                      G_PARAM_CONSTRUCT));
 127 }
 128
 129 static void
 130 gimp_cell_renderer_toggle_init (GimpCellRendererToggle *toggle)
 131 {
 132 }
 133
 134 static void
 135 gimp_cell_renderer_toggle_finalize (GObject *object)
 136 {
 137   GimpCellRendererToggle *toggle = GIMP_CELL_RENDERER_TOGGLE (object);
 138
 139   if (toggle->stock_id)
 140     {
 141       g_free (toggle->stock_id);
 142       toggle->stock_id = NULL;
 143     }
 144
 145   if (toggle->pixbuf)
 146     {
 147       g_object_unref (toggle->pixbuf);
 148       toggle->pixbuf = NULL;
 149     }
 150
 151   G_OBJECT_CLASS (parent_class)->finalize (object);
 152 }
 153
 154 static void
 155 gimp_cell_renderer_toggle_get_property (GObject    *object,
 156                                         guint       param_id,
 157                                         GValue     *value,
 158                                         GParamSpec *pspec)
 159 {
 160   GimpCellRendererToggle *toggle = GIMP_CELL_RENDERER_TOGGLE (object);
 161
 162   switch (param_id)
 163     {
 164     case PROP_STOCK_ID:
 165       g_value_set_string (value, toggle->stock_id);
 166       break;
 167     case PROP_STOCK_SIZE:
 168       g_value_set_int (value, toggle->stock_size);
 169       break;
 170
 171     default:
 172       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
 173       break;
 174     }
 175 }
 176
 177 static void
 178 gimp_cell_renderer_toggle_set_property (GObject      *object,
 179                                         guint         param_id,
 180                                         const GValue *value,
 181                                         GParamSpec   *pspec)
 182 {
 183   GimpCellRendererToggle *toggle = GIMP_CELL_RENDERER_TOGGLE (object);
 184
 185   switch (param_id)
 186     {
 187     case PROP_STOCK_ID:
 188       if (toggle->stock_id)
 189         g_free (toggle->stock_id);
 190       toggle->stock_id = g_value_dup_string (value);
 191       break;
 192     case PROP_STOCK_SIZE:
 193       toggle->stock_size = g_value_get_int (value);
 194       break;
 195
 196     default:
 197       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
 198       break;
 199     }
 200
 201   if (toggle->pixbuf)
 202     {
 203       g_object_unref (toggle->pixbuf);
 204       toggle->pixbuf = NULL;
 205     }
 206 }
 207
 208 static void
 209 gimp_cell_renderer_toggle_get_size (GtkCellRenderer *cell,
 210                                     GtkWidget       *widget,
 211                                     GdkRectangle    *cell_area,
 212                                     gint            *x_offset,
 213                                     gint            *y_offset,
 214                                     gint            *width,
 215                                     gint            *height)
 216 {
 217   GimpCellRendererToggle *toggle = GIMP_CELL_RENDERER_TOGGLE (cell);
 218   GtkStyle               *style  = gtk_widget_get_style (widget);
 219   gint                    calc_width;
 220   gint                    calc_height;
 221   gint                    pixbuf_width;
 222   gint                    pixbuf_height;
 223   gfloat                  xalign;
 224   gfloat                  yalign;
 225   gint                    xpad;
 226   gint                    ypad;
 227
 228   if (! toggle->stock_id)
 229     {
 230       GTK_CELL_RENDERER_CLASS (parent_class)->get_size (cell,
 231                                                         widget,
 232                                                         cell_area,
 233                                                         x_offset, y_offset,
 234                                                         width, height);
 235       return;
 236     }
 237
 238   gtk_cell_renderer_get_alignment (cell, &xalign, &yalign);
 239   gtk_cell_renderer_get_padding (cell, &xpad, &ypad);
 240
 241   if (! toggle->pixbuf)
 242     gimp_cell_renderer_toggle_create_pixbuf (toggle, widget);
 243
 244   pixbuf_width  = gdk_pixbuf_get_width  (toggle->pixbuf);
 245   pixbuf_height = gdk_pixbuf_get_height (toggle->pixbuf);
 246
 247   calc_width  = (pixbuf_width +
 248                  (gint) xpad * 2 + style->xthickness * 2);
 249   calc_height = (pixbuf_height +
 250                  (gint) ypad * 2 + style->ythickness * 2);
 251
 252   if (width)
 253     *width  = calc_width;
 254
 255   if (height)
 256     *height = calc_height;
 257
 258   if (cell_area)
 259     {
 260       if (x_offset)
 261         {
 262           *x_offset = (((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL) ?
 263                         (1.0 - xalign) : xalign) *
 264                        (cell_area->width - calc_width));
 265           *x_offset = MAX (*x_offset, 0);
 266         }
 267
 268       if (y_offset)
 269         {
 270           *y_offset = yalign * (cell_area->height - calc_height);
 271           *y_offset = MAX (*y_offset, 0);
 272         }
 273     }
 274 }
 275
 276 static void
 277 gimp_cell_renderer_toggle_render (GtkCellRenderer      *cell,
 278                                   cairo_t              *cr,
 279                                   GtkWidget            *widget,
 280                                   const GdkRectangle   *background_area,
 281                                   const GdkRectangle   *cell_area,
 282                                   GtkCellRendererState  flags)
 283 {
 284   GimpCellRendererToggle *toggle = GIMP_CELL_RENDERER_TOGGLE (cell);
 285   GtkStyle               *style  = gtk_widget_get_style (widget);
 286   GdkRectangle            toggle_rect;
 287   GdkRectangle            draw_rect;
 288   GdkRectangle            clip_rect;
 289   GtkStateType            state;
 290   gboolean                active;
 291   gint                    xpad;
 292   gint                    ypad;
 293
 294   if (! toggle->stock_id)
 295     {
 296       GTK_CELL_RENDERER_CLASS (parent_class)->render (cell,
 297                                                       cr,
 298                                                       widget,
 299                                                       background_area,
 300                                                       cell_area,
 301                                                       flags);
 302       return;
 303     }
 304
 305   gtk_cell_renderer_get_size (cell, widget, cell_area,
 306                               &toggle_rect.x,
 307                               &toggle_rect.y,
 308                               &toggle_rect.width,
 309                               &toggle_rect.height);
 310
 311   gtk_cell_renderer_get_padding (cell, &xpad, &ypad);
 312   toggle_rect.x      += cell_area->x + xpad;
 313   toggle_rect.y      += cell_area->y + ypad;
 314   toggle_rect.width  -= xpad * 2;
 315   toggle_rect.height -= ypad * 2;
 316
 317   if (toggle_rect.width <= 0 || toggle_rect.height <= 0)
 318     return;
 319
 320   active =
 321     gtk_cell_renderer_toggle_get_active (GTK_CELL_RENDERER_TOGGLE (cell));
 322
 323   if (!gtk_cell_renderer_get_sensitive (cell))
 324     {
 325       state = GTK_STATE_INSENSITIVE;
 326     }
 327   else if ((flags & GTK_CELL_RENDERER_SELECTED) == GTK_CELL_RENDERER_SELECTED)
 328     {
 329       if (gtk_widget_has_focus (widget))
 330         state = GTK_STATE_SELECTED;
 331       else
 332         state = GTK_STATE_ACTIVE;
 333     }
 334   else
 335     {
 336       if (gtk_cell_renderer_toggle_get_activatable (GTK_CELL_RENDERER_TOGGLE (cell)))
 337         state = GTK_STATE_NORMAL;
 338       else
 339         state = GTK_STATE_INSENSITIVE;
 340     }
 341
 342   if ((flags & GTK_CELL_RENDERER_PRELIT) &&
 343       gdk_cairo_get_clip_rectangle(cr, &clip_rect) &&
 344       gdk_rectangle_intersect (&clip_rect, cell_area, &draw_rect))
 345     {
 346       cairo_save (cr);
 347       gdk_cairo_rectangle (cr, &draw_rect);
 348       cairo_clip (cr);
 349       gtk_paint_shadow (style,
 350                         cr,
 351                         state,
 352                         active ? GTK_SHADOW_IN : GTK_SHADOW_OUT,
 353                         widget, NULL,
 354                         toggle_rect.x,     toggle_rect.y,
 355                         toggle_rect.width, toggle_rect.height);
 356       cairo_restore (cr);
 357     }
 358
 359   if (active)
 360     {
 361       GdkPixbuf *insensitive = NULL;
 362       GdkPixbuf *pixbuf = toggle->pixbuf;
 363
 364       toggle_rect.x      += style->xthickness;
 365       toggle_rect.y      += style->ythickness;
 366       toggle_rect.width  -= style->xthickness * 2;
 367       toggle_rect.height -= style->ythickness * 2;
 368
 369       if (state == GTK_STATE_INSENSITIVE)
 370         {
 371           GtkIconSource *source;
 372
 373           source = gtk_icon_source_new ();
 374           gtk_icon_source_set_pixbuf (source, pixbuf);
 375           /* The size here is arbitrary; since size isn't
 376            * wildcarded in the source, it isn't supposed to be
 377            * scaled by the engine function
 378            */
 379           gtk_icon_source_set_size (source, GTK_ICON_SIZE_SMALL_TOOLBAR);
 380           gtk_icon_source_set_size_wildcarded (source, FALSE);
 381
 382           insensitive = gtk_style_render_icon (gtk_widget_get_style (widget),
 383                                                source,
 384                                                gtk_widget_get_direction (widget),
 385                                                GTK_STATE_INSENSITIVE,
 386                                                /* arbitrary */
 387                                                (GtkIconSize)-1,
 388                                                widget,
 389                                                "gimpcellrenderertoggle");
 390
 391           gtk_icon_source_free (source);
 392
 393           pixbuf = insensitive;
 394         }
 395
 396       if (gdk_rectangle_intersect (&draw_rect, &toggle_rect, &draw_rect))
 397         {
 398           gdk_cairo_set_source_pixbuf (cr, pixbuf, toggle_rect.x, toggle_rect.y);
 399           gdk_cairo_rectangle (cr, &draw_rect);
 400           cairo_fill (cr);
 401         }
 402
 403       if (insensitive)
 404         g_object_unref (insensitive);
 405     }
 406 }
 407
 408 static gboolean
 409 gimp_cell_renderer_toggle_activate (GtkCellRenderer      *cell,
 410                                     GdkEvent             *event,
 411                                     GtkWidget            *widget,
 412                                     const gchar          *path,
 413                                     GdkRectangle         *background_area,
 414                                     GdkRectangle         *cell_area,
 415                                     GtkCellRendererState  flags)
 416 {
 417   GtkCellRendererToggle *toggle = GTK_CELL_RENDERER_TOGGLE (cell);
 418
 419   if (gtk_cell_renderer_toggle_get_activatable (toggle))
 420     {
 421       GdkModifierType state = 0;
 422
 423       GTK_CELL_RENDERER_CLASS (parent_class)->activate (cell, event, widget,
 424                                                         path, background_area,
 425                                                         cell_area, flags);
 426
 427       if (event && ((GdkEventAny *) event)->type == GDK_BUTTON_PRESS)
 428         state = ((GdkEventButton *) event)->state;
 429
 430       gimp_cell_renderer_toggle_clicked (GIMP_CELL_RENDERER_TOGGLE (cell),
 431                                          path, state);
 432
 433       return TRUE;
 434     }
 435
 436   return FALSE;
 437 }
 438
 439 static void
 440 gimp_cell_renderer_toggle_create_pixbuf (GimpCellRendererToggle *toggle,
 441                                          GtkWidget              *widget)
 442 {
 443   if (toggle->pixbuf)
 444     g_object_unref (toggle->pixbuf);
 445
 446   toggle->pixbuf = gtk_widget_render_icon (widget,
 447                                            toggle->stock_id,
 448                                            toggle->stock_size, NULL);
 449 }
 450
 451
 452 /**
 453  * gimp_cell_renderer_toggle_new:
 454  * @stock_id: the stock_id of the icon to use for the active state
 455  *
 456  * Creates a custom version of the #GtkCellRendererToggle. Instead of
 457  * showing the standard toggle button, it shows a stock icon if the
 458  * cell is active and no icon otherwise. This cell renderer is for
 459  * example used in the Layers treeview to indicate and control the
 460  * layer's visibility by showing %GIMP_STOCK_VISIBLE.
 461  *
 462  * Return value: a new #GimpCellRendererToggle
 463  *
 464  * Since: GIMP 2.2
 465  **/
 466 GtkCellRenderer *
 467 gimp_cell_renderer_toggle_new (const gchar *stock_id)
 468 {
 469   return g_object_new (GIMP_TYPE_CELL_RENDERER_TOGGLE,
 470                        "stock_id", stock_id,
 471                        NULL);
 472 }
 473
 474 /**
 475  * gimp_cell_renderer_toggle_clicked:
 476  * @cell: a #GimpCellRendererToggle
 477  * @path:
 478  * @state:
 479  *
 480  * Emits the "clicked" signal from a #GimpCellRendererToggle.
 481  *
 482  * Since: GIMP 2.2
 483  **/
 484 void
 485 gimp_cell_renderer_toggle_clicked (GimpCellRendererToggle *cell,
 486                                    const gchar            *path,
 487                                    GdkModifierType         state)
 488 {
 489   g_return_if_fail (GIMP_IS_CELL_RENDERER_TOGGLE (cell));
 490   g_return_if_fail (path != NULL);
 491
 492   g_signal_emit (cell, toggle_cell_signals[CLICKED], 0, path, state);
 493 }