2 // Copyright (c) 2002 - 2002 Ben Janens (ben at orodu.net)
4 // Permission is hereby granted, free of charge, to any person obtaining a
5 // copy of this software and associated documentation files (the "Software"),
6 // to deal in the Software without restriction, including without limitation
7 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 // and/or sell copies of the Software, and to permit persons to whom the
9 // Software is furnished to do so, subject to the following conditions:
11 // The above copyright notice and this permission notice shall be included in
12 // all copies or substantial portions of the Software.
14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20 // DEALINGS IN THE SOFTWARE.
26 #include <X11/Xatom.h>
63 blackbox_change_attributes,
66 // blackbox-protocol atoms (wm -> client)
67 blackbox_structure_messages,
68 blackbox_notify_startup,
69 blackbox_notify_window_add,
70 blackbox_notify_window_del,
71 blackbox_notify_window_focus,
72 blackbox_notify_current_workspace,
73 blackbox_notify_workspace_count,
74 blackbox_notify_window_raise,
75 blackbox_notify_window_lower,
76 // blackbox-protocol atoms (client -> wm)
77 blackbox_change_workspace,
78 blackbox_change_window_focus,
79 blackbox_cycle_window_focus,
81 openbox_show_root_menu,
82 openbox_show_workspace_menu,
85 // root window properties
88 net_client_list_stacking,
89 net_number_of_desktops,
96 net_supporting_wm_check,
98 // root window messages
101 // application window properties
106 net_wm_visible_icon_name,
111 // net_wm_icon_geometry,
114 // net_wm_handled_icons,
115 net_wm_allowed_actions,
116 // application protocols
119 net_wm_window_type_desktop,
120 net_wm_window_type_dock,
121 net_wm_window_type_toolbar,
122 net_wm_window_type_menu,
123 net_wm_window_type_utility,
124 net_wm_window_type_splash,
125 net_wm_window_type_dialog,
126 net_wm_window_type_normal,
128 net_wm_moveresize_size_topleft,
129 net_wm_moveresize_size_topright,
130 net_wm_moveresize_size_bottomleft,
131 net_wm_moveresize_size_bottomright,
132 net_wm_moveresize_move,
135 net_wm_action_resize,
137 net_wm_action_maximize_horz,
138 net_wm_action_maximize_vert,
139 net_wm_action_change_desktop,
143 net_wm_state_maximized_vert,
144 net_wm_state_maximized_horz,
146 net_wm_state_skip_taskbar,
147 net_wm_state_skip_pager,
149 net_wm_state_fullscreen,
151 kde_net_system_tray_windows,
152 kde_net_wm_system_tray_window_for,
153 kde_net_wm_window_type_override,
155 // constant for how many atoms exist in the enumerator
166 typedef std::vector<Window> SupportWindows;
169 // windows used to specify support for NETWM
170 SupportWindows _support_windows;
171 Atom _atoms[NUM_ATOMS];
173 Atom create(const char *name) const;
175 void setValue(Window win, Atom atom, Atom type, unsigned char *data,
176 int size, int nelements, bool append) const;
177 bool getValue(Window win, Atom atom, Atom type,
178 unsigned long &nelements, unsigned char **value,
182 XAtom(const XAtom &);
183 XAtom& operator=(const XAtom&);
186 typedef std::vector<std::string> StringVect;
191 // setup support on a screen, each screen should call this once in its
193 void setSupported(const ScreenInfo *screen);
195 void setValue(Window win, Atoms atom, Atoms type, unsigned long value) const;
196 void setValue(Window win, Atoms atom, Atoms type,
197 unsigned long value[], int elements) const;
198 void setValue(Window win, Atoms atom, StringType type,
199 const std::string &value) const;
200 void setValue(Window win, Atoms atom, StringType type,
201 const StringVect &strings) const;
203 // the 'value' is allocated inside the function and
204 // delete [] value needs to be called when you are done with it.
205 // the 'value' array returned is null terminated, and has 'nelements'
206 // elements in it plus the null.
207 // nelements must be set to the maximum number of elements to read from
209 bool getValue(Window win, Atoms atom, Atoms type,
210 unsigned long &nelements, unsigned long **value) const;
211 bool getValue(Window win, Atoms atom, Atoms type, unsigned long &value) const;
212 bool getValue(Window win, Atoms atom, StringType type,
213 std::string &value) const;
214 bool getValue(Window win, Atoms atom, StringType type,
215 unsigned long &nelements, StringVect &strings) const;
217 void eraseValue(Window win, Atoms atom) const;
219 // sends a client message a window
220 void sendClientMessage(Window target, Atoms type, Window about,
221 long data = 0, long data1 = 0, long data2 = 0,
222 long data3 = 0, long data4 = 0) const;
224 // temporary function!! remove when not used in blackbox.hh anymore!!
225 inline Atom getAtom(Atoms a)
226 { assert(a >= 0 && a < NUM_ATOMS); Atom ret = _atoms[a];
227 assert(ret != 0); return ret; }