src/frame.hh

   1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
   2 #ifndef   __frame_hh
   3 #define   __frame_hh
   4
   5 /*! @file frame.hh
   6 */
   7
   8 extern "C" {
   9 #include <X11/Xlib.h>
  10 }
  11
  12 #include "client.hh"
  13 #include "backgroundwidget.hh"
  14 #include "labelwidget.hh"
  15 #include "buttonwidget.hh"
  16 #include "otk/strut.hh"
  17 #include "otk/rect.hh"
  18 #include "otk/screeninfo.hh"
  19 #include "otk/style.hh"
  20 #include "otk/widget.hh"
  21
  22 #include <string>
  23
  24 namespace ob {
  25
  26 //! Holds and decorates a frame around an OBClient (client window)
  27 /*!
  28   The frame is responsible for calling XSelectInput on the client window's new
  29   parent with the SubstructureRedirectMask so that structure events for the
  30   client are sent to the window manager.
  31 */
  32 class OBFrame : public otk::OtkWidget, public OBWidget {
  33 public:
  34
  35   //! The event mask to grab on frame windows
  36   static const long event_mask = EnterWindowMask | LeaveWindowMask;
  37
  38 private:
  39   OBClient *_client;
  40   const otk::ScreenInfo *_screen;
  41
  42   //! The style to use for size and display the decorations
  43   otk::Style *_style;
  44
  45   //! The size of the frame on each side of the client window
  46   otk::Strut _size;
  47
  48   //! The size of the frame on each side of the client window inside the border
  49   otk::Strut _innersize;
  50
  51   // decoration windows
  52   OBBackgroundWidget  _plate;   // sits entirely under the client window
  53   OBBackgroundWidget  _titlebar;
  54   OBButtonWidget      _button_close;
  55   OBButtonWidget      _button_iconify;
  56   OBButtonWidget      _button_max;
  57   OBButtonWidget      _button_stick;
  58   OBLabelWidget       _label;
  59   OBBackgroundWidget  _handle;
  60   OBButtonWidget      _grip_left;
  61   OBButtonWidget      _grip_right;
  62
  63   //! The decorations to display on the window.
  64   /*!
  65     This is by default the same value as in the OBClient::decorations, but it
  66     is duplicated here so that it can be overridden per-window by the user.
  67   */
  68   OBClient::DecorationFlags _decorations;
  69
  70   //! Reparents the client window from the root window onto the frame
  71   void grabClient();
  72   //! Reparents the client window back to the root window
  73   /*!
  74     @param remap Re-map the client window when we're done reparenting?
  75   */
  76   void releaseClient(bool remap);
  77
  78 public:
  79   //! Constructs an OBFrame object, and reparents the client to itself
  80   /*!
  81     @param client The client window which will be decorated by the new OBFrame
  82     @param style The style to use to decorate the frame
  83   */
  84   OBFrame(OBClient *client, otk::Style *style);
  85   //! Destroys the OBFrame object
  86   virtual ~OBFrame();
  87
  88   //! Set the style to decorate the frame with
  89   virtual void setStyle(otk::Style *style);
  90
  91   //! Empty overridden method to prevent automatic alignment of children
  92   virtual void adjust();
  93
  94   //! Displays focused decorations
  95   virtual void focus();
  96   //! Displays unfocused decorations
  97   virtual void unfocus();
  98
  99   void setTitle(const std::string &text);
 100
 101   //! Update the frame's size to match the client
 102   void adjustSize();
 103   //! Update the frame's position to match the client
 104   void adjustPosition();
 105   //! Shape the frame window to the client window
 106   void adjustShape();
 107
 108   //! Applies gravity to the client's position to find where the frame should
 109   //! be positioned.
 110   /*!
 111     @return The proper coordinates for the frame, based on the client.
 112   */
 113   void clientGravity(int &x, int &y);
 114
 115   //! Reversly applies gravity to the frame's position to find where the client
 116   //! should be positioned.
 117   /*!
 118     @return The proper coordinates for the client, based on the frame.
 119   */
 120   void frameGravity(int &x, int &y);
 121
 122   //! Gets the window id of the frame's "plate" subelement
 123   inline Window plate() const { return _plate.window(); }
 124   //! Gets the window id of the frame's "titlebar" subelement
 125   inline Window titlebar() const { return _titlebar.window(); }
 126   //! Gets the window id of the frame's "label" subelement
 127   inline Window label() const { return _label.window(); }
 128   //! Gets the window id of the frame's "close button" subelement
 129   inline Window button_close() const { return _button_close.window(); }
 130   //! Gets the window id of the frame's "iconify button" subelement
 131   inline Window button_iconify() const { return _button_iconify.window(); }
 132   //! Gets the window id of the frame's "maximize button" subelement
 133   inline Window button_max() const { return _button_max.window(); }
 134   //! Gets the window id of the frame's "sticky button" subelement
 135   inline Window button_stick() const { return _button_stick.window(); }
 136   //! Gets the window id of the frame's "handle" subelement
 137   inline Window handle() const { return _handle.window(); }
 138   //! Gets the window id of the frame's "left grip" subelement
 139   inline Window grip_left() const { return _grip_left.window(); }
 140   //! Gets the window id of the frame's "right grip" subelement
 141   inline Window grip_right() const { return _grip_right.window(); }
 142
 143 };
 144
 145 }
 146
 147 #endif // __frame_hh