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

   1 /* GTK - The GIMP Toolkit
   2  * gtkxembed.c: Utilities for the XEMBED protocol
   3  * Copyright (C) 2001, 2003, Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #include "config.h"
  22 #include <string.h>
  23 #include "gtkmain.h"
  24 #include "gtkprivate.h"
  25 #include "gtkxembed.h"
  26 #include "gtkalias.h"
  27
  28 typedef struct _GtkXEmbedMessage GtkXEmbedMessage;
  29
  30 struct _GtkXEmbedMessage
  31 {
  32   glong      message;
  33   glong      detail;
  34   glong      data1;
  35   glong      data2;
  36   guint32    time;
  37 };
  38
  39 static GSList *current_messages;
  40
  41
  42 /**
  43  * _gtk_xembed_push_message:
  44  * @xevent: a XEvent
  45  *
  46  * Adds a client message to the stack of current XEMBED events.
  47  **/
  48 void
  49 _gtk_xembed_push_message (XEvent *xevent)
  50 {
  51   GtkXEmbedMessage *message = g_slice_new (GtkXEmbedMessage);
  52
  53   message->time = xevent->xclient.data.l[0];
  54   message->message = xevent->xclient.data.l[1];
  55   message->detail = xevent->xclient.data.l[2];
  56   message->data1 = xevent->xclient.data.l[3];
  57   message->data2 = xevent->xclient.data.l[4];
  58
  59   current_messages = g_slist_prepend (current_messages, message);
  60 }
  61
  62 /**
  63  * _gtk_xembed_pop_message:
  64  *
  65  * Removes an event added with _gtk_xembed_push_message()
  66  **/
  67 void
  68 _gtk_xembed_pop_message (void)
  69 {
  70   GtkXEmbedMessage *message = current_messages->data;
  71   current_messages = g_slist_delete_link (current_messages, current_messages);
  72   g_slice_free (GtkXEmbedMessage, message);
  73 }
  74
  75 /**
  76  * _gtk_xembed_set_focus_wrapped:
  77  *
  78  * Sets a flag indicating that the current focus sequence wrapped
  79  * around to the beginning of the ultimate toplevel.
  80  **/
  81 void
  82 _gtk_xembed_set_focus_wrapped (void)
  83 {
  84   GtkXEmbedMessage *message;
  85
  86   g_return_if_fail (current_messages != NULL);
  87   message = current_messages->data;
  88   g_return_if_fail (message->message == XEMBED_FOCUS_PREV || message->message == XEMBED_FOCUS_NEXT);
  89
  90   message->data1 |= XEMBED_FOCUS_WRAPAROUND;
  91 }
  92
  93 /**
  94  * _gtk_xembed_get_focus_wrapped:
  95  *
  96  * Gets whether the current focus sequence has wrapped around
  97  * to the beginning of the ultimate toplevel.
  98  *
  99  * Return value: %TRUE if the focus sequence has wrapped around.
 100  **/
 101 gboolean
 102 _gtk_xembed_get_focus_wrapped (void)
 103 {
 104   GtkXEmbedMessage *message;
 105
 106   g_return_val_if_fail (current_messages != NULL, FALSE);
 107   message = current_messages->data;
 108
 109   return (message->data1 & XEMBED_FOCUS_WRAPAROUND) != 0;
 110 }
 111
 112 static guint32
 113 gtk_xembed_get_time (void)
 114 {
 115   if (current_messages)
 116     {
 117       GtkXEmbedMessage *message = current_messages->data;
 118       return message->time;
 119     }
 120   else
 121     return gtk_get_current_event_time ();
 122 }
 123
 124 /**
 125  * _gtk_xembed_send_message:
 126  * @recipient: window to which to send the window, or %NULL
 127  *             in which case nothing will be sent
 128  * @message:   type of message
 129  * @detail:    detail field of message
 130  * @data1:     data1 field of message
 131  * @data2:     data2 field of message
 132  *
 133  * Sends a generic XEMBED message to a particular window.
 134  **/
 135 void
 136 _gtk_xembed_send_message (GdkWindow        *recipient,
 137                           XEmbedMessageType message,
 138                           glong             detail,
 139                           glong             data1,
 140                           glong             data2)
 141 {
 142   GdkDisplay *display;
 143   XClientMessageEvent xclient;
 144
 145   if (!recipient)
 146     return;
 147
 148   g_return_if_fail (GDK_IS_WINDOW (recipient));
 149
 150   display = gdk_drawable_get_display (recipient);
 151   GTK_NOTE (PLUGSOCKET,
 152             g_message ("Sending %s", _gtk_xembed_message_name (message)));
 153
 154   memset (&xclient, 0, sizeof (xclient));
 155   xclient.window = GDK_WINDOW_XWINDOW (recipient);
 156   xclient.type = ClientMessage;
 157   xclient.message_type = gdk_x11_get_xatom_by_name_for_display (display, "_XEMBED");
 158   xclient.format = 32;
 159   xclient.data.l[0] = gtk_xembed_get_time ();
 160   xclient.data.l[1] = message;
 161   xclient.data.l[2] = detail;
 162   xclient.data.l[3] = data1;
 163   xclient.data.l[4] = data2;
 164
 165   gdk_error_trap_push ();
 166   XSendEvent (GDK_WINDOW_XDISPLAY(recipient),
 167               GDK_WINDOW_XWINDOW (recipient),
 168               False, NoEventMask, (XEvent *)&xclient);
 169   gdk_display_sync (display);
 170   gdk_error_trap_pop ();
 171 }
 172
 173 /**
 174  * _gtk_xembed_send_focus_message:
 175  * @recipient: window to which to send the window, or %NULL
 176  *             in which case nothing will be sent
 177  * @message:   type of message
 178  * @detail:    detail field of message
 179  *
 180  * Sends a XEMBED message for moving the focus along the focus
 181  * chain to a window. The flags field that these messages share
 182  * will be correctly filled in.
 183  **/
 184 void
 185 _gtk_xembed_send_focus_message (GdkWindow        *recipient,
 186                                 XEmbedMessageType message,
 187                                 glong             detail)
 188 {
 189   gulong flags = 0;
 190
 191   if (!recipient)
 192     return;
 193
 194   g_return_if_fail (GDK_IS_WINDOW (recipient));
 195   g_return_if_fail (message == XEMBED_FOCUS_IN ||
 196                     message == XEMBED_FOCUS_NEXT ||
 197                     message == XEMBED_FOCUS_PREV);
 198
 199   if (current_messages)
 200     {
 201       GtkXEmbedMessage *message = current_messages->data;
 202       switch (message->message)
 203         {
 204         case XEMBED_FOCUS_IN:
 205         case XEMBED_FOCUS_NEXT:
 206         case XEMBED_FOCUS_PREV:
 207           flags = message->data1 & XEMBED_FOCUS_WRAPAROUND;
 208           break;
 209         default:
 210           break;
 211         }
 212     }
 213
 214   _gtk_xembed_send_message (recipient, message, detail, flags, 0);
 215 }
 216
 217 const char *
 218 _gtk_xembed_message_name (XEmbedMessageType message)
 219 {
 220   static char unk[24];
 221
 222   switch (message)
 223     {
 224 #define CASE(x) case XEMBED_##x: return "XEMBED_"#x
 225       CASE (EMBEDDED_NOTIFY);
 226       CASE (WINDOW_ACTIVATE);
 227       CASE (WINDOW_DEACTIVATE);
 228       CASE (REQUEST_FOCUS);
 229       CASE (FOCUS_IN);
 230       CASE (FOCUS_OUT);
 231       CASE (FOCUS_NEXT);
 232       CASE (FOCUS_PREV);
 233       CASE (GRAB_KEY);
 234       CASE (UNGRAB_KEY);
 235       CASE (MODALITY_ON);
 236       CASE (MODALITY_OFF);
 237       CASE (GTK_GRAB_KEY);
 238       CASE (GTK_UNGRAB_KEY);
 239 #undef CASE
 240     default:
 241       snprintf (unk, 24, "UNKNOWN(%d)", message);
 242       return unk;
 243     }
 244 }