gtkinvisible.c 9.04 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Owen Taylor's avatar
Owen Taylor 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
Owen Taylor's avatar
Owen Taylor 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.
Owen Taylor's avatar
Owen Taylor committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
Javier Jardon's avatar
Javier Jardon committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Owen Taylor's avatar
Owen Taylor committed
16
 */
17 18

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

25
#include "config.h"
26
#include <gdk/gdk.h>
Owen Taylor's avatar
Owen Taylor committed
27
#include "gtkinvisible.h"
Emmanuele Bassi's avatar
Emmanuele Bassi committed
28
#include "gtkwidgetprivate.h"
29
#include "gtkprivate.h"
30 31
#include "gtkintl.h"

32 33 34 35 36 37 38 39 40 41 42 43 44 45

/**
 * SECTION:gtkinvisible
 * @Short_description: A widget which is not displayed
 * @Title: GtkInvisible
 *
 * The #GtkInvisible widget is used internally in GTK+, and is probably not
 * very useful for application developers.
 *
 * It is used for reliable pointer grabs and selection handling in the code
 * for drag-and-drop.
 */


46
struct _GtkInvisiblePrivate
47 48 49 50 51
{
  GdkScreen    *screen;
  gboolean      has_user_ref_count;
};

52 53 54 55 56
enum {
  PROP_0,
  PROP_SCREEN,
  LAST_ARG
};
Owen Taylor's avatar
Owen Taylor committed
57

58
static void gtk_invisible_destroy       (GtkWidget         *widget);
59
static void gtk_invisible_realize       (GtkWidget         *widget);
60
static void gtk_invisible_style_updated (GtkWidget         *widget);
61 62 63
static void gtk_invisible_show          (GtkWidget         *widget);
static void gtk_invisible_size_allocate (GtkWidget         *widget,
					 GtkAllocation     *allocation);
64 65 66 67 68 69 70 71 72 73 74 75 76
static void gtk_invisible_set_property  (GObject           *object,
					 guint              prop_id,
					 const GValue      *value,
					 GParamSpec        *pspec);
static void gtk_invisible_get_property  (GObject           *object,
					 guint              prop_id,
					 GValue		   *value,
					 GParamSpec        *pspec);

static GObject *gtk_invisible_constructor (GType                  type,
					   guint                  n_construct_properties,
					   GObjectConstructParam *construct_params);

Matthias Clasen's avatar
Matthias Clasen committed
77
G_DEFINE_TYPE (GtkInvisible, gtk_invisible, GTK_TYPE_WIDGET)
Owen Taylor's avatar
Owen Taylor committed
78 79 80 81

static void
gtk_invisible_class_init (GtkInvisibleClass *class)
{
82
  GObjectClass	 *gobject_class;
Owen Taylor's avatar
Owen Taylor committed
83 84 85
  GtkWidgetClass *widget_class;

  widget_class = (GtkWidgetClass*) class;
86 87
  gobject_class = (GObjectClass*) class;

Owen Taylor's avatar
Owen Taylor committed
88
  widget_class->realize = gtk_invisible_realize;
89
  widget_class->style_updated = gtk_invisible_style_updated;
Owen Taylor's avatar
Owen Taylor committed
90 91
  widget_class->show = gtk_invisible_show;
  widget_class->size_allocate = gtk_invisible_size_allocate;
92
  widget_class->destroy = gtk_invisible_destroy;
93

94 95 96 97 98 99 100
  gobject_class->set_property = gtk_invisible_set_property;
  gobject_class->get_property = gtk_invisible_get_property;
  gobject_class->constructor = gtk_invisible_constructor;

  g_object_class_install_property (gobject_class,
				   PROP_SCREEN,
				   g_param_spec_object ("screen",
101 102
 							P_("Screen"),
 							P_("The screen where this window will be displayed"),
103
							GDK_TYPE_SCREEN,
104
 							GTK_PARAM_READWRITE));
105

106
  g_type_class_add_private (class, sizeof (GtkInvisiblePrivate));
Owen Taylor's avatar
Owen Taylor committed
107 108 109 110 111
}

