backing out all changes to make mouse button mapping's configurable
[mikachu/openbox.git] / src / Window.hh
1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
2 // Window.hh for Blackbox - an X11 Window manager
3 // Copyright (c) 2001 - 2002 Sean 'Shaleh' Perry <shaleh@debian.org>
4 // Copyright (c) 1997 - 2000 Brad Hughes (bhughes@tcac.net)
5 //
6 // Permission is hereby granted, free of charge, to any person obtaining a
7 // copy of this software and associated documentation files (the "Software"),
8 // to deal in the Software without restriction, including without limitation
9 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 // and/or sell copies of the Software, and to permit persons to whom the
11 // Software is furnished to do so, subject to the following conditions:
12 //
13 // The above copyright notice and this permission notice shall be included in
14 // all copies or substantial portions of the Software.
15 //
16 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 // DEALINGS IN THE SOFTWARE.
23
24 #ifndef   __Window_hh
25 #define   __Window_hh
26
27 extern "C" {
28 #include <X11/Xlib.h>
29 #include <X11/Xutil.h>
30 #ifdef    SHAPE
31 #  include <X11/extensions/shape.h>
32 #endif // SHAPE
33 }
34
35 #include <string>
36
37 #include "BaseDisplay.hh"
38 #include "Timer.hh"
39 #include "Util.hh"
40 #include "Windowmenu.hh"
41
42 #define MwmHintsFunctions     (1l << 0)
43 #define MwmHintsDecorations   (1l << 1)
44
45 #define MwmFuncAll            (1l << 0)
46 #define MwmFuncResize         (1l << 1)
47 #define MwmFuncMove           (1l << 2)
48 #define MwmFuncIconify        (1l << 3)
49 #define MwmFuncMaximize       (1l << 4)
50 #define MwmFuncClose          (1l << 5)
51
52 #define MwmDecorAll           (1l << 0)
53 #define MwmDecorBorder        (1l << 1)
54 #define MwmDecorHandle        (1l << 2)
55 #define MwmDecorTitle         (1l << 3)
56 #define MwmDecorMenu          (1l << 4) // not used
57 #define MwmDecorIconify       (1l << 5)
58 #define MwmDecorMaximize      (1l << 6)
59
60 // this structure only contains 3 elements... the Motif 2.0 structure contains
61 // 5... we only need the first 3... so that is all we will define
62 typedef struct MwmHints {
63   unsigned long flags, functions, decorations;
64 } MwmHints;
65
66 #define PropMwmHintsElements  3
67
68 class BWindowGroup {
69 private:
70   Blackbox *blackbox;
71   Window group;
72   BlackboxWindowList windowList;
73
74 public:
75   BWindowGroup(Blackbox *b, Window _group);
76   ~BWindowGroup(void);
77
78   inline Window groupWindow(void) const { return group; }
79
80   inline bool empty(void) const { return windowList.empty(); }
81
82   void addWindow(BlackboxWindow *w) { windowList.push_back(w); }
83   void removeWindow(BlackboxWindow *w) { windowList.remove(w); }
84
85   /*
86     find a window on the specified screen. the focused window (if any) is
87     checked first, otherwise the first matching window found is returned.
88     transients are returned only if allow_transients is True.
89   */
90   BlackboxWindow *find(BScreen *screen, bool allow_transients = False) const;
91 };
92
93
94 class BlackboxWindow : public TimeoutHandler {
95 public:
96   enum Function { Func_Resize   = (1l << 0),
97                   Func_Move     = (1l << 1),
98                   Func_Iconify  = (1l << 2),
99                   Func_Maximize = (1l << 3),
100                   Func_Close    = (1l << 4) };
101   typedef unsigned char FunctionFlags;
102
103   enum Decoration { Decor_Titlebar = (1l << 0),
104                     Decor_Handle   = (1l << 1),
105                     Decor_Border   = (1l << 2),
106                     Decor_Iconify  = (1l << 3),
107                     Decor_Maximize = (1l << 4),
108                     Decor_Close    = (1l << 5) };
109   typedef unsigned char DecorationFlags;
110
111   enum WindowType { Type_Desktop,
112                     Type_Dock,
113                     Type_Toolbar,
114                     Type_Menu,
115                     Type_Utility,
116                     Type_Splash,
117                     Type_Dialog,
118                     Type_Normal };
119
120   enum Corner { TopLeft,
121                 TopRight,
122                 BottomLeft,
123                 BottomRight };
124
125 private:
126   Blackbox *blackbox;
127   BScreen *screen;
128   XAtom *xatom;
129   BTimer *timer;
130   BlackboxAttributes blackbox_attrib;
131
132   Time lastButtonPressTime;  // used for double clicks, when were we clicked
133   Windowmenu *windowmenu;
134
135   unsigned int window_number;
136   unsigned long current_state;
137
138   enum FocusMode { F_NoInput = 0, F_Passive,
139                    F_LocallyActive, F_GloballyActive };
140   FocusMode focus_mode;
141
142   struct _flags {
143     bool moving,             // is moving?
144       resizing,              // is resizing?
145       shaded,                // is shaded?
146       visible,               // is visible?
147       iconic,                // is iconified?
148       focused,               // has focus?
149       stuck,                 // is omnipresent?
150       modal,                 // is modal? (must be dismissed to continue)
151       skip_taskbar,          // skipped by taskbars?
152       skip_pager,            // skipped by pagers?
153       fullscreen,            // a fullscreen window?
154       send_focus_message,    // should we send focus messages to our client?
155       shaped;                // does the frame use the shape extension?
156     unsigned int maximized;  // maximize is special, the number corresponds
157                              // with a mouse button
158                              // if 0, not maximized
159                              // 1 = HorizVert, 2 = Vertical, 3 = Horizontal
160   } flags;
161
162   struct _client {
163     Window window,                  // the client's window
164       window_group;
165     BlackboxWindow *transient_for;  // which window are we a transient for?
166     BlackboxWindowList transientList; // which windows are our transients?
167
168     std::string title, icon_title;
169
170     Rect rect;
171     Strut strut;
172
173     int old_bw;                       // client's borderwidth
174
175     unsigned int
176       min_width, min_height,        // can not be resized smaller
177       max_width, max_height,        // can not be resized larger
178       width_inc, height_inc,        // increment step
179       min_aspect_x, min_aspect_y,   // minimum aspect ratio
180       max_aspect_x, max_aspect_y,   // maximum aspect ratio
181       base_width, base_height,
182       win_gravity;
183
184     unsigned long initial_state, normal_hint_flags, wm_hint_flags;
185   } client;
186
187   FunctionFlags functions;
188   /*
189    * what decorations do we have?
190    * this is based on the type of the client window as well as user input
191    * the menu is not really decor, but it goes hand in hand with the decor
192    */
193   DecorationFlags decorations;
194   Corner resize_dir;
195   WindowType window_type;
196
197   /*
198    * client window = the application's window
199    * frame window = the window drawn around the outside of the client window
200    *                by the window manager which contains items like the
201    *                titlebar and close button
202    * title = the titlebar drawn above the client window, it displays the
203    *         window's name and any buttons for interacting with the window,
204    *         such as iconify, maximize, and close
205    * label = the window in the titlebar where the title is drawn
206    * buttons = maximize, iconify, close
207    * handle = the bar drawn at the bottom of the window, which contains the
208    *          left and right grips used for resizing the window
209    * grips = the smaller reactangles in the handle, one of each side of it.
210    *         When clicked and dragged, these resize the window interactively
211    * border = the line drawn around the outside edge of the frame window,
212    *          between the title, the bordered client window, and the handle.
213    *          Also drawn between the grips and the handle
214    */
215
216   struct _frame {
217     // u -> unfocused, f -> has focus
218     unsigned long ulabel_pixel, flabel_pixel, utitle_pixel,
219       ftitle_pixel, uhandle_pixel, fhandle_pixel, ubutton_pixel,
220       fbutton_pixel, pbutton_pixel, uborder_pixel, fborder_pixel,
221       ugrip_pixel, fgrip_pixel;
222     Pixmap ulabel, flabel, utitle, ftitle, uhandle, fhandle,
223       ubutton, fbutton, pbutton, ugrip, fgrip;
224
225     Window window,       // the frame
226       plate,             // holds the client
227       title,
228       label,
229       handle,
230       close_button, iconify_button, maximize_button,
231       right_grip, left_grip;
232
233     /*
234      * size and location of the box drawn while the window dimensions or
235      * location is being changed, ie. resized or moved
236      */
237     Rect changing;
238
239     Rect rect;                  // frame geometry
240     Strut margin;               // margins between the frame and client
241
242     int grab_x, grab_y;         // where was the window when it was grabbed?
243
244     unsigned int inside_w, inside_h, // window w/h without border_w
245       title_h, label_w, label_h, handle_h,
246       button_w, grip_w, mwm_border_w, border_w,
247       bevel_w;
248   } frame;
249
250   BlackboxWindow(const BlackboxWindow&);
251   BlackboxWindow& operator=(const BlackboxWindow&);
252
253   bool getState(void);
254   Window createToplevelWindow();
255   Window createChildWindow(Window parent, Cursor = None);
256
257   void getWindowType(void);
258   void updateStrut(void);
259   void getWMName(void);
260   void getWMIconName(void);
261   void getWMNormalHints(void);
262   void getWMProtocols(void);
263   void getWMHints(void);
264   void getNetWMHints(void);
265   void getMWMHints(void);
266   bool getBlackboxHints(void);
267   void getTransientInfo(void);
268   bool isKDESystrayWindow(void);
269   void setNetWMAttributes(void);
270   void associateClientWindow(void);
271   void decorate(void);
272   void decorateLabel(void);
273   void positionButtons(bool redecorate_label = False);
274   void positionWindows(void);
275   void createHandle(void);
276   void destroyHandle(void);
277   void createTitlebar(void);
278   void destroyTitlebar(void);
279   void createCloseButton(void);
280   void destroyCloseButton(void);
281   void createIconifyButton(void);
282   void destroyIconifyButton(void);
283   void createMaximizeButton(void);
284   void destroyMaximizeButton(void);
285   void redrawWindowFrame(void) const;
286   void redrawLabel(void) const;
287   void redrawAllButtons(void) const;
288   void redrawCloseButton(bool pressed) const;
289   void redrawIconifyButton(bool pressed) const;
290   void redrawMaximizeButton(bool pressed) const;
291   void applyGravity(Rect &r);
292   void restoreGravity(Rect &r);
293   void setAllowedActions(void);
294   void setState(unsigned long new_state);
295   void upsize(void);
296   void doMove(int x_root, int y_root);
297   void endMove(void);
298   void doResize(int x_root, int y_root);
299   void endResize(void);
300
301   void constrain(Corner anchor, int *pw = 0, int *ph = 0);
302
303 public:
304   BlackboxWindow(Blackbox *b, Window w, BScreen *s);
305   virtual ~BlackboxWindow(void);
306
307   inline bool isTransient(void) const { return client.transient_for != 0; }
308   inline bool isFocused(void) const { return flags.focused; }
309   inline bool isVisible(void) const { return flags.visible; }
310   inline bool isIconic(void) const { return flags.iconic; }
311   inline bool isShaded(void) const { return flags.shaded; }
312   inline bool isMaximized(void) const { return flags.maximized; }
313   inline bool isMaximizedHoriz(void) const { return flags.maximized == 3; }
314   inline bool isMaximizedVert(void) const { return flags.maximized == 2; }
315   inline bool isMaximizedFull(void) const { return flags.maximized == 1; }
316   inline bool isStuck(void) const { return flags.stuck; }
317   inline bool isModal(void) const { return flags.modal; }
318   inline bool isIconifiable(void) const { return functions & Func_Iconify; }
319   inline bool isMaximizable(void) const { return functions & Func_Maximize; }
320   inline bool isResizable(void) const { return functions & Func_Resize; }
321   inline bool isClosable(void) const { return functions & Func_Close; }
322   inline bool isDesktop(void) const { return window_type == Type_Desktop; }
323
324   inline bool hasTitlebar(void) const { return decorations & Decor_Titlebar; }
325
326   inline const BlackboxWindowList &getTransients(void) const
327   { return client.transientList; }
328   BlackboxWindow *getTransientFor(void) const;
329
330   inline BScreen *getScreen(void) const { return screen; }
331
332   inline Window getFrameWindow(void) const { return frame.window; }
333   inline Window getClientWindow(void) const { return client.window; }
334   inline Window getGroupWindow(void) const { return client.window_group; }
335
336   inline Windowmenu * getWindowmenu(void) const { return windowmenu; }
337
338   inline const char *getTitle(void) const
339   { return client.title.c_str(); }
340   inline const char *getIconTitle(void) const
341   { return client.icon_title.c_str(); }
342
343   inline unsigned int getWorkspaceNumber(void) const
344   { return blackbox_attrib.workspace; }
345   inline unsigned int getWindowNumber(void) const { return window_number; }
346
347   inline const Rect &frameRect(void) const { return frame.rect; }
348   inline const Rect &clientRect(void) const { return client.rect; }
349
350   inline unsigned int getTitleHeight(void) const
351   { return frame.title_h; }
352
353   inline void setWindowNumber(int n) { window_number = n; }
354
355   bool validateClient(void) const;
356   bool setInputFocus(void);
357
358   // none of these are used by the window manager, they are here to persist
359   // them properly in the window's netwm state property.
360   inline bool skipTaskbar(void) const { return flags.skip_taskbar; }
361   inline void setSkipTaskbar(const bool s) { flags.skip_taskbar = s; }
362   inline bool skipPager(void) const { return flags.skip_pager; }
363   inline void setSkipPager(const bool s) { flags.skip_pager = s; }
364   inline bool isFullscreen(void) const { return flags.fullscreen; }
365   inline void setFullscreen(const bool f) { flags.fullscreen = f; }
366
367   inline void setModal(const bool m) { flags.modal = m; }
368
369   void beginMove(int x_root, int y_root);
370   void beginResize(int x_root, int y_root, Corner dir);
371   void setFocusFlag(bool focus);
372   void iconify(void);
373   void deiconify(bool reassoc = True, bool raise = True);
374   void show(void);
375   void close(void);
376   void withdraw(void);
377   void maximize(unsigned int button);
378   void remaximize(void);
379   void shade(void);
380   void stick(void);
381   void reconfigure(void);
382   void updateFocusModel(void);
383   void installColormap(bool install);
384   void restore(bool remap);
385   void configure(int dx, int dy, unsigned int dw, unsigned int dh);
386   void setWorkspace(unsigned int n);
387   void changeBlackboxHints(BlackboxHints *net);
388   void restoreAttributes(void);
389
390   void buttonPressEvent(const XButtonEvent *be);
391   void buttonReleaseEvent(const XButtonEvent *re);
392   void motionNotifyEvent(const XMotionEvent *me);
393   void destroyNotifyEvent(const XDestroyWindowEvent */*unused*/);
394   void mapRequestEvent(const XMapRequestEvent *mre);
395   void unmapNotifyEvent(const XUnmapEvent */*unused*/);
396   void reparentNotifyEvent(const XReparentEvent */*unused*/);
397   void propertyNotifyEvent(Atom atom);
398   void exposeEvent(const XExposeEvent *ee);
399   void configureRequestEvent(const XConfigureRequestEvent *cr);
400
401 #ifdef    SHAPE
402   void configureShape(void);
403   void shapeEvent(XShapeEvent * /*unused*/);
404 #endif // SHAPE
405
406   virtual void timeout(void);
407 };
408
409
410 #endif // __Window_hh