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 motif_wm_hints;
  54
  55     /* SM atoms */
  56     Atom sm_client_id;
  57
  58     /* NETWM atoms */
  59
  60     Atom net_wm_full_placement;
  61
  62     /* root window properties */
  63     Atom net_supported;
  64     Atom net_client_list;
  65     Atom net_client_list_stacking;
  66     Atom net_number_of_desktops;
  67     Atom net_desktop_geometry;
  68     Atom net_desktop_viewport;
  69     Atom net_current_desktop;
  70     Atom net_desktop_names;
  71     Atom net_active_window;
  72     Atom net_workarea;
  73     Atom net_supporting_wm_check;
  74     Atom net_desktop_layout;
  75     Atom net_showing_desktop;
  76     /* root window messages */
  77     Atom net_close_window;
  78     Atom net_wm_moveresize;
  79     Atom net_moveresize_window;
  80
  81     /* startup-notification extension */
  82     Atom net_startup_id;
  83
  84     /* application window properties */
  85     Atom net_wm_name;
  86     Atom net_wm_visible_name;
  87     Atom net_wm_icon_name;
  88     Atom net_wm_visible_icon_name;
  89     Atom net_wm_desktop;
  90     Atom net_wm_window_type;
  91     Atom net_wm_state;
  92     Atom net_wm_strut;
  93     Atom net_wm_strut_partial;
  94     Atom net_wm_icon;
  95 /*  Atom net_wm_pid; */
  96     Atom net_wm_allowed_actions;
  97     Atom net_wm_user_time;
  98     Atom net_frame_extents;
  99
 100     /* application protocols */
 101 /*  Atom   Atom net_wm_ping; */
 102
 103     Atom net_wm_window_type_desktop;
 104     Atom net_wm_window_type_dock;
 105     Atom net_wm_window_type_toolbar;
 106     Atom net_wm_window_type_menu;
 107     Atom net_wm_window_type_utility;
 108     Atom net_wm_window_type_splash;
 109     Atom net_wm_window_type_dialog;
 110     Atom net_wm_window_type_normal;
 111
 112     Atom net_wm_moveresize_size_topleft;
 113     Atom net_wm_moveresize_size_top;
 114     Atom net_wm_moveresize_size_topright;
 115     Atom net_wm_moveresize_size_right;
 116     Atom net_wm_moveresize_size_bottomright;
 117     Atom net_wm_moveresize_size_bottom;
 118     Atom net_wm_moveresize_size_bottomleft;
 119     Atom net_wm_moveresize_size_left;
 120     Atom net_wm_moveresize_move;
 121     Atom net_wm_moveresize_size_keyboard;
 122     Atom net_wm_moveresize_move_keyboard;
 123     Atom net_wm_moveresize_cancel;
 124
 125     Atom net_wm_action_move;
 126     Atom net_wm_action_resize;
 127     Atom net_wm_action_minimize;
 128     Atom net_wm_action_shade;
 129     Atom net_wm_action_stick;
 130     Atom net_wm_action_maximize_horz;
 131     Atom net_wm_action_maximize_vert;
 132     Atom net_wm_action_fullscreen;
 133     Atom net_wm_action_change_desktop;
 134     Atom net_wm_action_close;
 135
 136     Atom net_wm_state_modal;
 137     Atom net_wm_state_sticky;
 138     Atom net_wm_state_maximized_vert;
 139     Atom net_wm_state_maximized_horz;
 140     Atom net_wm_state_shaded;
 141     Atom net_wm_state_skip_taskbar;
 142     Atom net_wm_state_skip_pager;
 143     Atom net_wm_state_hidden;
 144     Atom net_wm_state_fullscreen;
 145     Atom net_wm_state_above;
 146     Atom net_wm_state_below;
 147     Atom net_wm_state_demands_attention;
 148
 149     Atom net_wm_state_add;
 150     Atom net_wm_state_remove;
 151     Atom net_wm_state_toggle;
 152
 153     Atom net_wm_orientation_horz;
 154     Atom net_wm_orientation_vert;
 155     Atom net_wm_topleft;
 156     Atom net_wm_topright;
 157     Atom net_wm_bottomright;
 158     Atom net_wm_bottomleft;
 159
 160     /* Extra atoms */
 161
 162     Atom kde_wm_change_state;
 163     Atom kde_net_wm_window_type_override;
 164
 165     Atom rootpmapid;
 166     Atom esetrootid;
 167
 168     /* Openbox specific atoms */
 169
 170     Atom openbox_pid;
 171     Atom openbox_rc;
 172     Atom ob_wm_state_undecorated;
 173     Atom ob_control;
 174 } Atoms;
 175 Atoms prop_atoms;
 176
 177 void prop_startup();
 178
 179 gboolean prop_get32(Window win, Atom prop, Atom type, guint32 *ret);
 180 gboolean prop_get_array32(Window win, Atom prop, Atom type, guint32 **ret,
 181                           guint *nret);
 182 gboolean prop_get_string_locale(Window win, Atom prop, gchar **ret);
 183 gboolean prop_get_string_utf8(Window win, Atom prop, gchar **ret);
 184 gboolean prop_get_strings_locale(Window win, Atom prop, gchar ***ret);
 185 gboolean prop_get_strings_utf8(Window win, Atom prop, gchar ***ret);
 186
 187 void prop_set32(Window win, Atom prop, Atom type, gulong val);
 188 void prop_set_array32(Window win, Atom prop, Atom type, gulong *val,
 189                       guint num);
 190 void prop_set_string_utf8(Window win, Atom prop, const gchar *val);
 191 void prop_set_strings_utf8(Window win, Atom prop, gchar **strs);
 192
 193 void prop_erase(Window win, Atom prop);
 194
 195 void prop_message(Window about, Atom messagetype, glong data0, glong data1,
 196                   glong data2, glong data3, glong mask);
 197
 198 #define PROP_GET32(win, prop, type, ret) \
 199     (prop_get32(win, prop_atoms.prop, prop_atoms.type, ret))
 200 #define PROP_GETA32(win, prop, type, ret, nret) \
 201     (prop_get_array32(win, prop_atoms.prop, prop_atoms.type, ret, \
 202                       nret))
 203 #define PROP_GETS(win, prop, type, ret) \
 204     (prop_get_string_##type(win, prop_atoms.prop, ret))
 205 #define PROP_GETSS(win, prop, type, ret) \
 206     (prop_get_strings_##type(win, prop_atoms.prop, ret))
 207
 208 #define PROP_SET32(win, prop, type, val) \
 209     prop_set32(win, prop_atoms.prop, prop_atoms.type, val)
 210 #define PROP_SETA32(win, prop, type, val, num) \
 211     prop_set_array32(win, prop_atoms.prop, prop_atoms.type, val, num)
 212 #define PROP_SETS(win, prop, val) \
 213     prop_set_string_utf8(win, prop_atoms.prop, val)
 214 #define PROP_SETSS(win, prop, strs) \
 215     prop_set_strings_utf8(win, prop_atoms.prop, strs)
 216
 217 #define PROP_ERASE(win, prop) prop_erase(win, prop_atoms.prop)
 218
 219 #define PROP_MSG(about, msgtype, data0, data1, data2, data3) \
 220   (prop_message(about, prop_atoms.msgtype, data0, data1, data2, data3, \
 221                 SubstructureNotifyMask | SubstructureRedirectMask))
 222
 223 #endif