add function to focus modal children
[mikachu/openbox.git] / src / client.hh
1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
2 #ifndef   __client_hh
3 #define   __client_hh
4
5 /*! @file client.hh
6   @brief The Client class maintains the state of a client window by handling
7   property changes on the window and some client messages
8 */
9
10 #include "widgetbase.hh"
11 #include "otk/point.hh"
12 #include "otk/strut.hh"
13 #include "otk/rect.hh"
14 #include "otk/eventhandler.hh"
15 #include "otk/ustring.hh"
16
17 extern "C" {
18 #include <X11/Xlib.h>
19
20 #ifdef    SHAPE
21 #include <X11/extensions/shape.h>
22 #endif // SHAPE
23 }
24
25 #include <string>
26 #include <list>
27
28 namespace ob {
29
30 class Frame;
31
32 //! The MWM Hints as retrieved from the window property
33 /*!
34   This structure only contains 3 elements, even though the Motif 2.0
35   structure contains 5. We only use the first 3, so that is all gets defined.
36 */
37 struct MwmHints {
38   unsigned long flags;      //!< A bitmask of Client::MwmFlags values
39   unsigned long functions;  //!< A bitmask of Client::MwmFunctions values
40   unsigned long decorations;//!< A bitmask of Client::MwmDecorations values
41   //! The number of elements in the Client::MwmHints struct
42   static const unsigned int elements = 3;
43 };
44
45 //! Maintains the state of a client window.
46 /*!
47   Client maintains the state of a client window. The state consists of the
48   hints that the application sets on the window, such as the title, or window
49   gravity.
50   <p>
51   Client also manages client messages for the client window. When the
52   application (or any application) requests something to be changed for the
53   client, it will call the ActionHandler (for client messages) or update the
54   class' member variables and call whatever is nessary to complete the
55   change (such as causing a redraw of the titlebar after the title is changed).
56 */
57 class Client : public otk::EventHandler, public WidgetBase {
58 public:
59
60   //! The frame window which decorates around the client window
61   /*!
62     NOTE: This should NEVER be used inside the client class's constructor!
63   */
64   Frame *frame;
65
66   //! Holds a list of Clients
67   typedef std::list<Client*> List;
68
69   //! The possible stacking layers a client window can be a part of
70   enum StackLayer {
71     Layer_Icon,       //!< 0 - iconified windows, in any order at all
72     Layer_Desktop,    //!< 1 - desktop windows
73     Layer_Below,      //!< 2 - normal windows w/ below
74     Layer_Normal,     //!< 3 - normal windows
75     Layer_Above,      //!< 4 - normal windows w/ above
76     Layer_Top,        //!< 5 - always-on-top-windows (docks?)
77     Layer_Fullscreen, //!< 6 - fullscreeen windows
78     Layer_Internal,   //!< 7 - openbox windows/menus
79     NUM_LAYERS
80   };
81
82   //! Corners of the client window, used for anchor positions
83   enum Corner { TopLeft,
84                 TopRight,
85                 BottomLeft,
86                 BottomRight };
87
88   //! Possible window types
89   enum WindowType { Type_Desktop, //!< A desktop (bottom-most window)
90                     Type_Dock,    //!< A dock bar/panel window
91                     Type_Toolbar, //!< A toolbar window, pulled off an app
92                     Type_Menu,    //!< An unpinned menu from an app
93                     Type_Utility, //!< A small utility window such as a palette
94                     Type_Splash,  //!< A splash screen window
95                     Type_Dialog,  //!< A dialog window
96                     Type_Normal   //!< A normal application window
97   };
98
99   //! Possible flags for MWM Hints (defined by Motif 2.0)
100   enum MwmFlags { MwmFlag_Functions   = 1 << 0, //!< The MMW Hints define funcs
101                   MwmFlag_Decorations = 1 << 1  //!< The MWM Hints define decor
102   };
103
104   //! Possible functions for MWM Hints (defined by Motif 2.0)
105   enum MwmFunctions { MwmFunc_All      = 1 << 0, //!< All functions
106                       MwmFunc_Resize   = 1 << 1, //!< Allow resizing
107                       MwmFunc_Move     = 1 << 2, //!< Allow moving
108                       MwmFunc_Iconify  = 1 << 3, //!< Allow to be iconfied
109                       MwmFunc_Maximize = 1 << 4  //!< Allow to be maximized
110                       //MwmFunc_Close    = 1 << 5 //!< Allow to be closed
111   };
112
113   //! Possible decorations for MWM Hints (defined by Motif 2.0)
114   enum MemDecorations { MwmDecor_All      = 1 << 0, //!< All decorations
115                         MwmDecor_Border   = 1 << 1, //!< Show a border
116                         MwmDecor_Handle   = 1 << 2, //!< Show a handle (bottom)
117                         MwmDecor_Title    = 1 << 3, //!< Show a titlebar
118                         //MwmDecor_Menu     = 1 << 4, //!< Show a menu
119                         MwmDecor_Iconify  = 1 << 5, //!< Show an iconify button
120                         MwmDecor_Maximize = 1 << 6  //!< Show a maximize button
121   };
122
123   //! The things the user can do to the client window
124   enum Function { Func_Resize     = 1 << 0, //!< Allow resizing
125                   Func_Move       = 1 << 1, //!< Allow moving
126                   Func_Iconify    = 1 << 2, //!< Allow to be iconified
127                   Func_Maximize   = 1 << 3, //!< Allow to be maximized
128                   Func_Shade      = 1 << 4, //!< Allow to be shaded
129                   Func_Fullscreen = 1 << 5, //!< Allow to be made fullscreen
130                   Func_Close      = 1 << 6  //!< Allow to be closed
131   };
132   //! Holds a bitmask of Client::Function values
133   typedef unsigned char FunctionFlags;
134
135   //! The decorations the client window wants to be displayed on it
136   enum Decoration { Decor_Titlebar    = 1 << 0, //!< Display a titlebar
137                     Decor_Handle      = 1 << 1, //!< Display a handle (bottom)
138                     Decor_Border      = 1 << 2, //!< Display a border
139                     Decor_Iconify     = 1 << 3, //!< Display an iconify button
140                     Decor_Maximize    = 1 << 4, //!< Display a maximize button
141                     //! Display a button to toggle the window's placement on
142                     //! all desktops
143                     Decor_AllDesktops = 1 << 5,
144                     Decor_Close       = 1 << 6  //!< Display a close button
145   };
146   //! Holds a bitmask of Client::Decoration values
147   typedef unsigned char DecorationFlags;
148
149   //! Possible actions that can be made with the _NET_WM_STATE client message
150   enum StateAction { State_Remove = 0, //!< _NET_WM_STATE_REMOVE
151                      State_Add,        //!< _NET_WM_STATE_ADD
152                      State_Toggle      //!< _NET_WM_STATE_TOGGLE
153   };
154
155   //! The event mask to grab on client windows
156   static const long event_mask = PropertyChangeMask | FocusChangeMask |
157                                  StructureNotifyMask;
158
159   //! The mask of events to not let propogate past the client
160   /*!
161     This makes things like xprop work on the client window, but means we have
162     to explicitly grab clicks that we want.
163   */
164   static const long no_propagate_mask = ButtonPressMask | ButtonReleaseMask |
165                                         ButtonMotionMask;
166
167   //! The desktop value which indicated the window is iconified and not on any
168   //! desktop
169   static const long ICONIC_DESKTOP = 0xfffffffe;
170
171   //! The number of unmap events to ignore on the window
172   int ignore_unmaps;
173   
174 private:
175   //! The screen number on which the client resides
176   int      _screen;
177   
178   //! The actual window that this class is wrapping up
179   Window   _window;
180
181   //! The id of the group the window belongs to
182   Window   _group;
183
184   //! The client which this client is a transient (child) for
185   Client *_transient_for;
186
187   //! The clients which are transients (children) of this client
188   Client::List _transients;
189
190   //! The desktop on which the window resides (0xffffffff for all desktops)
191   long _desktop;
192
193   //! Normal window title
194   otk::ustring  _title;
195   //! Window title when iconifiged
196   otk::ustring  _icon_title;
197
198   //! The application that created the window
199   std::string  _app_name;
200   //! The class of the window, can used for grouping
201   std::string  _app_class;
202   //! The specified role of the window, used for identification
203   std::string  _role;
204
205   //! The type of window (what its function is)
206   WindowType   _type;
207
208   //! Position and size of the window
209   /*!
210     This will not always be the actual position of the window on screen, it is
211     rather, the position requested by the client, to which the window's gravity
212     is applied.
213   */
214   otk::Rect    _area;
215
216   //! The window's strut
217   /*!
218     The strut defines areas of the screen that are marked off-bounds for window
219     placement. In theory, where this window exists.
220   */
221   otk::Strut   _strut;
222
223   //! The logical size of the window
224   /*!
225     The "logical" size of the window is refers to the user's perception of the
226     size of the window, and is the value that should be displayed to the user.
227     For example, with xterms, this value it the number of characters being
228     displayed in the terminal, instead of the number of pixels.
229   */
230   otk::Point   _logical_size;
231
232   //! Width of the border on the window.
233   /*!
234     The window manager will set this to 0 while the window is being managed,
235     but needs to restore it afterwards, so it is saved here.
236   */
237   int _border_width;
238
239   //! The minimum aspect ratio the client window can be sized to.
240   /*!
241     A value of 0 means this is ignored.
242   */
243   float _min_ratio;
244   //! The maximum aspect ratio the client window can be sized to.
245   /*!
246     A value of 0 means this is ignored.
247   */
248   float _max_ratio;
249   
250   //! The minimum size of the client window
251   /*!
252     If the min is > the max, then the window is not resizable
253   */
254   otk::Point _min_size;
255   //! The maximum size of the client window
256   /*!
257     If the min is > the max, then the window is not resizable
258   */
259   otk::Point _max_size;
260   //! The size of increments to resize the client window by
261   otk::Point _size_inc;
262   //! The base size of the client window
263   /*!
264     This value should be subtracted from the window's actual size when
265     displaying its size to the user, or working with its min/max size
266   */
267   otk::Point _base_size;
268
269   //! Window decoration and functionality hints
270   MwmHints _mwmhints;
271   
272   //! Where to place the decorated window in relation to the undecorated window
273   int _gravity;
274
275   //! The state of the window, one of WithdrawnState, IconicState, or
276   //! NormalState
277   long _wmstate;
278
279   //! True if the client supports the delete_window protocol
280   bool _delete_window;
281   
282   //! Was the window's position requested by the application? if not, we should
283   //! place the window ourselves when it first appears
284   bool _positioned;
285   
286   //! Can the window receive input focus?
287   bool _can_focus;
288   //! Urgency flag
289   bool _urgent;
290   //! Notify the window when it receives focus?
291   bool _focus_notify;
292   //! Does the client window have the input focus?
293   bool _focused;
294
295   //! The window uses shape extension to be non-rectangular?
296   bool _shaped;
297
298   //! The window is modal, so it must be processed before any windows it is
299   //! related to can be focused
300   bool _modal;
301   //! Only the window's titlebar is displayed
302   bool _shaded;
303   //! The window is iconified
304   bool _iconic;
305   //! The window is maximized to fill the screen vertically
306   bool _max_vert;
307   //! The window is maximized to fill the screen horizontally
308   bool _max_horz;
309   //! The window should not be displayed by pagers
310   bool _skip_pager;
311   //! The window should not be displayed by taskbars
312   bool _skip_taskbar;
313   //! The window is a 'fullscreen' window, and should be on top of all others
314   bool _fullscreen;
315   //! The window should be on top of other windows of the same type
316   bool _above;
317   //! The window should be underneath other windows of the same type
318   bool _below;
319
320   StackLayer _layer;
321
322   //! A bitmask of values in the Client::Decoration enum
323   /*!
324     The values in the variable are the decorations that the client wants to be
325     displayed around it.
326   */
327   DecorationFlags _decorations;
328
329   //! A bitmask of values in the Client::Decoration enum.
330   /*!
331     Specifies the decorations that should NOT be displayed on the client.
332   */
333   DecorationFlags _disabled_decorations;
334
335   //! A bitmask of values in the Client::Function enum
336   /*!
337     The values in the variable specify the ways in which the user is allowed to
338     modify this window.
339   */
340   FunctionFlags _functions;
341
342   //! Retrieves the window's initial gravity
343   void getGravity();
344   //! Retrieves the desktop hint's value and sets Client::_desktop
345   void getDesktop();
346   //! Retrieves the window's type and sets Client::_type
347   void getType();
348   //! Gets the MWM Hints and adjusts Client::_functions and
349   //! Client::_decorations
350   void getMwmHints();
351   //! Gets the position and size of the window and sets Client::_area
352   void getArea();
353   //! Gets the net_state hint and sets the boolean flags for any states set in
354   //! the hint
355   void getState();
356   //! Determines if the window uses the Shape extension and sets
357   //! Client::_shaped
358   void getShaped();
359
360   //! Set up what decor should be shown on the window and what functions should
361   //! be allowed (Client::_decorations and Client::_functions).
362   /*!
363     This also updates the NET_WM_ALLOWED_ACTIONS hint.
364   */
365   void setupDecorAndFunctions();
366   
367   //! Sets the wm_state to the specified value
368   void setWMState(long state);
369   //! Adjusts the window's net_state
370   /*!
371     This should not be called as part of the window mapping process! It is for
372     use when updating the state post-mapping.<br>
373     Client::applyStartupState is used to do the same things during the mapping
374     process.
375   */
376   void setState(StateAction action, long data1, long data2);
377
378   //! Sends the window to the specified desktop
379   /*!
380     A window is iconified by sending it to the ICONIC_DESKTOP, and restored
381     by sending it to any other valid desktop.
382   */
383   void setDesktop(long desktop);
384   
385   //! Calculates the stacking layer for the client window
386   void calcLayer();
387
388   //! Update the protocols that the window supports and adjusts things if they
389   //! change
390   void updateProtocols();
391   //! Updates the WMNormalHints and adjusts things if they change
392   void updateNormalHints();
393   //! Updates the WMHints and adjusts things if they change
394   /*!
395     @param initstate Whether to read the initial_state property from the
396                      WMHints. This should only be used during the mapping
397                      process.
398   */
399   void updateWMHints(bool initstate = false);
400   //! Updates the window's title
401   void updateTitle();
402   //! Updates the window's icon title
403   void updateIconTitle();
404   //! Updates the window's application name and class
405   void updateClass();
406   //! Updates the strut for the client
407   void updateStrut();
408   //! Updates the window's transient status, and any parents of it
409   void updateTransientFor();
410
411   //! Change the client's state hints to match the class' data
412   void changeState();
413   //! Change the allowed actions set on the client
414   void changeAllowedActions();
415
416   //! Request the client to close its window.
417   void close();
418
419   //! Shades or unshades the client window
420   /*!
421     @param shade true if the window should be shaded; false if it should be
422                  unshaded.
423   */
424   void shade(bool shade);
425
426   //! Fires the urgent callbacks which lets the user do what they want with
427   //! urgent windows
428   void fireUrgent();
429   
430   //! Fullscreen's or unfullscreen's the client window
431   /*!
432     @param fs true if the window should be made fullscreen; false if it should
433               be returned to normal state.
434     @param savearea true to have the client's current size and position saved;
435                     otherwise, they are not. You should not save when mapping a
436                     new window that is set to fullscreen.
437   */
438   void fullscreen(bool fs, bool savearea);
439
440   //! Maximize or unmaximize the client window
441   /*!
442     @param max true if the window should be maximized; false if it should be
443                returned to normal size.
444     @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
445     @param savearea true to have the client's current size and position saved;
446                     otherwise, they are not. You should not save when mapping a
447                     new window that is set to fullscreen.
448   */
449   void maximize(bool max, int dir, bool savearea);
450
451   //! Internal version of the Client::move function
452   /*!
453     @param x The X coordinate to move to.
454     @param y The Y coordinate to move to.
455   */
456   void internal_move(int x, int y);
457   //! Internal version of the Client::resize function
458   /*!
459     This also maintains things like the client's minsize, and size increments.
460     @param anchor The corner to keep in the same position when resizing.
461     @param w The width component of the new size for the client.
462     @param h The height component of the new size for the client.
463     @param user Specifies whether this is a user-requested change or a
464                 program requested change.
465     @param x An optional X coordinate to which the window will be moved
466              after resizing.
467     @param y An optional Y coordinate to which the window will be moved
468              after resizing.
469     The x and y coordinates must both be sepcified together, or they will have
470     no effect. When they are specified, the anchor is ignored.
471   */
472   void internal_resize(Corner anchor, int w, int h, bool user = true,
473                        int x = INT_MIN, int y = INT_MIN);
474
475   //! Attempts to focus a modal child of this window, recursively.
476   /*!
477     @return true if a modal child has been found and focused; otherwise, false.
478   */
479   bool focusModalChild();
480
481 public:
482 #ifndef SWIG
483   //! Constructs a new Client object around a specified window id
484   /*!
485 BB    @param window The window id that the Client class should handle
486     @param screen The screen on which the window resides
487   */
488   Client(int screen, Window window);
489   //! Destroys the Client object
490   virtual ~Client();
491 #endif
492
493   //! Returns the screen on which the clien resides
494   inline int screen() const { return _screen; }
495   
496   //! Returns the window id that the Client object is handling
497   inline Window window() const { return _window; }
498
499   //! Returns the type of the window, one of the Client::WindowType values
500   inline WindowType type() const { return _type; }
501   //! Returns if the window should be treated as a normal window.
502   /*!
503     Some windows (desktops, docks, splash screens) have special rules applied
504     to them in a number of places regarding focus or user interaction.
505   */
506   inline bool normal() const {
507     return ! (_type == Type_Desktop || _type == Type_Dock ||
508               _type == Type_Splash);
509   }
510   
511   //! Returns the desktop on which the window resides
512   /*!
513     This value is a 0-based index.<br>
514     A value of 0xffffffff indicates that the window exists on all desktops.
515   */
516   inline long desktop() const { return _desktop; }
517   //! Returns the window's title
518   inline const otk::ustring &title() const { return _title; }
519   //! Returns the window's title when it is iconified
520   inline const otk::ustring &iconTitle() const { return _title; }
521   //! Returns the application's name to whom the window belongs
522   inline const std::string &appName() const { return _app_name; }
523   //! Returns the class of the window
524   inline const std::string &appClass() const { return _app_class; }
525   //! Returns the program-specified role of the window
526   inline const std::string &role() const { return _role; }
527   //! Returns if the window can be focused
528   /*!
529     @return true if the window can receive focus; otherwise, false
530   */
531   inline bool canFocus() const { return _can_focus; }
532   //! Returns if the window has indicated that it needs urgent attention
533   inline bool urgent() const { return _urgent; }
534   //! Returns if the window wants to be notified when it receives focus
535   inline bool focusNotify() const { return _focus_notify; }
536   //! Returns if the window uses the Shape extension
537   inline bool shaped() const { return _shaped; }
538   //! Returns the window's gravity
539   /*!
540     This value determines where to place the decorated window in relation to
541     its position without decorations.<br>
542     One of: NorthWestGravity, SouthWestGravity, EastGravity, ...,
543     SouthGravity, StaticGravity, ForgetGravity
544   */
545   inline int gravity() const { return _gravity; }
546   //! Returns if the application requested the initial position for the window
547   /*!
548     If the application did not request a position (this function returns false)
549     then the window should be placed intelligently by the window manager
550     initially
551   */
552   inline bool positionRequested() const { return _positioned; }
553   //! Returns the decorations that the client window wishes to be displayed on
554   //! it
555   inline DecorationFlags decorations() const { return _decorations; }
556   //! Returns the decorations that the user has requested to be disabled on the
557   //! client
558   inline DecorationFlags disabledDecorations() const
559     { return _disabled_decorations; }
560   //! Returns the functions that the user can perform on the window
561   inline FunctionFlags funtions() const { return _functions; }
562
563   //! Return the client this window is transient for
564   inline Client *transientFor() const { return _transient_for; }
565
566   //! Returns if the window is modal
567   /*!
568     If the window is modal, then no other windows that it is related to can get
569     focus while it exists/remains modal.
570   */
571   inline bool modal() const { return _modal; }
572   //! The window should not be displayed by pagers
573   inline bool skipPager() const { return _skip_pager; }
574   //! The window should not be displayed by taskbars
575   inline bool skipTaskbar() const { return _skip_taskbar; } 
576  //! Returns if the window is shaded
577   /*!
578     When the window is shaded, only its titlebar is visible.
579   */
580   inline bool shaded() const { return _shaded; }
581   //! Returns if the window is in fullscreen mode
582   inline bool fullscreen() const { return _fullscreen; }
583   //! Returns if the window is iconified
584   /*!
585     When the window is iconified, it is not visible at all (except in iconbars/
586     panels/etc that want to show lists of iconified windows
587   */
588   inline bool iconic() const { return _iconic; }
589   //! Returns if the window is maximized vertically
590   inline bool maxVert() const { return _max_vert; }
591   //! Returns if the window is maximized horizontally
592   inline bool maxHorz() const { return _max_horz; }
593   //! Returns the window's stacking layer
594   inline StackLayer layer() const { return _layer; }
595
596   //! Returns the logical size of the window
597   /*!
598     The "logical" size of the window is refers to the user's perception of the
599     size of the window, and is the value that should be displayed to the user.
600     For example, with xterms, this value it the number of characters being
601     displayed in the terminal, instead of the number of pixels.
602   */
603   const otk::Point &logicalSize() const { return _logical_size; }
604
605   //! Applies the states requested when the window mapped
606   /*!
607     This should be called only once, during the window mapping process. It
608     applies things like maximized, and fullscreen.
609   */
610   void applyStartupState();
611   
612   //! Removes or reapplies the client's border to its window
613   /*!
614     Used when managing and unmanaging a window.
615     @param addborder true if adding the border to the client; false if removing
616                      from the client
617   */
618   void toggleClientBorder(bool addborder);
619
620   //! Returns the position and size of the client relative to the root window
621   inline const otk::Rect &area() const { return _area; }
622
623   //! Returns the client's strut definition
624   inline const otk::Strut &strut() const { return _strut; }
625
626   //! Move the window (actually, its frame) to a position.
627   /*!
628     This moves the window so that the top-left corner of its frame will be at
629     the position specified.
630     @param x The X coordinate to move to.
631     @param y The Y coordinate to move to.
632   */
633   void move(int x, int y);
634   
635   //! Resizes the client window, anchoring it in a given corner
636   /*!
637     This also maintains things like the client's minsize, and size increments.
638     @param anchor The corner to keep in the same position when resizing.
639     @param w The width component of the new size for the client.
640     @param h The height component of the new size for the client.
641   */
642   void resize(Corner anchor, int w, int h);
643
644   //! Reapplies the maximized state to the window
645   /*!
646     Use this to make the window readjust its maximized size to new
647     surroundings (struts, etc).
648   */
649   void remaximize();
650   
651   //! Choose a mask of decorations to not display on the client
652   /*!
653     Pass a value of 0 to the function to turn all decorations back on. Note
654     that you cannot add decorations to a window with this, you can only remove
655     decorations that would otherwise have been displayed.
656     @param flags The mask of values from Client::Decoration to specify which
657                  decorations should not be displayed.
658   */
659   void disableDecorations(DecorationFlags flags);
660   
661   //! Attempt to focus the client window
662   bool focus();
663
664   //! Remove focus from the client window
665   void unfocus() const;
666
667   //! Validate client, by making sure no Destroy or Unmap events exist in
668   //! the event queue for the window.
669   /*!
670     @return true if the client is valid; false if the client has already
671             been unmapped/destroyed, and so is invalid.
672   */
673   bool validate() const;
674
675   virtual void focusHandler(const XFocusChangeEvent &e);
676   virtual void unfocusHandler(const XFocusChangeEvent &e);
677   virtual void propertyHandler(const XPropertyEvent &e);
678   virtual void clientMessageHandler(const XClientMessageEvent &e);
679   virtual void configureRequestHandler(const XConfigureRequestEvent &e);
680   virtual void unmapHandler(const XUnmapEvent &e);
681   virtual void destroyHandler(const XDestroyWindowEvent &e);
682   virtual void reparentHandler(const XReparentEvent &e);
683   virtual void mapRequestHandler(const XMapRequestEvent &e);
684 #if defined(SHAPE)
685   virtual void shapeHandler(const XShapeEvent &e);
686 #endif // SHAPE 
687 };
688
689 }
690
691 #endif // __client_hh