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