gdkdisplay.c 9.38 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/* GDK - The GIMP Drawing Kit
 * gdkdisplay.c
 * 
 * Copyright 2001 Sun Microsystems Inc. 
 *
 * Erwann Chenede <erwann.chenede@sun.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#include <glib.h>
25
#include "gdk.h"		/* gdk_event_send_client_message() */
26 27
#include "gdkdisplay.h"
#include "gdkinternals.h"
28
#include "gdkmarshalers.h"
29
#include "gdkscreen.h"
30

31 32 33 34 35
enum {
  CLOSED,
  LAST_SIGNAL
};

36 37
static void gdk_display_class_init (GdkDisplayClass *class);
static void gdk_display_init       (GdkDisplay      *display);
38
static void gdk_display_dispose    (GObject         *object);
39 40
static void gdk_display_finalize   (GObject         *object);

41 42
static guint signals[LAST_SIGNAL] = { 0 };

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
static GObjectClass *parent_class;

GType
gdk_display_get_type (void)
{

  static GType object_type = 0;

  if (!object_type)
    {
      static const GTypeInfo object_info = {
	sizeof (GdkDisplayClass),
	(GBaseInitFunc) NULL,
	(GBaseFinalizeFunc) NULL,
        (GClassInitFunc) gdk_display_class_init,
	NULL,			/* class_finalize */
	NULL,			/* class_data */
	sizeof (GdkDisplay),
	0,			/* n_preallocs */
	(GInstanceInitFunc) gdk_display_init
      };
      object_type = g_type_register_static (G_TYPE_OBJECT,
					    "GdkDisplay", &object_info, 0);
    }

  return object_type;
}

static void
gdk_display_class_init (GdkDisplayClass *class)
{
  GObjectClass *object_class = G_OBJECT_CLASS (class);
  
  parent_class = g_type_class_peek_parent (class);

  object_class->finalize = gdk_display_finalize;
79
  object_class->dispose = gdk_display_dispose;
80 81 82 83 84 85 86 87 88 89 90

  signals[CLOSED] =
    g_signal_new ("closed",
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GdkDisplayClass, closed),
		  NULL, NULL,
		  gdk_marshal_VOID__BOOLEAN,
		  G_TYPE_NONE,
		  1,
		  G_TYPE_BOOLEAN);
91 92 93 94 95 96 97 98 99 100 101 102 103 104
}

static void
gdk_display_init (GdkDisplay *display)
{
  _gdk_displays = g_slist_prepend (_gdk_displays, display);

  display->button_click_time[0] = display->button_click_time[1] = 0;
  display->button_window[0] = display->button_window[1] = NULL;
  display->button_number[0] = display->button_number[1] = -1;

  display->double_click_time = 250;
}

105 106 107 108
static void
gdk_display_dispose (GObject *object)
{
  GdkDisplay *display = GDK_DISPLAY_OBJECT (object);
109 110 111 112 113 114 115 116 117 118

  g_list_foreach (display->queued_events, (GFunc)gdk_event_free, NULL);
  g_list_free (display->queued_events);
  display->queued_events = NULL;
  display->queued_tail = NULL;

  _gdk_displays = g_slist_remove (_gdk_displays, object);

  if (gdk_display_get_default() == display)
    gdk_display_manager_set_default_display (gdk_display_manager_get(), NULL);
119 120
}

121 122 123 124 125 126 127 128 129 130
static void
gdk_display_finalize (GObject *object)
{
  parent_class->finalize (object);
}

/**
 * gdk_display_close:
 * @display: a #GdkDisplay
 *
131 132
 * Closes the connection windowing system for the given display,
 * and cleans up associated resources.
133 134 135 136 137
 */
void
gdk_display_close (GdkDisplay *display)
{
  g_return_if_fail (GDK_IS_DISPLAY (display));
138 139 140 141

  if (!display->closed)
    {
      display->closed = TRUE;
142 143
      
      g_signal_emit (display, signals[CLOSED], 0, FALSE);
144 145
      g_object_run_dispose (G_OBJECT (display));
      
146
      g_object_unref (display);
147
    }
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
}

/**
 * gdk_display_get_event:
 * @display: a #GdkDisplay
 * 
 * Gets the next #GdkEvent to be processed for @display, fetching events from the
 * windowing system if necessary.
 * 
 * Return value: the next #GdkEvent to be processed, or %NULL if no events
 * are pending. The returned #GdkEvent should be freed with gdk_event_free().
 **/
GdkEvent*
gdk_display_get_event (GdkDisplay *display)
{
  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
  
  _gdk_events_queue (display);
  return _gdk_event_unqueue (display);
}

/**
 * gdk_display_peek_event:
Alex Larsson's avatar
Alex Larsson committed
171
 * @display: a #GdkDisplay 
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
 * 
 * Gets a copy of the first #GdkEvent in the @display's event queue, without
 * removing the event from the queue.  (Note that this function will
 * not get more events from the windowing system.  It only checks the events
 * that have already been moved to the GDK event queue.)
 * 
 * Return value: a copy of the first #GdkEvent on the event queue, or %NULL if no
 * events are in the queue. The returned #GdkEvent should be freed with
 * gdk_event_free().
 **/
GdkEvent*
gdk_display_peek_event (GdkDisplay *display)
{
  GList *tmp_list;

  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);

  tmp_list = _gdk_event_queue_find_first (display);
  
  if (tmp_list)
    return gdk_event_copy (tmp_list->data);
  else
    return NULL;
}