static void
gtk_invisible_init (GtkInvisible *invisible)
{
112
  GtkInvisiblePrivate *priv;
113 114 115

  invisible->priv = G_TYPE_INSTANCE_GET_PRIVATE (invisible,
                                                 GTK_TYPE_INVISIBLE,
116
                                                 GtkInvisiblePrivate);
117 118
  priv = invisible->priv;

119
  gtk_widget_set_has_window (GTK_WIDGET (invisible), TRUE);
120
  _gtk_widget_set_is_toplevel (GTK_WIDGET (invisible), TRUE);
Owen Taylor's avatar
Owen Taylor committed
121

122
  g_object_ref_sink (invisible);
123

124 125
  priv->has_user_ref_count = TRUE;
  priv->screen = gdk_screen_get_default ();
126 127 128
}

static void
129
gtk_invisible_destroy (GtkWidget *widget)
130
{
131
  GtkInvisible *invisible = GTK_INVISIBLE (widget);
132
  GtkInvisiblePrivate *priv = invisible->priv;
133 134

  if (priv->has_user_ref_count)
135
    {
136
      priv->has_user_ref_count = FALSE;
Manish Singh's avatar
Manish Singh committed
137
      g_object_unref (invisible);
138
    }
139

140
  GTK_WIDGET_CLASS (gtk_invisible_parent_class)->destroy (widget);
Owen Taylor's avatar
Owen Taylor committed
141 142
}

143 144 145 146 147 148 149 150
/**
 * gtk_invisible_new_for_screen:
 * @screen: a #GdkScreen which identifies on which
 *	    the new #GtkInvisible will be created.
 *
 * Creates a new #GtkInvisible object for a specified screen
 *
 * Return value: a newly created #GtkInvisible object
151 152
 *
 * Since: 2.2
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
 **/
GtkWidget* 
gtk_invisible_new_for_screen (GdkScreen *screen)
{
  g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
  
  return g_object_new (GTK_TYPE_INVISIBLE, "screen", screen, NULL);
}

/**
 * gtk_invisible_new:
 * 
 * Creates a new #GtkInvisible.
 * 
 * Return value: a new #GtkInvisible.
 **/
Owen Taylor's avatar
Owen Taylor committed
169 170 171
GtkWidget*
gtk_invisible_new (void)
{
172 173
  return g_object_new (GTK_TYPE_INVISIBLE, NULL);
}
174

175 176 177 178 179 180
/**
 * gtk_invisible_set_screen:
 * @invisible: a #GtkInvisible.
 * @screen: a #GdkScreen.
 *
 * Sets the #GdkScreen where the #GtkInvisible object will be displayed.
181 182
 *
 * Since: 2.2
183 184 185 186 187
 **/ 
void
gtk_invisible_set_screen (GtkInvisible *invisible,
			  GdkScreen    *screen)
{
188
  GtkInvisiblePrivate *priv;
Owen Taylor's avatar
Owen Taylor committed
189 190
  GtkWidget *widget;
  GdkScreen *previous_screen;
191
  gboolean was_realized;
192

193 194 195
  g_return_if_fail (GTK_IS_INVISIBLE (invisible));
  g_return_if_fail (GDK_IS_SCREEN (screen));

196 197 198
  priv = invisible->priv;

  if (screen == priv->screen)
199 200
    return;

Owen Taylor's avatar
Owen Taylor committed
201 202
  widget = GTK_WIDGET (invisible);

203
  previous_screen = priv->screen;
204
  was_realized = gtk_widget_get_realized (widget);
205 206

  if (was_realized)
Owen Taylor's avatar
Owen Taylor committed
207
    gtk_widget_unrealize (widget);
208 209

  priv->screen = screen;
Owen Taylor's avatar
Owen Taylor committed
210 211
  if (screen != previous_screen)
    _gtk_widget_propagate_screen_changed (widget, previous_screen);
212 213
  g_object_notify (G_OBJECT (invisible), "screen");
  
214
  if (was_realized)
Owen Taylor's avatar
Owen Taylor committed
215
    gtk_widget_realize (widget);
216 217 218 219 220 221 222 223
}

