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