remove the word "sticky" from everywhere, and replace with "all desktops". change...
[dana/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 number of unmap events to ignore on the window
168   int ignore_unmaps;
169   
170 private:
171   //! The screen number on which the client resides
172   int      _screen;
173   
174   //! The actual window that this class is wrapping up
175   Window   _window;
176
177   //! The id of the group the window belongs to
178   Window   _group;
179
180   //! The client which this client is a transient (child) for
181   Client *_transient_for;
182
183   //! The clients which are transients (children) of this client
184   Client::List _transients;
185
186   //! The desktop on which the window resides (0xffffffff for all desktops)
187   long _desktop;
188
189   //! Normal window title
190   otk::ustring  _title;
191   //! Window title when iconifiged
192   otk::ustring  _icon_title;
193
194   //! The application that created the window
195   std::string  _app_name;
196   //! The class of the window, can used for grouping
197   std::string  _app_class;
198   //! The specified role of the window, used for identification
199   std::string  _role;
200
201   //! The type of window (what its function is)
202   WindowType   _type;
203
204   //! Position and size of the window
205   /*!
206     This will not always be the actual position of the window on screen, it is
207     rather, the position requested by the client, to which the window's gravity
208     is applied.
209   */
210   otk::Rect    _area;
211
212   //! The window's strut
213   /*!
214     The strut defines areas of the screen that are marked off-bounds for window
215     placement. In theory, where this window exists.
216   */
217   otk::Strut   _strut;
218
219   //! The logical size of the window
220   /*!
221     The "logical" size of the window is refers to the user's perception of the
222     size of the window, and is the value that should be displayed to the user.
223     For example, with xterms, this value it the number of characters being
224     displayed in the terminal, instead of the number of pixels.
225   */
226   otk::Point   _logical_size;
227
228   //! Width of the border on the window.
229   /*!
230     The window manager will set this to 0 while the window is being managed,
231     but needs to restore it afterwards, so it is saved here.
232   */
233   int _border_width;
234
235   //! The minimum size of the client window
236   /*!
237     If the min is > the max, then the window is not resizable
238   */
239   otk::Point _min_size;
240   //! The maximum size of the client window
241   /*!
242     If the min is > the max, then the window is not resizable
243   */
244   otk::Point _max_size;
245   //! The size of increments to resize the client window by
246   otk::Point _size_inc;
247   //! The base size of the client window
248   /*!
249     This value should be subtracted from the window's actual size when
250     displaying its size to the user, or working with its min/max size
251   */
252   otk::Point _base_size;
253
254   //! Window decoration and functionality hints
255   MwmHints _mwmhints;
256   
257   //! Where to place the decorated window in relation to the undecorated window
258   int _gravity;
259
260   //! The state of the window, one of WithdrawnState, IconicState, or
261   //! NormalState
262   long _wmstate;
263
264   //! Was the window's position requested by the application? if not, we should
265   //! place the window ourselves when it first appears
266   bool _positioned;
267   
268   //! Can the window receive input focus?
269   bool _can_focus;
270   //! Urgency flag
271   bool _urgent;
272   //! Notify the window when it receives focus?
273   bool _focus_notify;
274   //! Does the client window have the input focus?
275   bool _focused;
276
277   //! The window uses shape extension to be non-rectangular?
278   bool _shaped;
279
280   //! The window is modal, so it must be processed before any windows it is
281   //! related to can be focused
282   bool _modal;
283   //! Only the window's titlebar is displayed
284   bool _shaded;
285   //! The window is iconified
286   bool _iconic;
287   //! The window is maximized to fill the screen vertically
288   bool _max_vert;
289   //! The window is maximized to fill the screen horizontally
290   bool _max_horz;
291   //! The window should not be displayed by pagers
292   bool _skip_pager;
293   //! The window should not be displayed by taskbars
294   bool _skip_taskbar;
295   //! The window is a 'fullscreen' window, and should be on top of all others
296   bool _fullscreen;
297   //! The window should be on top of other windows of the same type
298   bool _above;
299   //! The window should be underneath other windows of the same type
300   bool _below;
301
302   StackLayer _layer;
303
304   //! A bitmask of values in the Client::Decoration enum
305   /*!
306     The values in the variable are the decorations that the client wants to be
307     displayed around it.
308   */
309   DecorationFlags _decorations;
310
311   //! A bitmask of values in the Client::Function enum
312   /*!
313     The values in the variable specify the ways in which the user is allowed to
314     modify this window.
315   */
316   FunctionFlags _functions;
317
318   //! Retrieves the window's initial gravity
319   void getGravity();
320   //! Retrieves the desktop hint's value and sets Client::_desktop
321   void getDesktop();
322   //! Retrieves the window's type and sets Client::_type
323   void getType();
324   //! Gets the MWM Hints and adjusts Client::_functions and
325   //! Client::_decorations
326   void getMwmHints();
327   //! Gets the position and size of the window and sets Client::_area
328   void getArea();
329   //! Gets the net_state hint and sets the boolean flags for any states set in
330   //! the hint
331   void getState();
332   //! Determines if the window uses the Shape extension and sets
333   //! Client::_shaped
334   void getShaped();
335
336   //! Set up what decor should be shown on the window and what functions should
337   //! be allowed (Client::_decorations and Client::_functions).
338   /*!
339     This also updates the NET_WM_ALLOWED_ACTIONS hint.
340   */
341   void setupDecorAndFunctions();
342   
343   //! Sets the wm_state to the specified value
344   void setWMState(long state);
345   //! Adjusts the window's net_state
346   /*!
347     This should not be called as part of the window mapping process! It is for
348     use when updating the state post-mapping.<br>
349     Client::applyStartupState is used to do the same things during the mapping
350     process.
351   */
352   void setState(StateAction action, long data1, long data2);
353
354   //! Sends the window to the specified desktop
355   void setDesktop(long desktop);
356   
357   //! Calculates the stacking layer for the client window
358   void calcLayer();
359
360   //! Update the protocols that the window supports and adjusts things if they
361   //! change
362   void updateProtocols();
363   //! Updates the WMNormalHints and adjusts things if they change
364   void updateNormalHints();
365   //! Updates the WMHints and adjusts things if they change
366   void updateWMHints();
367   //! Updates the window's title
368   void updateTitle();
369   //! Updates the window's icon title
370   void updateIconTitle();
371   //! Updates the window's application name and class
372   void updateClass();
373   //! Updates the strut for the client
374   void updateStrut();
375   //! Updates the window's transient status, and any parents of it
376   void updateTransientFor();
377
378   //! Change the client's state hints to match the class' data
379   void changeState();
380   //! Change the allowed actions set on the client
381   void changeAllowedActions();
382
383   //! Request the client to close its window.
384   void close();
385
386   //! Shades or unshades the client window
387   /*!
388     @param shade true if the window should be shaded; false if it should be
389                  unshaded.
390   */
391   void shade(bool shade);
392
393   //! Fullscreen's or unfullscreen's the client window
394   /*!
395     @param fs true if the window should be made fullscreen; false if it should
396               be returned to normal state.
397   */
398   void fullscreen(bool fs);
399
400   //! Internal version of the Client::move function
401   /*!
402     @param x The X coordinate to move to.
403     @param y The Y coordinate to move to.
404   */
405   void internal_move(int x, int y);
406   //! Internal version of the Client::resize function
407   /*!
408     This also maintains things like the client's minsize, and size increments.
409     @param anchor The corner to keep in the same position when resizing.
410     @param w The width component of the new size for the client.
411     @param h The height component of the new size for the client.
412     @param x An optional X coordinate to which the window will be moved
413              after resizing.
414     @param y An optional Y coordinate to which the window will be moved
415              after resizing.
416     The x and y coordinates must both be sepcified together, or they will have
417     no effect. When they are specified, the anchor is ignored.
418   */
419   void internal_resize(Corner anchor, int w, int h,
420                        int x = INT_MIN, int y = INT_MIN);
421
422 public:
423 #ifndef SWIG
424   //! Constructs a new Client object around a specified window id
425   /*!
426 BB    @param window The window id that the Client class should handle
427     @param screen The screen on which the window resides
428   */
429   Client(int screen, Window window);
430   //! Destroys the Client object
431   virtual ~Client();
432 #endif
433
434   //! Returns the screen on which the clien resides
435   inline int screen() const { return _screen; }
436   
437   //! Returns the window id that the Client object is handling
438   inline Window window() const { return _window; }
439
440   //! Returns the type of the window, one of the Client::WindowType values
441   inline WindowType type() const { return _type; }
442   //! Returns if the window should be treated as a normal window.
443   /*!
444     Some windows (desktops, docks, splash screens) have special rules applied
445     to them in a number of places regarding focus or user interaction.
446   */
447   inline bool normal() const {
448     return ! (_type == Type_Desktop || _type == Type_Dock ||
449               _type == Type_Splash);
450   }
451   
452   //! Returns the desktop on which the window resides
453   /*!
454     This value is a 0-based index.<br>
455     A value of 0xffffffff indicates that the window exists on all desktops.
456   */
457   inline long desktop() const { return _desktop; }
458   //! Returns the window's title
459   inline const otk::ustring &title() const { return _title; }
460   //! Returns the window's title when it is iconified
461   inline const otk::ustring &iconTitle() const { return _title; }
462   //! Returns the application's name to whom the window belongs
463   inline const std::string &appName() const { return _app_name; }
464   //! Returns the class of the window
465   inline const std::string &appClass() const { return _app_class; }
466   //! Returns the program-specified role of the window
467   inline const std::string &role() const { return _role; }
468   //! Returns if the window can be focused
469   /*!
470     @return true if the window can receive focus; otherwise, false
471   */
472   inline bool canFocus() const { return _can_focus; }
473   //! Returns if the window has indicated that it needs urgent attention
474   inline bool urgent() const { return _urgent; }
475   //! Returns if the window wants to be notified when it receives focus
476   inline bool focusNotify() const { return _focus_notify; }
477   //! Returns if the window uses the Shape extension
478   inline bool shaped() const { return _shaped; }
479   //! Returns the window's gravity
480   /*!
481     This value determines where to place the decorated window in relation to
482     its position without decorations.<br>
483     One of: NorthWestGravity, SouthWestGravity, EastGravity, ...,
484     SouthGravity, StaticGravity, ForgetGravity
485   */
486   inline int gravity() const { return _gravity; }
487   //! Returns if the application requested the initial position for the window
488   /*!
489     If the application did not request a position (this function returns false)
490     then the window should be placed intelligently by the window manager
491     initially
492   */
493   inline bool positionRequested() const { return _positioned; }
494   //! Returns the decorations that the client window wishes to be displayed on
495   //! it
496   inline DecorationFlags decorations() const { return _decorations; }
497   //! Returns the functions that the user can perform on the window
498   inline FunctionFlags funtions() const { return _functions; }
499
500   //! Return the client this window is transient for
501   inline Client *transientFor() const { return _transient_for; }
502
503   //! Returns if the window is modal
504   /*!
505     If the window is modal, then no other windows that it is related to can get
506     focus while it exists/remains modal.
507   */
508   inline bool modal() const { return _modal; }
509   //! Returns if the window is shaded
510   /*!
511     When the window is shaded, only its titlebar is visible.
512   */
513   inline bool shaded() const { return _shaded; }
514   //! Returns if the window is in fullscreen mode
515   inline bool fullscreen() const { return _fullscreen; }
516   //! Returns if the window is iconified
517   /*!
518     When the window is iconified, it is not visible at all (except in iconbars/
519     panels/etc that want to show lists of iconified windows
520   */
521   inline bool iconic() const { return _iconic; }
522   //! Returns if the window is maximized vertically
523   inline bool maxVert() const { return _max_vert; }
524   //! Returns if the window is maximized horizontally
525   inline bool maxHorz() const { return _max_horz; }
526   //! Returns the window's stacking layer
527   inline StackLayer layer() const { return _layer; }
528
529   //! Applies the states requested when the window mapped
530   /*!
531     This should be called only once, during the window mapping process. It
532     applies things like maximized, and fullscreen.
533   */
534   void applyStartupState();
535   
536   //! Removes or reapplies the client's border to its window
537   /*!
538     Used when managing and unmanaging a window.
539     @param addborder true if adding the border to the client; false if removing
540                      from the client
541   */
542   void toggleClientBorder(bool addborder);
543
544   //! Returns the position and size of the client relative to the root window
545   inline const otk::Rect &area() const { return _area; }
546
547   //! Returns the client's strut definition
548   inline const otk::Strut &strut() const { return _strut; }
549
550   //! Move the client window
551   /*!
552     @param x The X coordinate to move to.
553     @param y The Y coordinate to move to.
554   */
555   void move(int x, int y);
556   
557   //! Resizes the client window, anchoring it in a given corner
558   /*!
559     This also maintains things like the client's minsize, and size increments.
560     @param anchor The corner to keep in the same position when resizing.
561     @param w The width component of the new size for the client.
562     @param h The height component of the new size for the client.
563   */
564   void resize(Corner anchor, int w, int h);
565
566   //! Attempt to focus the client window
567   bool focus() const;
568
569   //! Remove focus from the client window
570   void unfocus() const;
571
572   virtual void focusHandler(const XFocusChangeEvent &e);
573   virtual void unfocusHandler(const XFocusChangeEvent &e);
574   virtual void propertyHandler(const XPropertyEvent &e);
575   virtual void clientMessageHandler(const XClientMessageEvent &e);
576   virtual void configureRequestHandler(const XConfigureRequestEvent &e);
577   virtual void unmapHandler(const XUnmapEvent &e);
578   virtual void destroyHandler(const XDestroyWindowEvent &e);
579   virtual void reparentHandler(const XReparentEvent &e);
580 #if defined(SHAPE)
581   virtual void shapeHandler(const XShapeEvent &e);
582 #endif // SHAPE 
583 };
584
585 }
586
587 #endif // __client_hh