/**
 * gtk_invisible_get_screen:
 * @invisible: a #GtkInvisible.
 *
 * Returns the #GdkScreen object associated with @invisible
 *
224
 * Return value: (transfer none): the associated #GdkScreen.
225 226
 *
 * Since: 2.2
227 228 229 230 231
 **/
GdkScreen *
gtk_invisible_get_screen (GtkInvisible *invisible)
{
  g_return_val_if_fail (GTK_IS_INVISIBLE (invisible), NULL);
232 233

  return invisible->priv->screen;
Owen Taylor's avatar
Owen Taylor committed
234 235 236 237 238
}

static void
gtk_invisible_realize (GtkWidget *widget)
{
239
  GdkWindow *parent;
240
  GdkWindow *window;
Owen Taylor's avatar
Owen Taylor committed
241 242 243
  GdkWindowAttr attributes;
  gint attributes_mask;

244
  gtk_widget_set_realized (widget, TRUE);
Owen Taylor's avatar
Owen Taylor committed
245

246 247 248 249
  parent = gtk_widget_get_parent_window (widget);
  if (parent == NULL)
    parent = gtk_widget_get_root_window (widget);

Owen Taylor's avatar
Owen Taylor committed
250 251 252 253 254 255 256 257 258 259 260
  attributes.x = -100;
  attributes.y = -100;
  attributes.width = 10;
  attributes.height = 10;
  attributes.window_type = GDK_WINDOW_TEMP;
  attributes.wclass = GDK_INPUT_ONLY;
  attributes.override_redirect = TRUE;
  attributes.event_mask = gtk_widget_get_events (widget);

  attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_NOREDIR;

261 262 263
  window = gdk_window_new (parent, &attributes, attributes_mask);
  gtk_widget_set_window (widget, window);
  gdk_window_set_user_data (window, widget);
Owen Taylor's avatar
Owen Taylor committed
264 265
}

266
static void
267
gtk_invisible_style_updated (GtkWidget *widget)
268 269 270 271
{
  /* Don't chain up to parent implementation */
}

Owen Taylor's avatar
Owen Taylor committed
272 273 274
static void
gtk_invisible_show (GtkWidget *widget)
{
275
  _gtk_widget_set_visible_flag (widget, TRUE);
Owen Taylor's avatar
Owen Taylor committed
276 277 278 279 280
  gtk_widget_map (widget);
}

static void
gtk_invisible_size_allocate (GtkWidget     *widget,
281
                             GtkAllocation *allocation)
Owen Taylor's avatar
Owen Taylor committed
282
{
283 284
  gtk_widget_set_allocation (widget, allocation);
}
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303


static void 
gtk_invisible_set_property  (GObject      *object,
			     guint         prop_id,
			     const GValue *value,
			     GParamSpec   *pspec)
{
  GtkInvisible *invisible = GTK_INVISIBLE (object);
  
  switch (prop_id)
    {
    case PROP_SCREEN:
      gtk_invisible_set_screen (invisible, g_value_get_object (value));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
Owen Taylor's avatar
Owen Taylor committed
304
}
305 306 307 308 309 310 311 312

static void 
gtk_invisible_get_property  (GObject      *object,
			     guint         prop_id,
			     GValue	  *value,
			     GParamSpec   *pspec)
{
  GtkInvisible *invisible = GTK_INVISIBLE (object);
313
  GtkInvisiblePrivate *priv = invisible->priv;
314 315 316 317

  switch (prop_id)
    {
    case PROP_SCREEN:
318
      g_value_set_object (value, priv->screen);
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

/* We use a constructor here so that we can realize the invisible on
 * the correct screen after the "screen" property has been set
 */
static GObject*
gtk_invisible_constructor (GType                  type,
			   guint                  n_construct_properties,
			   GObjectConstructParam *construct_params)
{
  GObject *object;

336 337 338
  object = G_OBJECT_CLASS (gtk_invisible_parent_class)->constructor (type,
                                                                     n_construct_properties,
                                                                     construct_params);
339 340 341 342 343

  gtk_widget_realize (GTK_WIDGET (object));

  return object;
}