common/xembed.h

   1 /*
   2  * common/xembed.h - XEMBED functions header
   3  *
   4  * Copyright © 2007-2008 Julien Danjou <julien@danjou.info>
   5  * Copyright © 2004 Matthew Reppert
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  */
  22
  23 #ifndef AWESOME_COMMON_XEMBED_H
  24 #define AWESOME_COMMON_XEMBED_H
  25
  26 #include <xcb/xcb.h>
  27
  28 #include <stdbool.h>
  29
  30 #include "common/array.h"
  31 #include "common/util.h"
  32
  33 /** XEMBED information for a window.
  34  */
  35 typedef struct
  36 {
  37     unsigned long version;
  38     unsigned long flags;
  39 } xembed_info_t;
  40
  41 typedef struct xembed_window xembed_window_t;
  42 struct xembed_window
  43 {
  44     xcb_window_t win;
  45     int phys_screen;
  46     xembed_info_t info;
  47 };
  48
  49 DO_ARRAY(xembed_window_t, xembed_window, DO_NOTHING)
  50
  51 /** The version of the XEMBED protocol that this library supports.  */
  52 #define XEMBED_VERSION  0
  53
  54 /** Flags for _XEMBED_INFO */
  55 #define XEMBED_MAPPED                  (1 << 0)
  56 #define XEMBED_INFO_FLAGS_ALL          1
  57
  58 /** XEMBED messages */
  59 #define XEMBED_EMBEDDED_NOTIFY          0
  60 #define XEMBED_WINDOW_ACTIVATE          1
  61 #define XEMBED_WINDOW_DEACTIVATE        2
  62 #define XEMBED_REQUEST_FOCUS            3
  63 #define XEMBED_FOCUS_IN                 4
  64 #define XEMBED_FOCUS_OUT                5
  65 #define XEMBED_FOCUS_NEXT               6
  66 #define XEMBED_FOCUS_PREV               7
  67 /* 8-9 were used for XEMBED_GRAB_KEY/XEMBED_UNGRAB_KEY */
  68 #define XEMBED_MODALITY_ON              10
  69 #define XEMBED_MODALITY_OFF             11
  70 #define XEMBED_REGISTER_ACCELERATOR     12
  71 #define XEMBED_UNREGISTER_ACCELERATOR   13
  72 #define XEMBED_ACTIVATE_ACCELERATOR     14
  73
  74 /** Details for XEMBED_FOCUS_IN */
  75 #define XEMBED_FOCUS_CURRENT            0
  76 #define XEMBED_FOCUS_FIRST              1
  77 #define XEMBED_FOCUS_LAST               2
  78
  79
  80 /** Modifiers field for XEMBED_REGISTER_ACCELERATOR */
  81 #define XEMBED_MODIFIER_SHIFT   (1 << 0)
  82 #define XEMBED_MODIFIER_CONTROL (1 << 1)
  83 #define XEMBED_MODIFIER_ALT     (1 << 2)
  84 #define XEMBED_MODIFIER_SUPER   (1 << 3)
  85 #define XEMBED_MODIFIER_HYPER   (1 << 4)
  86
  87
  88 /** Flags for XEMBED_ACTIVATE_ACCELERATOR */
  89 #define XEMBED_ACCELERATOR_OVERLOADED   (1 << 0)
  90
  91
  92 void xembed_message_send(xcb_connection_t *, xcb_window_t, long, long, long, long);
  93 xembed_window_t * xembed_getbywin(xembed_window_array_t *, xcb_window_t);
  94 void xembed_property_update(xcb_connection_t *, xembed_window_t *, xcb_get_property_reply_t *);
  95 xcb_get_property_cookie_t xembed_info_get_unchecked(xcb_connection_t *,
  96                                                     xcb_window_t);
  97 bool xembed_info_get_reply(xcb_connection_t *connection,
  98                            xcb_get_property_cookie_t cookie,
  99                            xembed_info_t *info);
 100
 101
 102 /** Indicate to an embedded window that it has focus.
 103  * \param c The X connection.
 104  * \param client The client.
 105  * \param focus_type The type of focus.
 106  */
 107 static inline void
 108 xembed_focus_in(xcb_connection_t *c, xcb_window_t client, long focus_type)
 109 {
 110     xembed_message_send(c, client, XEMBED_FOCUS_IN, focus_type, 0, 0);
 111 }
 112
 113 /** Notify a window that it has become active.
 114  * \param c The X connection.
 115  * \param client The window to notify.
 116  */
 117 static inline void
 118 xembed_window_activate(xcb_connection_t *c, xcb_window_t client)
 119 {
 120     xembed_message_send(c, client, XEMBED_WINDOW_ACTIVATE, 0, 0, 0);
 121 }
 122
 123 /** Notify a window that it has become inactive.
 124  * \param c The X connection.
 125  * \param client The window to notify.
 126  */
 127 static inline
 128 void xembed_window_deactivate(xcb_connection_t *c, xcb_window_t client)
 129 {
 130     xembed_message_send(c, client, XEMBED_WINDOW_DEACTIVATE, 0, 0, 0);
 131 }
 132
 133 /** Notify a window that its embed request has been received and accepted.
 134  * \param c The X connection.
 135  * \param client The client to send message to.
 136  * \param embedder The embedder window.
 137  * \param version The version.
 138  */
 139 static inline void
 140 xembed_embedded_notify(xcb_connection_t *c,
 141                        xcb_window_t client, xcb_window_t embedder,
 142                        long version)
 143 {
 144     xembed_message_send(c, client, XEMBED_EMBEDDED_NOTIFY, 0, embedder, version);
 145 }
 146
 147 /** Have the embedder end XEMBED protocol communication with a child.
 148  * \param connection The X connection.
 149  * \param child The window to unembed.
 150  * \param root The root window to reparent to.
 151  */
 152 static inline void
 153 xembed_window_unembed(xcb_connection_t *connection, xcb_window_t child, xcb_window_t root)
 154 {
 155     xcb_reparent_window(connection, child, root, 0, 0);
 156 }
 157
 158 /** Indicate to an embedded window that it has lost focus.
 159  * \param c The X connection.
 160  * \param client The client to send message to.
 161  */
 162 static inline void
 163 xembed_focus_out(xcb_connection_t *c, xcb_window_t client)
 164 {
 165     xembed_message_send(c, client, XEMBED_FOCUS_OUT, 0, 0, 0);
 166 }
 167
 168
 169 #endif
 170 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80