gtkdrawingarea.c 8.55 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Elliot Lee's avatar
Elliot Lee committed
16
 */
17 18

/*
19
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
20 21
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
22
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
23 24
 */

25
#include "config.h"
Elliot Lee's avatar
Elliot Lee committed
26
#include "gtkdrawingarea.h"
27
#include "gtkintl.h"
28
#include "gtkstylecontext.h"
Elliot Lee's avatar
Elliot Lee committed
29

30

31 32 33 34 35 36 37
/**
 * SECTION:gtkdrawingarea
 * @Short_description: A widget for custom user interface elements
 * @Title: GtkDrawingArea
 * @See_also: #GtkImage
 *
 * The #GtkDrawingArea widget is used for creating custom user interface
38
 * elements. It’s essentially a blank widget; you can draw on it. After
39 40
 * creating a drawing area, the application may want to connect to:
 *
41 42 43 44 45 46 47
 * - Mouse and button press signals to respond to input from
 *   the user. (Use gtk_widget_add_events() to enable events
 *   you wish to receive.)
 *
 * - The #GtkWidget::realize signal to take any necessary actions
 *   when the widget is instantiated on a particular display.
 *   (Create GDK resources in response to this signal.)
48
 *
49
 * - The #GtkWidget::size-allocate signal to take any necessary
50 51 52 53
 *   actions when the widget changes size.
 *
 * - The #GtkWidget::draw signal to handle redrawing the
 *   contents of the widget.
54 55 56 57 58 59 60 61 62
 *
 * The following code portion demonstrates using a drawing
 * area to display a circle in the normal widget foreground
 * color.
 *
 * Note that GDK automatically clears the exposed area to the
 * background color before sending the expose event, and that
 * drawing is implicitly clipped to the exposed area.
 *
63 64
 * ## Simple GtkDrawingArea usage
 *
65
 * |[<!-- language="C" -->
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
 * gboolean
 * draw_callback (GtkWidget *widget, cairo_t *cr, gpointer data)
 * {
 *   guint width, height;
 *   GdkRGBA color;
 *
 *   width = gtk_widget_get_allocated_width (widget);
 *   height = gtk_widget_get_allocated_height (widget);
 *   cairo_arc (cr,
 *              width / 2.0, height / 2.0,
 *              MIN (width, height) / 2.0,
 *              0, 2 * G_PI);
 *
 *   gtk_style_context_get_color (gtk_widget_get_style_context (widget),
 *                                0,
81 82
 *                                &color);
 *   gdk_cairo_set_source_rgba (cr, &color);
83 84 85 86 87 88
 *
 *   cairo_fill (cr);
 *
 *  return FALSE;
 * }
 * [...]
89
 *   GtkWidget *drawing_area = gtk_drawing_area_new ();
90 91 92
 *   gtk_widget_set_size_request (drawing_area, 100, 100);
 *   g_signal_connect (G_OBJECT (drawing_area), "draw",
 *                     G_CALLBACK (draw_callback), NULL);
93
 * ]|
94 95
 *
 * Draw signals are normally delivered when a drawing area first comes
96
 * onscreen, or when it’s covered by another window and then uncovered.
97
 * You can also force an expose event by adding to the “damage region”
98
 * of the drawing area’s window; gtk_widget_queue_draw_area() and
99
 * gdk_window_invalidate_rect() are equally good ways to do this.
100
 * You’ll then get a draw signal for the invalid region.
101
 *
102 103
 * The available routines for drawing are documented on the
 * [GDK Drawing Primitives][gdk3-Cairo-Interaction] page
104 105 106 107
 * and the cairo documentation.
 *
 * To receive mouse events on a drawing area, you will need to enable
 * them with gtk_widget_add_events(). To receive keyboard events, you
108
 * will need to set the “can-focus” property on the drawing area, and you
109
 * should probably draw some user-visible indication that the drawing
110
 * area is focused. Use gtk_widget_has_focus() in your expose event
111
 * handler to decide whether to draw the focus indicator. See
112
 * gtk_render_focus() for one way to draw focus.
113 114
 */

Elliot Lee's avatar
Elliot Lee committed
115
static void gtk_drawing_area_realize       (GtkWidget           *widget);
116
static void gtk_drawing_area_style_updated (GtkWidget           *widget);
Elliot Lee's avatar
Elliot Lee committed
117
static void gtk_drawing_area_size_allocate (GtkWidget           *widget,
118
                                            GtkAllocation       *allocation);
119
static void gtk_drawing_area_send_configure (GtkDrawingArea     *darea);
Elliot Lee's avatar
Elliot Lee committed
120

Matthias Clasen's avatar
Matthias Clasen committed
121
G_DEFINE_TYPE (GtkDrawingArea, gtk_drawing_area, GTK_TYPE_WIDGET)
Elliot Lee's avatar
Elliot Lee committed
122 123 124 125

static void
gtk_drawing_area_class_init (GtkDrawingAreaClass *class)
{
126
  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
Elliot Lee's avatar
Elliot Lee committed
127 128 129

  widget_class->realize = gtk_drawing_area_realize;
  widget_class->size_allocate = gtk_drawing_area_size_allocate;
130
  widget_class->style_updated = gtk_drawing_area_style_updated;
131 132

  gtk_widget_class_set_accessible_role (widget_class, ATK_ROLE_DRAWING_AREA);
Elliot Lee's avatar
Elliot Lee committed
133 134 135 136 137 138 139
}

