frames' subemelents are created and positioned and everything
[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 OBClient class maintains the state of a client window by handling
7   property changes on the window and some client messages
8 */
9
10 extern "C" {
11 #include <X11/Xlib.h>
12
13 #ifdef    SHAPE
14 #include <X11/extensions/shape.h>
15 #endif // SHAPE
16 }
17
18 #include <string>
19
20 #include "otk/strut.hh"
21 #include "otk/rect.hh"
22
23 namespace ob {
24
25 class OBFrame;
26
27 //! Maintains the state of a client window.
28 /*!
29   OBClient maintains the state of a client window. The state consists of the
30   hints that the application sets on the window, such as the title, or window
31   gravity.
32   <p>
33   OBClient also manages client messages for the client window. When the
34   application (or any application) requests something to be changed for the
35   client, it will call the ActionHandler (for client messages) or update the
36   class' member variables and call whatever is nessary to complete the
37   change (such as causing a redraw of the titlebar after the title is changed).
38 */
39 class OBClient {
40 public:
41
42   //! The frame window which decorates around the client window
43   OBFrame *frame;
44   
45   //! Possible window types
46   enum WindowType { Type_Desktop, //!< A desktop (bottom-most window)
47                     Type_Dock,    //!< A dock bar/panel window
48                     Type_Toolbar, //!< A toolbar window, pulled off an app
49                     Type_Menu,    //!< A sticky menu from an app
50                     Type_Utility, //!< A small utility window such as a palette
51                     Type_Splash,  //!< A splash screen window
52                     Type_Dialog,  //!< A dialog window
53                     Type_Normal   //!< A normal application window
54   };
55
56   //! Possible flags for MWM Hints (defined by Motif 2.0)
57   enum MwmFlags { MwmFlag_Functions   = 1 << 0, //!< The MMW Hints define funcs
58                   MwmFlag_Decorations = 1 << 1  //!< The MWM Hints define decor
59   };
60
61   //! Possible functions for MWM Hints (defined by Motif 2.0)
62   enum MwmFunctions { MwmFunc_All      = 1 << 0, //!< All functions
63                       MwmFunc_Resize   = 1 << 1, //!< Allow resizing
64                       MwmFunc_Move     = 1 << 2, //!< Allow moving
65                       MwmFunc_Iconify  = 1 << 3, //!< Allow to be iconfied
66                       MwmFunc_Maximize = 1 << 4  //!< Allow to be maximized
67                       //MwmFunc_Close    = 1 << 5 //!< Allow to be closed
68   };
69
70   //! Possible decorations for MWM Hints (defined by Motif 2.0)
71   enum MemDecorations { MwmDecor_All      = 1 << 0, //!< All decorations
72                         MwmDecor_Border   = 1 << 1, //!< Show a border
73                         MwmDecor_Handle   = 1 << 2, //!< Show a handle (bottom)
74                         MwmDecor_Title    = 1 << 3, //!< Show a titlebar
75                         //MwmDecor_Menu     = 1 << 4, //!< Show a menu
76                         MwmDecor_Iconify  = 1 << 5, //!< Show an iconify button
77                         MwmDecor_Maximize = 1 << 6  //!< Show a maximize button
78   };
79
80   //! The things the user can do to the client window
81   enum Function { Func_Resize   = 1 << 0, //!< Allow resizing
82                   Func_Move     = 1 << 1, //!< Allow moving
83                   Func_Iconify  = 1 << 2, //!< Allow to be iconified
84                   Func_Maximize = 1 << 3, //!< Allow to be maximized
85                   Func_Close    = 1 << 4  //!< Allow to be closed
86   };
87   //! Holds a bitmask of OBClient::Function values
88   typedef unsigned char FunctionFlags;
89
90   //! The decorations the client window wants to be displayed on it
91   enum Decoration { Decor_Titlebar = 1 << 0, //!< Display a titlebar
92                     Decor_Handle   = 1 << 1, //!< Display a handle (bottom)
93                     Decor_Border   = 1 << 2, //!< Display a border
94                     Decor_Iconify  = 1 << 3, //!< Display an iconify button
95                     Decor_Maximize = 1 << 4, //!< Display a maximize button
96                     Decor_Sticky   = 1 << 5, //!< Display a sticky button
97                     Decor_Close    = 1 << 6  //!< Display a close button
98   };
99   //! Holds a bitmask of OBClient::Decoration values
100   typedef unsigned char DecorationFlags;
101
102   //! The MWM Hints as retrieved from the window property
103   /*!
104     This structure only contains 3 elements, even though the Motif 2.0
105     structure contains 5. We only use the first 3, so that is all gets defined.
106   */
107   typedef struct MwmHints {
108     //! The number of elements in the OBClient::MwmHints struct
109     static const unsigned int elements = 3;
110     unsigned long flags;      //!< A bitmask of OBClient::MwmFlags values
111     unsigned long functions;  //!< A bitmask of OBClient::MwmFunctions values
112     unsigned long decorations;//!< A bitmask of OBClient::MwmDecorations values
113   };
114
115   //! Possible actions that can be made with the _NET_WM_STATE client message
116   enum StateAction { State_Remove = 0, //!< _NET_WM_STATE_REMOVE
117                      State_Add,        //!< _NET_WM_STATE_ADD
118                      State_Toggle      //!< _NET_WM_STATE_TOGGLE
119   };
120
121   //! The event mask to grab on client windows
122   static const long event_mask = PropertyChangeMask | FocusChangeMask |
123                                  StructureNotifyMask;
124
125 private:
126   //! The screen number on which the client resides
127   int      _screen;
128   
129   //! The actual window that this class is wrapping up
130   Window   _window;
131
132   //! The id of the group the window belongs to
133   Window   _group;
134
135   // XXX: transient_for, transients
136
137   //! The desktop on which the window resides (0xffffffff for all desktops)
138   unsigned long _desktop;
139
140   //! Normal window title
141   std::string  _title; // XXX: Have to keep track if this string is Utf8 or not
142   //! Window title when iconifiged
143   std::string  _icon_title;
144
145   //! The application that created the window
146   std::string  _app_name;
147   //! The class of the window, can used for grouping
148   std::string  _app_class;
149
150   //! The type of window (what its function is)
151   WindowType   _type;
152
153   //! Position and size of the window (relative to the root window)
154   otk::Rect    _area;
155
156   //! Width of the border on the window.
157   /*!
158     The window manager will set this to 0 while the window is being managed,
159     but needs to restore it afterwards, so it is saved here.
160   */
161   int _border_width;
162
163   //! The minimum width of the client window
164   /*!
165     If the min is > the max, then the window is not resizable
166   */
167   int _min_x;
168   //! The minimum height of the client window
169   /*!
170     If the min is > the max, then the window is not resizable
171   */
172   int _min_y;
173   //! The maximum width of the client window
174   /*!
175     If the min is > the max, then the window is not resizable
176   */
177   int _max_x;
178   //! The maximum height of the client window
179   /*!
180     If the min is > the max, then the window is not resizable
181   */
182   int _max_y;
183   //! The size of increments to resize the client window by (for the width)
184   int _inc_x;
185   //! The size of increments to resize the client window by (for the height)
186   int _inc_y;
187   //! The base width of the client window
188   /*!
189     This value should be subtracted from the window's actual width when
190     displaying its size to the user, or working with its min/max width
191   */
192   int _base_x;
193   //! The base height of the client window
194   /*!
195     This value should be subtracted from the window's actual height when
196     displaying its size to the user, or working with its min/max height
197   */
198   int _base_y;
199
200   //! Where to place the decorated window in relation to the undecorated window
201   int _gravity;
202
203   //! The state of the window, one of WithdrawnState, IconicState, or
204   //! NormalState
205   long _wmstate;
206
207   //! Was the window's position requested by the application? if not, we should
208   //! place the window ourselves when it first appears
209   bool _positioned;
210   
211   //! Can the window receive input focus?
212   bool _can_focus;
213   //! Urgency flag
214   bool _urgent;
215   //! Notify the window when it receives focus?
216   bool _focus_notify;
217
218   //! The window uses shape extension to be non-rectangular?
219   bool _shaped;
220
221   //! The window is modal, so it must be processed before any windows it is
222   //! related to can be focused
223   bool _modal;
224   //! Only the window's titlebar is displayed
225   bool _shaded;
226   //! The window is iconified
227   bool _iconic;
228   //! The window is maximized to fill the screen vertically
229   bool _max_vert;
230   //! The window is maximized to fill the screen horizontally
231   bool _max_horz;
232   //! The window is a 'fullscreen' window, and should be on top of all others
233   bool _fullscreen;
234   //! The window should be on top of other windows of the same type
235   bool _floating;
236
237   //! A bitmask of values in the OBClient::Decoration enum
238   /*!
239     The values in the variable are the decorations that the client wants to be
240     displayed around it.
241   */
242   DecorationFlags _decorations;
243
244   //! A bitmask of values in the OBClient::Function enum
245   /*!
246     The values in the variable specify the ways in which the user is allowed to
247     modify this window.
248   */
249   FunctionFlags _functions;
250
251   //! Retrieves the desktop hint's value and sets OBClient::_desktop
252   void getDesktop();
253   //! Retrieves the window's type and sets OBClient::_type
254   void getType();
255   //! Gets the MWM Hints and adjusts OBClient::_functions and
256   //! OBClient::_decorations
257   void getMwmHints();
258   //! Gets the position and size of the window and sets OBClient::_area
259   void getArea();
260   //! Gets the net_state hint and sets the boolean flags for any states set in
261   //! the hint
262   void getState();
263   //! Determines if the window uses the Shape extension and sets
264   //! OBClient::_shaped
265   void getShaped();
266
267   //! Sets the wm_state to the specified value
268   void setWMState(long state);
269   //! Sends the window to the specified desktop
270   void setDesktop(long desktop);
271   //! Adjusts the window's net_state
272   void setState(StateAction action, long data1, long data2);
273
274   //! Update the protocols that the window supports and adjusts things if they
275   //! change
276   void updateProtocols();
277   //! Updates the WMNormalHints and adjusts things if they change
278   void updateNormalHints();
279   //! Updates the WMHints and adjusts things if they change
280   void updateWMHints();
281   //! Updates the window's title
282   void updateTitle();
283   //! Updates the window's icon title
284   void updateIconTitle();
285   //! Updates the window's application name and class
286   void updateClass();
287   // XXX: updateTransientFor();
288
289 public:
290   //! Constructs a new OBClient object around a specified window id
291   /*!
292     @param window The window id that the OBClient class should handle
293     @param screen The screen on which the window resides
294   */
295   OBClient(int screen, Window window);
296   //! Destroys the OBClient object
297   virtual ~OBClient();
298
299   //! Returns the screen on which the clien resides
300   inline int screen() const { return _screen; }
301   
302   //! Returns the window id that the OBClient object is handling
303   inline Window window() const { return _window; }
304
305   //! Returns the type of the window, one of the OBClient::WindowType values
306   inline WindowType type() const { return _type; }
307   //! Returns the desktop on which the window resides
308   /*!
309     This value is a 0-based index.<br>
310     A value of 0xffffffff indicates that the window exists on all desktops.
311   */
312   inline unsigned long desktop() const { return _desktop; }
313   //! Returns the window's title
314   inline const std::string &title() const { return _title; }
315   //! Returns the window's title when it is iconified
316   inline const std::string &iconTitle() const { return _title; }
317   //! Returns the application's name to whom the window belongs
318   inline const std::string &appName() const { return _app_name; }
319   //! Returns the class of the window
320   inline const std::string &appClass() const { return _app_class; }
321   //! Returns if the window can be focused
322   /*!
323     @return true if the window can receive focusl otherwise, false
324   */
325   inline bool canFocus() const { return _can_focus; }
326   //! Returns if the window has indicated that it needs urgent attention
327   inline bool urgent() const { return _urgent; }
328   //! Returns if the window wants to be notified when it receives focus
329   inline bool focusNotify() const { return _focus_notify; }
330   //! Returns if the window uses the Shape extension
331   inline bool shaped() const { return _shaped; }
332   //! Returns the window's gravity
333   /*!
334     This value determines where to place the decorated window in relation to
335     its position without decorations.<br>
336     One of: NorthWestGravity, SouthWestGravity, EastGravity, ...,
337     SouthGravity, StaticGravity, ForgetGravity
338   */
339   inline int gravity() const { return _gravity; }
340   //! Returns if the application requested the initial position for the window
341   /*!
342     If the application did not request a position (this function returns false)
343     then the window should be placed intelligently by the window manager
344     initially
345   */
346   inline bool positionRequested() const { return _positioned; }
347   //! Returns the decorations that the client window wishes to be displayed on
348   //! it
349   inline DecorationFlags decorations() const { return _decorations; }
350   //! Returns the functions that the user can perform on the window
351   inline FunctionFlags funtions() const { return _functions; }
352
353   //! Returns if the window is modal
354   /*!
355     If the window is modal, then no other windows that it is related to can get
356     focus while it exists/remains modal.
357   */
358   inline bool modal() const { return _modal; }
359   //! Returns if the window is shaded
360   /*!
361     When the window is shaded, only its titlebar is visible, the client itself
362     is not mapped
363   */
364   inline bool shaded() const { return _shaded; }
365   //! Returns if the window is iconified
366   /*!
367     When the window is iconified, it is not visible at all (except in iconbars/
368     panels/etc that want to show lists of iconified windows
369   */
370   inline bool iconic() const { return _iconic; }
371   //! Returns if the window is maximized vertically
372   inline bool maxVert() const { return _max_vert; }
373   //! Returns if the window is maximized horizontally
374   inline bool maxHorz() const { return _max_horz; }
375   //! Returns if the window is fullscreen
376   /*!
377     When the window is fullscreen, it is kept above all others
378   */
379   inline bool fullscreen() const { return _fullscreen; }
380   //! Returns if the window is floating
381   /*!
382     When the window is floating, it is kept above all others in the same
383     stacking layer as it
384   */
385   inline bool floating() const { return _floating; }
386
387   //! Returns the window's border width
388   /*!
389     The border width is set to 0 when the client becomes managed, but the
390     border width is stored here so that it can be restored to the client window
391     when it is unmanaged later.
392   */
393   inline int borderWidth() const { return _border_width; }
394   //! Returns the minimum width of the client window
395   /*!
396     If the min is > the max, then the window is not resizable
397   */
398   inline int minX() const { return _min_x; }
399   //! Returns the minimum height of the client window
400   /*!
401     If the min is > the max, then the window is not resizable
402   */
403   inline int minY() const { return _min_y; }
404   //! Returns the maximum width of the client window
405   /*!
406     If the min is > the max, then the window is not resizable
407   */
408   inline int maxX() const { return _max_x; }
409   //! Returns the maximum height of the client window
410   /*!
411     If the min is > the max, then the window is not resizable
412   */
413   inline int maxY() const { return _max_y; }
414   //! Returns the increment size for resizing the window (for the width)
415   inline int incrementX() const { return _inc_x; }
416   //! Returns the increment size for resizing the window (for the height)
417   inline int incrementY() const { return _inc_y; }
418   //! Returns the base width of the window
419   /*!
420     This value should be subtracted from the window's actual width when
421     displaying its size to the user, or working with its min/max width
422   */
423   inline int baseX() const { return _base_x; }
424   //! Returns the base height of the window
425   /*!
426     This value should be subtracted from the window's actual height when
427     displaying its size to the user, or working with its min/max height
428   */
429   inline int baseY() const { return _base_y; }
430
431   //! Returns the position and size of the client relative to the root window
432   inline const otk::Rect &area() const { return _area; }
433
434   //! Updates the OBClient class from a property change XEvent
435   void update(const XPropertyEvent &e);
436   //! Processes a client message XEvent for the window and causes an action
437   //! or whatever was specified to occur
438   void update(const XClientMessageEvent &e);
439 #if defined(SHAPE) || defined(DOXYGEN_IGNORE)
440   //! Updates the client's shape status
441   void update(const XShapeEvent &e);
442 #endif
443
444   //! Changes the stored positions and size of the OBClient window
445   /*!
446     This does not actually change the physical geometry, that needs to be done
447     before/after setting this value to keep it in sync
448   */
449   void setArea(const otk::Rect &area);
450 };
451
452 }
453
454 #endif // __client_hh