merge from netwm-merge2 to netwm-merge3. Basically, all of netwm that we intend to...
[mikachu/openbox.git] / src / XAtom.hh
1 // XAtom.h for Openbox
2 // Copyright (c) 2002 - 2002 Ben Janens (ben at orodu.net)
3 //
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:
10 //
11 // The above copyright notice and this permission notice shall be included in
12 // all copies or substantial portions of the Software.
13 //
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.
21
22 #ifndef   __XAtom_h
23 #define   __XAtom_h
24
25 #include <X11/Xlib.h>
26 #include <X11/Xatom.h>
27
28 #include <assert.h>
29
30 #include <vector>
31 #include <string>
32
33 class Blackbox;
34 class ScreenInfo;
35
36 class XAtom {
37 public:
38   enum Atoms {
39     // types
40     cardinal,
41     window,
42     pixmap,
43     atom,
44     string,
45     utf8_string,
46     
47 #ifdef    HAVE_GETPID
48     blackbox_pid,
49 #endif // HAVE_GETPID
50
51     // window hints
52     wm_colormap_windows,
53     wm_protocols,
54     wm_state,
55     wm_delete_window,
56     wm_take_focus,
57     wm_change_state,
58     wm_name,
59     wm_icon_name,
60     motif_wm_hints,
61     blackbox_attributes,
62     blackbox_change_attributes,
63     blackbox_hints,
64
65     // blackbox-protocol atoms (wm -> client)
66     blackbox_structure_messages,
67     blackbox_notify_startup,
68     blackbox_notify_window_add,
69     blackbox_notify_window_del,
70     blackbox_notify_window_focus,
71     blackbox_notify_current_workspace,
72     blackbox_notify_workspace_count,
73     blackbox_notify_window_raise,
74     blackbox_notify_window_lower,
75     // blackbox-protocol atoms (client -> wm)
76     blackbox_change_workspace,
77     blackbox_change_window_focus,
78     blackbox_cycle_window_focus,
79
80     // NETWM atoms
81     // root window properties
82     net_supported,
83     net_client_list,
84     net_client_list_stacking,
85     net_number_of_desktops,
86     net_desktop_geometry,
87     net_desktop_viewport,
88     net_current_desktop,
89     net_desktop_names,
90     net_active_window,
91     net_workarea,
92     net_supporting_wm_check,
93 //    net_virtual_roots,
94     // root window messages
95     net_close_window,
96     net_wm_moveresize,
97     // application window properties
98 //    net_properties,
99     net_wm_name,
100     net_wm_visible_name,
101     net_wm_icon_name,
102     net_wm_visible_icon_name,
103     net_wm_desktop,
104     net_wm_window_type,
105     net_wm_state,
106     net_wm_strut,
107 //  net_wm_icon_geometry,
108 //  net_wm_icon,
109 //  net_wm_pid,
110 //  net_wm_handled_icons,
111     net_wm_allowed_actions,
112     // application protocols
113 //    net_wm_ping,
114
115     net_wm_window_type_desktop,
116     net_wm_window_type_dock,
117     net_wm_window_type_toolbar,
118     net_wm_window_type_menu,
119     net_wm_window_type_utility,
120     net_wm_window_type_splash,
121     net_wm_window_type_dialog,
122     net_wm_window_type_normal,
123
124     net_wm_moveresize_size_topleft,
125     net_wm_moveresize_size_topright,
126     net_wm_moveresize_size_bottomleft,
127     net_wm_moveresize_size_bottomright,
128     net_wm_moveresize_move,
129
130     net_wm_action_move,
131     net_wm_action_resize,
132     net_wm_action_shade,
133     net_wm_action_maximize_horz,
134     net_wm_action_maximize_vert,
135     net_wm_action_change_desktop,
136     net_wm_action_close,
137
138     net_wm_state_modal,
139     net_wm_state_maximized_vert,
140     net_wm_state_maximized_horz,
141     net_wm_state_shaded,
142     net_wm_state_skip_taskbar,
143     net_wm_state_skip_pager,
144     net_wm_state_hidden,
145     net_wm_state_fullscreen,
146
147     kde_net_system_tray_windows,
148     kde_net_wm_system_tray_window_for,
149  
150     // constant for how many atoms exist in the enumerator
151     NUM_ATOMS
152   };
153
154   enum StringType {
155     ansi,
156     utf8,
157     NUM_STRING_TYPE
158   };
159
160 private:
161   typedef std::vector<Window> SupportWindows;
162   
163   Display              *_display;
164   // windows used to specify support for NETWM
165   SupportWindows        _support_windows;
166   Atom                  _atoms[NUM_ATOMS];
167
168   Atom create(const char *name) const;
169
170   void setValue(Window win, Atom atom, Atom type, unsigned char *data,
171                 int size, int nelements, bool append) const;
172   bool getValue(Window win, Atom atom, Atom type,
173                 unsigned long &nelements, unsigned char **value,
174                 int size) const;
175
176   // no copying!!
177   XAtom(const XAtom &);
178   XAtom& operator=(const XAtom&);
179
180 public:
181   typedef std::vector<std::string> StringVect;
182   
183   XAtom(Display *d);
184   virtual ~XAtom();
185
186   // setup support on a screen, each screen should call this once in its
187   // constructor.
188   void setSupported(const ScreenInfo *screen);
189   
190   void setValue(Window win, Atoms atom, Atoms type, unsigned long value) const;
191   void setValue(Window win, Atoms atom, Atoms type,
192                 unsigned long value[], int elements) const;
193   void setValue(Window win, Atoms atom, StringType type,
194                 const std::string &value) const;
195   void setValue(Window win, Atoms atom, StringType type,
196                 const StringVect &strings) const;
197
198   // the 'value' is allocated inside the function and
199   // delete [] value needs to be called when you are done with it.
200   // the 'value' array returned is null terminated, and has 'nelements'
201   // elements in it plus the null.
202   // nelements must be set to the maximum number of elements to read from
203   // the property.
204   bool getValue(Window win, Atoms atom, Atoms type,
205                 unsigned long &nelements, unsigned long **value) const;
206   bool getValue(Window win, Atoms atom, Atoms type, unsigned long &value) const;
207   bool getValue(Window win, Atoms atom, StringType type,
208                 std::string &value) const;
209   bool getValue(Window win, Atoms atom, StringType type,
210                 int &nelements, StringVect &strings) const;
211   
212   void eraseValue(Window win, Atoms atom) const;
213
214   // temporary function!! remove when not used in blackbox.hh anymore!!
215   inline Atom getAtom(Atoms a)
216   { assert(a >= 0 && a < NUM_ATOMS); Atom ret = _atoms[a];
217     assert(ret != 0); return ret; }
218 };
219
220 #endif // __XAtom_h