/**
 * gdk_display_put_event:
 * @display: a #GdkDisplay
 * @event: a #GdkEvent.
 *
 * Appends a copy of the given event onto the front of the event
 * queue for @display.
 **/
void
gdk_display_put_event (GdkDisplay *display,
		       GdkEvent   *event)
{
  g_return_if_fail (GDK_IS_DISPLAY (display));
  g_return_if_fail (event != NULL);

  _gdk_event_queue_append (display, gdk_event_copy (event));
}
214 215 216 217 218

/**
 * gdk_pointer_ungrab:
 * @time: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no timestamp is
 *        available.
219
 *
220 221 222 223 224
 * Ungrabs the pointer, if it is grabbed by this application.
 **/
void
gdk_pointer_ungrab (guint32 time)
{
Owen Taylor's avatar
Owen Taylor committed
225
  gdk_display_pointer_ungrab (gdk_display_get_default (), time);
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
}

/**
 * gdk_pointer_is_grabbed:
 * 
 * Returns %TRUE if the pointer is currently grabbed by this application.
 *
 * Note that this does not take the inmplicit pointer grab on button
 * presses into account.

 * Return value: %TRUE if the pointer is currently grabbed by this application.* 
 **/
gboolean
gdk_pointer_is_grabbed (void)
{
Owen Taylor's avatar
Owen Taylor committed
241
  return gdk_display_pointer_is_grabbed (gdk_display_get_default ());
242 243 244 245 246 247 248 249 250 251 252 253
}

/**
 * gdk_keyboard_ungrab:
 * @time: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
 *        timestamp is available.
 * 
 * Ungrabs the keyboard, if it is grabbed by this application.
 **/
void
gdk_keyboard_ungrab (guint32 time)
{
Owen Taylor's avatar
Owen Taylor committed
254
  gdk_display_keyboard_ungrab (gdk_display_get_default (), time);
255 256 257 258 259 260 261 262 263 264
}

/**
 * gdk_beep:
 * 
 * Emits a short beep.
 **/
void
gdk_beep (void)
{
Owen Taylor's avatar
Owen Taylor committed
265
  gdk_display_beep (gdk_display_get_default ());
266 267 268 269 270
}

/**
 * gdk_event_send_client_message:
 * @event: the #GdkEvent to send, which should be a #GdkEventClient.
Owen Taylor's avatar
Owen Taylor committed
271
 * @winid:  the window to send the X ClientMessage event to.
272 273 274 275 276 277 278 279 280
 * 
 * Sends an X ClientMessage event to a given window (which must be
 * on the default #GdkDisplay.)
 * This could be used for communicating between different applications,
 * though the amount of data is limited to 20 bytes.
 * 
 * Return value: non-zero on success.
 **/
gboolean
Owen Taylor's avatar
Owen Taylor committed
281 282
gdk_event_send_client_message (GdkEvent        *event,
			       GdkNativeWindow  winid)
283 284 285
{
  g_return_val_if_fail (event != NULL, FALSE);

Owen Taylor's avatar
Owen Taylor committed
286
  return gdk_event_send_client_message_for_display (gdk_display_get_default (),
Owen Taylor's avatar
Owen Taylor committed
287
						    event, winid);
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
}

/**
 * gdk_event_send_clientmessage_toall:
 * @event: the #GdkEvent to send, which should be a #GdkEventClient.
 *
 * Sends an X ClientMessage event to all toplevel windows on the default
 * #GdkScreen.
 *
 * Toplevel windows are determined by checking for the WM_STATE property, as
 * described in the Inter-Client Communication Conventions Manual (ICCCM).
 * If no windows are found with the WM_STATE property set, the message is sent
 * to all children of the root window.
 **/
void
gdk_event_send_clientmessage_toall (GdkEvent *event)
{
  g_return_if_fail (event != NULL);

Owen Taylor's avatar
Owen Taylor committed
307
  gdk_screen_broadcast_client_message (gdk_screen_get_default (), event);
308 309
}

310 311 312 313 314 315 316 317 318 319 320
/**
 * gdk_device_get_core_pointer:
 * 
 * Returns the core pointer device for the default display.
 * 
 * Return value: the core pointer device; this is owned by the
 *   display and should not be freed.
 **/
GdkDevice *
gdk_device_get_core_pointer (void)
{
Owen Taylor's avatar
Owen Taylor committed
321
  return gdk_display_get_core_pointer (gdk_display_get_default ());
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
}

/**
 * gdk_display_get_core_pointer:
 * @display: a #GdkDisplay
 * 
 * Returns the core pointer device for the given display
 * 
 * Return value: the core pointer device; this is owned by the
 *   display and should not be freed.
 **/
GdkDevice *
gdk_display_get_core_pointer (GdkDisplay *display)
{
  return display->core_pointer;
}
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358

/**
 * gdk_set_sm_client_id:
 * @sm_client_id: the client id assigned by the session manager when the
 *    connection was opened, or %NULL to remove the property.
 * 
 * Sets the <literal>SM_CLIENT_ID</literal> property on the application's leader window so that
 * the window manager can save the application's state using the X11R6 ICCCM
 * session management protocol.
 *
 * See the X Session Management Library documentation for more information on
 * session management and the Inter-Client Communication Conventions Manual
 * (ICCCM) for information on the <literal>WM_CLIENT_LEADER</literal> property. 
 * (Both documents are part of the X Window System distribution.)
 **/
void
gdk_set_sm_client_id (const gchar* sm_client_id)
{
  gdk_display_set_sm_client_id (gdk_display_get_default (), sm_client_id);
}