static void
gtk_drawing_area_init (GtkDrawingArea *darea)
{
}

140 141 142 143 144 145 146
/**
 * gtk_drawing_area_new:
 *
 * Creates a new drawing area.
 *
 * Returns: a new #GtkDrawingArea
 */
Elliot Lee's avatar
Elliot Lee committed
147
GtkWidget*
148
gtk_drawing_area_new (void)
Elliot Lee's avatar
Elliot Lee committed
149
{
Manish Singh's avatar
Manish Singh committed
150
  return g_object_new (GTK_TYPE_DRAWING_AREA, NULL);
Elliot Lee's avatar
Elliot Lee committed
151 152
}

153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
static void
set_background (GtkWidget *widget)
{
  if (gtk_widget_get_realized (widget) &&
      gtk_widget_get_has_window (widget))
    {
      /* We still need to call gtk_style_context_set_background() here for
       * GtkDrawingArea, since clients expect backgrounds set on it (e.g. through
       * gtk_widget_override_background_color) to be available even when they
       * don't chain up from draw().
       * This should be revisited next time we have a major API break.
       */
      G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
      gtk_style_context_set_background (gtk_widget_get_style_context (widget),
                                        gtk_widget_get_window (widget));
      G_GNUC_END_IGNORE_DEPRECATIONS;
    }
}

static void
gtk_drawing_area_style_updated (GtkWidget *widget)
{
  GTK_WIDGET_CLASS (gtk_drawing_area_parent_class)->style_updated (widget);

  set_background (widget);
}

Elliot Lee's avatar
Elliot Lee committed
180 181 182
static void
gtk_drawing_area_realize (GtkWidget *widget)
{
183 184
  GtkAllocation allocation;
  GdkWindow *window;
Elliot Lee's avatar
Elliot Lee committed
185 186 187
  GdkWindowAttr attributes;
  gint attributes_mask;

188
  if (!gtk_widget_get_has_window (widget))
189 190 191 192 193
    {
      GTK_WIDGET_CLASS (gtk_drawing_area_parent_class)->realize (widget);
    }
  else
    {
194
      gtk_widget_set_realized (widget, TRUE);
195

196 197
      gtk_widget_get_allocation (widget, &allocation);

198
      attributes.window_type = GDK_WINDOW_CHILD;
199 200 201 202
      attributes.x = allocation.x;
      attributes.y = allocation.y;
      attributes.width = allocation.width;
      attributes.height = allocation.height;
203 204 205 206
      attributes.wclass = GDK_INPUT_OUTPUT;
      attributes.visual = gtk_widget_get_visual (widget);
      attributes.event_mask = gtk_widget_get_events (widget) | GDK_EXPOSURE_MASK;

207
      attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL;
208

209 210
      window = gdk_window_new (gtk_widget_get_parent_window (widget),
                               &attributes, attributes_mask);
211
      gtk_widget_register_window (widget, window);
212
      gtk_widget_set_window (widget, window);
213

214
      set_background (widget);
215
    }
216 217

  gtk_drawing_area_send_configure (GTK_DRAWING_AREA (widget));
Elliot Lee's avatar
Elliot Lee committed
218 219 220 221
}

static void
gtk_drawing_area_size_allocate (GtkWidget     *widget,
222
                                GtkAllocation *allocation)
Elliot Lee's avatar
Elliot Lee committed
223 224 225 226
{
  g_return_if_fail (GTK_IS_DRAWING_AREA (widget));
  g_return_if_fail (allocation != NULL);

227
  gtk_widget_set_allocation (widget, allocation);
Elliot Lee's avatar
Elliot Lee committed
228

229
  if (gtk_widget_get_realized (widget))
Elliot Lee's avatar
Elliot Lee committed
230
    {
231
      if (gtk_widget_get_has_window (widget))
232
        gdk_window_move_resize (gtk_widget_get_window (widget),
233 234
                                allocation->x, allocation->y,
                                allocation->width, allocation->height);
Elliot Lee's avatar
Elliot Lee committed
235

236
      gtk_drawing_area_send_configure (GTK_DRAWING_AREA (widget));
Elliot Lee's avatar
Elliot Lee committed
237 238
    }
}
239 240 241 242

static void
gtk_drawing_area_send_configure (GtkDrawingArea *darea)
{
243
  GtkAllocation allocation;
244
  GtkWidget *widget;
245
  GdkEvent *event = gdk_event_new (GDK_CONFIGURE);
246 247

  widget = GTK_WIDGET (darea);
248
  gtk_widget_get_allocation (widget, &allocation);
249

250
  event->configure.window = g_object_ref (gtk_widget_get_window (widget));
251
  event->configure.send_event = TRUE;
252 253 254 255
  event->configure.x = allocation.x;
  event->configure.y = allocation.y;
  event->configure.width = allocation.width;
  event->configure.height = allocation.height;
256

257 258
  gtk_widget_event (widget, event);
  gdk_event_free (event);
259
}