openbox/prop.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    prop.h for the Openbox window manager
   4    Copyright (c) 2006        Mikael Magnusson
   5    Copyright (c) 2003-2007   Dana Jansens
   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    See the COPYING file for a copy of the GNU General Public License.
  18 */
  19
  20 #ifndef __atoms_h
  21 #define __atoms_h
  22
  23 #include <X11/Xlib.h>
  24 #include <glib.h>
  25 #ifdef HAVE_STRING_H
  26 #  include <string.h>
  27 #endif
  28
  29 /*! The atoms on the X server which this class will cache */
  30 typedef struct Atoms {
  31     /* types */
  32     Atom cardinal; /*!< The atom which represents the Cardinal data type */
  33     Atom window;   /*!< The atom which represents window ids */
  34     Atom pixmap;   /*!< The atom which represents pixmap ids */
  35     Atom atom;     /*!< The atom which represents atom values */
  36     Atom string;   /*!< The atom which represents ascii strings */
  37     Atom utf8;     /*!< The atom which represents utf8-encoded strings */
  38
  39     /* selection stuff */
  40     Atom manager;
  41
  42     /* window hints */
  43     Atom wm_colormap_windows;
  44     Atom wm_protocols;
  45     Atom wm_state;
  46     Atom wm_delete_window;
  47     Atom wm_take_focus;
  48     Atom wm_change_state;
  49     Atom wm_name;
  50     Atom wm_icon_name;
  51     Atom wm_class;
  52     Atom wm_window_role;
  53     Atom wm_client_machine;
  54     Atom wm_command;
  55     Atom wm_client_leader;
  56     Atom wm_transient_for;
  57     Atom motif_wm_hints;
  58
  59     /* SM atoms */
  60     Atom sm_client_id;
  61
  62     /* NETWM atoms */
  63
  64     /* Atoms that are used inside messages - these don't go in net_supported */
  65
  66     Atom net_wm_moveresize_size_topleft;
  67     Atom net_wm_moveresize_size_top;
  68     Atom net_wm_moveresize_size_topright;
  69     Atom net_wm_moveresize_size_right;
  70     Atom net_wm_moveresize_size_bottomright;
  71     Atom net_wm_moveresize_size_bottom;
  72     Atom net_wm_moveresize_size_bottomleft;
  73     Atom net_wm_moveresize_size_left;
  74     Atom net_wm_moveresize_move;
  75     Atom net_wm_moveresize_size_keyboard;
  76     Atom net_wm_moveresize_move_keyboard;
  77     Atom net_wm_moveresize_cancel;
  78
  79     Atom net_wm_state_add;
  80     Atom net_wm_state_remove;
  81     Atom net_wm_state_toggle;
  82
  83     Atom net_wm_orientation_horz;
  84     Atom net_wm_orientation_vert;
  85     Atom net_wm_topleft;
  86     Atom net_wm_topright;
  87     Atom net_wm_bottomright;
  88     Atom net_wm_bottomleft;
  89
  90     /* types that we use but don't support */
  91
  92     Atom net_wm_window_type_popup_menu;
  93
  94     /* Everything below here must go in net_supported on the root window */
  95
  96     /* root window properties */
  97     Atom net_supported;
  98     Atom net_client_list;
  99     Atom net_client_list_stacking;
 100     Atom net_number_of_desktops;
 101     Atom net_desktop_geometry;
 102     Atom net_desktop_viewport;
 103     Atom net_current_desktop;
 104     Atom net_desktop_names;
 105     Atom net_active_window;
 106 /*    Atom net_restack_window;*/
 107     Atom net_workarea;
 108     Atom net_supporting_wm_check;
 109     Atom net_desktop_layout;
 110     Atom net_showing_desktop;
 111
 112     /* root window messages */
 113     Atom net_close_window;
 114     Atom net_wm_moveresize;
 115     Atom net_moveresize_window;
 116     Atom net_request_frame_extents;
 117     Atom net_restack_window;
 118
 119     /* helpful hints to apps that aren't used for anything */
 120     Atom net_wm_full_placement;
 121
 122     /* startup-notification extension */
 123     Atom net_startup_id;
 124
 125     /* application window properties */
 126     Atom net_wm_name;
 127     Atom net_wm_visible_name;
 128     Atom net_wm_icon_name;
 129     Atom net_wm_visible_icon_name;
 130     Atom net_wm_desktop;
 131     Atom net_wm_window_type;
 132     Atom net_wm_state;
 133     Atom net_wm_strut;
 134     Atom net_wm_strut_partial;
 135     Atom net_wm_icon;
 136     Atom net_wm_icon_geometry;
 137     Atom net_wm_pid;
 138     Atom net_wm_allowed_actions;
 139     Atom net_wm_user_time;
 140 /*  Atom net_wm_user_time_window; */
 141     Atom net_frame_extents;
 142
 143     /* application protocols */
 144     Atom net_wm_ping;
 145 #ifdef SYNC
 146     Atom net_wm_sync_request;
 147     Atom net_wm_sync_request_counter;
 148 #endif
 149
 150     Atom net_wm_window_type_desktop;
 151     Atom net_wm_window_type_dock;
 152     Atom net_wm_window_type_toolbar;
 153     Atom net_wm_window_type_menu;
 154     Atom net_wm_window_type_utility;
 155     Atom net_wm_window_type_splash;
 156     Atom net_wm_window_type_dialog;
 157     Atom net_wm_window_type_normal;
 158
 159     Atom net_wm_action_move;
 160     Atom net_wm_action_resize;
 161     Atom net_wm_action_minimize;
 162     Atom net_wm_action_shade;
 163 /*    Atom net_wm_action_stick;*/
 164     Atom net_wm_action_maximize_horz;
 165     Atom net_wm_action_maximize_vert;
 166     Atom net_wm_action_fullscreen;
 167     Atom net_wm_action_change_desktop;
 168     Atom net_wm_action_close;
 169     Atom net_wm_action_above;
 170     Atom net_wm_action_below;
 171
 172     Atom net_wm_state_modal;
 173 /*    Atom net_wm_state_sticky;*/
 174     Atom net_wm_state_maximized_vert;
 175     Atom net_wm_state_maximized_horz;
 176     Atom net_wm_state_shaded;
 177     Atom net_wm_state_skip_taskbar;
 178     Atom net_wm_state_skip_pager;
 179     Atom net_wm_state_hidden;
 180     Atom net_wm_state_fullscreen;
 181     Atom net_wm_state_above;
 182     Atom net_wm_state_below;
 183     Atom net_wm_state_demands_attention;
 184
 185     /* KDE atoms */
 186
 187     Atom kde_wm_change_state;
 188     Atom kde_net_wm_frame_strut;
 189     Atom kde_net_wm_window_type_override;
 190
 191 /*
 192     Atom rootpmapid;
 193     Atom esetrootid;
 194 */
 195
 196     /* Openbox specific atoms */
 197
 198     Atom ob_wm_action_undecorate;
 199     Atom ob_wm_state_undecorated;
 200     Atom openbox_pid; /* this is depreecated in favour of ob_control */
 201     Atom ob_theme;
 202     Atom ob_config_file;
 203     Atom ob_control;
 204 } Atoms;
 205 extern Atoms prop_atoms;
 206
 207 void prop_startup(void);
 208
 209 gboolean prop_get32(Window win, Atom prop, Atom type, guint32 *ret);
 210 gboolean prop_get_array32(Window win, Atom prop, Atom type, guint32 **ret,
 211                           guint *nret);
 212 gboolean prop_get_string_locale(Window win, Atom prop, gchar **ret);
 213 gboolean prop_get_string_utf8(Window win, Atom prop, gchar **ret);
 214 gboolean prop_get_strings_locale(Window win, Atom prop, gchar ***ret);
 215 gboolean prop_get_strings_utf8(Window win, Atom prop, gchar ***ret);
 216
 217 void prop_set32(Window win, Atom prop, Atom type, gulong val);
 218 void prop_set_array32(Window win, Atom prop, Atom type, gulong *val,
 219                       guint num);
 220 void prop_set_string_utf8(Window win, Atom prop, const gchar *val);
 221 void prop_set_strings_utf8(Window win, Atom prop, gchar **strs);
 222
 223 void prop_erase(Window win, Atom prop);
 224
 225 void prop_message(Window about, Atom messagetype, glong data0, glong data1,
 226                   glong data2, glong data3, glong mask);
 227 void prop_message_to(Window to, Window about, Atom messagetype,
 228                      glong data0, glong data1, glong data2,
 229                      glong data3, glong data4, glong mask);
 230
 231 #define PROP_GET32(win, prop, type, ret) \
 232     (prop_get32(win, prop_atoms.prop, prop_atoms.type, ret))
 233 #define PROP_GETA32(win, prop, type, ret, nret) \
 234     (prop_get_array32(win, prop_atoms.prop, prop_atoms.type, ret, \
 235                       nret))
 236 #define PROP_GETS(win, prop, type, ret) \
 237     (prop_get_string_##type(win, prop_atoms.prop, ret))
 238 #define PROP_GETSS(win, prop, type, ret) \
 239     (prop_get_strings_##type(win, prop_atoms.prop, ret))
 240
 241 #define PROP_SET32(win, prop, type, val) \
 242     prop_set32(win, prop_atoms.prop, prop_atoms.type, val)
 243 #define PROP_SETA32(win, prop, type, val, num) \
 244     prop_set_array32(win, prop_atoms.prop, prop_atoms.type, val, num)
 245 #define PROP_SETS(win, prop, val) \
 246     prop_set_string_utf8(win, prop_atoms.prop, val)
 247 #define PROP_SETSS(win, prop, strs) \
 248     prop_set_strings_utf8(win, prop_atoms.prop, strs)
 249
 250 #define PROP_ERASE(win, prop) prop_erase(win, prop_atoms.prop)
 251
 252 #define PROP_MSG(about, msgtype, data0, data1, data2, data3) \
 253   (prop_message(about, prop_atoms.msgtype, data0, data1, data2, data3, \
 254                 SubstructureNotifyMask | SubstructureRedirectMask))
 255
 256 #define PROP_MSG_TO(to, about, msgtype, data0, data1, data2, data3, data4, \
 257                     mask) \
 258     (prop_message_to(to, about, prop_atoms.msgtype,                        \
 259                      data0, data1, data2, data3, data4, mask))
 260
 261 #endif