Pileus Git - ~andy/gtk/blob - gtk/gtkoffscreenwindow.c

   1 /*
   2  * This library is free software; you can redistribute it and/or
   3  * modify it under the terms of the GNU Lesser General Public
   4  * License as published by the Free Software Foundation; either
   5  * version 2 of the License, or (at your option) any later version.
   6  *
   7  * This library is distributed in the hope that it will be useful,
   8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10  * Lesser General Public License for more details.
  11  *
  12  * You should have received a copy of the GNU Lesser General Public
  13  * License along with this library; if not, write to the
  14  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  15  * Boston, MA 02111-1307, USA.
  16  *
  17  * Authors: Cody Russell <crussell@canonical.com>
  18  *          Alexander Larsson <alexl@redhat.com>
  19  */
  20
  21 #include "config.h"
  22
  23 #include "gtkoffscreenwindow.h"
  24 #include "gtkwidgetprivate.h"
  25 #include "gtkprivate.h"
  26
  27 /**
  28  * SECTION:gtkoffscreenwindow
  29  * @short_description: A toplevel to manage offscreen rendering of child widgets
  30  * @title: GtkOffscreenWindow
  31  *
  32  * GtkOffscreenWindow is strictly intended to be used for obtaining
  33  * snapshots of widgets that are not part of a normal widget hierarchy.
  34  * Since #GtkOffscreenWindow is a toplevel widget you cannot obtain
  35  * snapshots of a full window with it since you cannot pack a toplevel
  36  * widget in another toplevel.
  37  *
  38  * The idea is to take a widget and manually set the state of it,
  39  * add it to a GtkOffscreenWindow and then retrieve the snapshot
  40  * as a #cairo_surface_t or #GdkPixbuf.
  41  *
  42  * GtkOffscreenWindow derives from #GtkWindow only as an implementation
  43  * detail.  Applications should not use any API specific to #GtkWindow
  44  * to operate on this object.  It should be treated as a #GtkBin that
  45  * has no parent widget.
  46  *
  47  * When contained offscreen widgets are redrawn, GtkOffscreenWindow
  48  * will emit a #GtkWidget::damage-event signal.
  49  */
  50
  51 G_DEFINE_TYPE (GtkOffscreenWindow, gtk_offscreen_window, GTK_TYPE_WINDOW);
  52
  53 static void
  54 gtk_offscreen_window_get_preferred_width (GtkWidget *widget,
  55                                           gint      *minimum,
  56                                           gint      *natural)
  57 {
  58   GtkBin *bin = GTK_BIN (widget);
  59   GtkWidget *child;
  60   gint border_width;
  61   gint default_width;
  62
  63   border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
  64
  65   *minimum = border_width * 2;
  66   *natural = border_width * 2;
  67
  68   child = gtk_bin_get_child (bin);
  69
  70   if (child != NULL && gtk_widget_get_visible (child))
  71     {
  72       gint child_min, child_nat;
  73
  74       gtk_widget_get_preferred_width (child, &child_min, &child_nat);
  75
  76       *minimum += child_min;
  77       *natural += child_nat;
  78     }
  79
  80   gtk_window_get_default_size (GTK_WINDOW (widget),
  81                                &default_width, NULL);
  82
  83   *minimum = MAX (*minimum, default_width);
  84   *natural = MAX (*natural, default_width);
  85 }
  86
  87 static void
  88 gtk_offscreen_window_get_preferred_height (GtkWidget *widget,
  89                                            gint      *minimum,
  90                                            gint      *natural)
  91 {
  92   GtkBin *bin = GTK_BIN (widget);
  93   GtkWidget *child;
  94   gint border_width;
  95   gint default_height;
  96
  97   border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
  98
  99   *minimum = border_width * 2;
 100   *natural = border_width * 2;
 101
 102   child = gtk_bin_get_child (bin);
 103
 104   if (child != NULL && gtk_widget_get_visible (child))
 105     {
 106       gint child_min, child_nat;
 107
 108       gtk_widget_get_preferred_height (child, &child_min, &child_nat);
 109
 110       *minimum += child_min;
 111       *natural += child_nat;
 112     }
 113
 114   gtk_window_get_default_size (GTK_WINDOW (widget),
 115                                NULL, &default_height);
 116
 117   *minimum = MAX (*minimum, default_height);
 118   *natural = MAX (*natural, default_height);
 119 }
 120
 121 static void
 122 gtk_offscreen_window_size_allocate (GtkWidget *widget,
 123                                     GtkAllocation *allocation)
 124 {
 125   GtkBin *bin = GTK_BIN (widget);
 126   GtkWidget *child;
 127   gint border_width;
 128
 129   gtk_widget_set_allocation (widget, allocation);
 130
 131   border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
 132
 133   if (gtk_widget_get_realized (widget))
 134     gdk_window_move_resize (gtk_widget_get_window (widget),
 135                             allocation->x,
 136                             allocation->y,
 137                             allocation->width,
 138                             allocation->height);
 139
 140   child = gtk_bin_get_child (bin);
 141
 142   if (child != NULL && gtk_widget_get_visible (child))
 143     {
 144       GtkAllocation  child_alloc;
 145
 146       child_alloc.x = border_width;
 147       child_alloc.y = border_width;
 148       child_alloc.width = allocation->width - 2 * border_width;
 149       child_alloc.height = allocation->height - 2 * border_width;
 150
 151       gtk_widget_size_allocate (child, &child_alloc);
 152     }
 153
 154   gtk_widget_queue_draw (widget);
 155 }
 156
 157 static void
 158 gtk_offscreen_window_realize (GtkWidget *widget)
 159 {
 160   GtkAllocation allocation;
 161   GtkBin *bin;
 162   GtkWidget *child;
 163   GdkWindow *window;
 164   GdkWindowAttr attributes;
 165   gint attributes_mask;
 166
 167   bin = GTK_BIN (widget);
 168
 169   gtk_widget_set_realized (widget, TRUE);
 170
 171   gtk_widget_get_allocation (widget, &allocation);
 172
 173   attributes.x = allocation.x;
 174   attributes.y = allocation.y;
 175   attributes.width = allocation.width;
 176   attributes.height = allocation.height;
 177   attributes.window_type = GDK_WINDOW_OFFSCREEN;
 178   attributes.event_mask = gtk_widget_get_events (widget) | GDK_EXPOSURE_MASK;
 179   attributes.visual = gtk_widget_get_visual (widget);
 180   attributes.wclass = GDK_INPUT_OUTPUT;
 181
 182   attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL;
 183
 184   window = gdk_window_new (gtk_widget_get_parent_window (widget),
 185                            &attributes, attributes_mask);
 186   gtk_widget_set_window (widget, window);
 187   gdk_window_set_user_data (window, widget);
 188
 189   child = gtk_bin_get_child (bin);
 190   if (child)
 191     gtk_widget_set_parent_window (child, window);
 192
 193   gtk_style_context_set_background (gtk_widget_get_style_context (widget),
 194                                     window);
 195 }
 196
 197 static void
 198 gtk_offscreen_window_resize (GtkWidget *widget)
 199 {
 200   GtkAllocation allocation = { 0, 0 };
 201   GtkRequisition requisition;
 202
 203   gtk_widget_get_preferred_size (widget, &requisition, NULL);
 204
 205   allocation.width  = requisition.width;
 206   allocation.height = requisition.height;
 207   gtk_widget_size_allocate (widget, &allocation);
 208 }
 209
 210 static void
 211 move_focus (GtkWidget       *widget,
 212             GtkDirectionType dir)
 213 {
 214   gtk_widget_child_focus (widget, dir);
 215
 216   if (!gtk_container_get_focus_child (GTK_CONTAINER (widget)))
 217     gtk_window_set_focus (GTK_WINDOW (widget), NULL);
 218 }
 219
 220 static void
 221 gtk_offscreen_window_show (GtkWidget *widget)
 222 {
 223   gboolean need_resize;
 224   GtkContainer *container;
 225
 226   _gtk_widget_set_visible_flag (widget, TRUE);
 227
 228   container = GTK_CONTAINER (widget);
 229   need_resize = _gtk_container_get_need_resize (container) || !gtk_widget_get_realized (widget);
 230   _gtk_container_set_need_resize (container, FALSE);
 231
 232   if (need_resize)
 233     gtk_offscreen_window_resize (widget);
 234
 235   gtk_widget_map (widget);
 236
 237   /* Try to make sure that we have some focused widget */
 238   if (!gtk_window_get_focus (GTK_WINDOW (widget)))
 239     move_focus (widget, GTK_DIR_TAB_FORWARD);
 240 }
 241
 242 static void
 243 gtk_offscreen_window_hide (GtkWidget *widget)
 244 {
 245   _gtk_widget_set_visible_flag (widget, FALSE);
 246   gtk_widget_unmap (widget);
 247 }
 248
 249 static void
 250 gtk_offscreen_window_check_resize (GtkContainer *container)
 251 {
 252   GtkWidget *widget = GTK_WIDGET (container);
 253
 254   if (gtk_widget_get_visible (widget))
 255     gtk_offscreen_window_resize (widget);
 256 }
 257
 258 static void
 259 gtk_offscreen_window_class_init (GtkOffscreenWindowClass *class)
 260 {
 261   GtkWidgetClass *widget_class;
 262   GtkContainerClass *container_class;
 263
 264   widget_class = GTK_WIDGET_CLASS (class);
 265   container_class = GTK_CONTAINER_CLASS (class);
 266
 267   widget_class->realize = gtk_offscreen_window_realize;
 268   widget_class->show = gtk_offscreen_window_show;
 269   widget_class->hide = gtk_offscreen_window_hide;
 270   widget_class->get_preferred_width = gtk_offscreen_window_get_preferred_width;
 271   widget_class->get_preferred_height = gtk_offscreen_window_get_preferred_height;
 272   widget_class->size_allocate = gtk_offscreen_window_size_allocate;
 273
 274   container_class->check_resize = gtk_offscreen_window_check_resize;
 275 }
 276
 277 static void
 278 gtk_offscreen_window_init (GtkOffscreenWindow *window)
 279 {
 280 }
 281
 282 /* --- functions --- */
 283 /**
 284  * gtk_offscreen_window_new:
 285  *
 286  * Creates a toplevel container widget that is used to retrieve
 287  * snapshots of widgets without showing them on the screen.
 288  *
 289  * Return value: A pointer to a #GtkWidget
 290  *
 291  * Since: 2.20
 292  */
 293 GtkWidget *
 294 gtk_offscreen_window_new (void)
 295 {
 296   return g_object_new (gtk_offscreen_window_get_type (), NULL);
 297 }
 298
 299 /**
 300  * gtk_offscreen_window_get_surface:
 301  * @offscreen: the #GtkOffscreenWindow contained widget.
 302  *
 303  * Retrieves a snapshot of the contained widget in the form of
 304  * a #cairo_surface_t.  If you need to keep this around over window
 305  * resizes then you should add a reference to it.
 306  *
 307  * Returns: (transfer none): A #cairo_surface_t pointer to the offscreen
 308  *     surface, or %NULL.
 309  *
 310  * Since: 2.20
 311  */
 312 cairo_surface_t *
 313 gtk_offscreen_window_get_surface (GtkOffscreenWindow *offscreen)
 314 {
 315   g_return_val_if_fail (GTK_IS_OFFSCREEN_WINDOW (offscreen), NULL);
 316
 317   return gdk_offscreen_window_get_surface (gtk_widget_get_window (GTK_WIDGET (offscreen)));
 318 }
 319
 320 /**
 321  * gtk_offscreen_window_get_pixbuf:
 322  * @offscreen: the #GtkOffscreenWindow contained widget.
 323  *
 324  * Retrieves a snapshot of the contained widget in the form of
 325  * a #GdkPixbuf.  This is a new pixbuf with a reference count of 1,
 326  * and the application should unreference it once it is no longer
 327  * needed.
 328  *
 329  * Returns: (transfer full): A #GdkPixbuf pointer, or %NULL.
 330  *
 331  * Since: 2.20
 332  */
 333 GdkPixbuf *
 334 gtk_offscreen_window_get_pixbuf (GtkOffscreenWindow *offscreen)
 335 {
 336   cairo_surface_t *surface;
 337   GdkPixbuf *pixbuf = NULL;
 338   GdkWindow *window;
 339
 340   g_return_val_if_fail (GTK_IS_OFFSCREEN_WINDOW (offscreen), NULL);
 341
 342   window = gtk_widget_get_window (GTK_WIDGET (offscreen));
 343   surface = gdk_offscreen_window_get_surface (window);
 344
 345   if (surface != NULL)
 346     {
 347       pixbuf = gdk_pixbuf_get_from_surface (surface,
 348                                             0, 0,
 349                                             gdk_window_get_width (window),
 350                                             gdk_window_get_height (window));
 351     }
 352
 353   return pixbuf;
 354 }