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