1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
6 @brief Screen manages a single screen
13 #include "otk/strut.hh"
14 #include "otk/rect.hh"
15 #include "otk/screeninfo.hh"
16 #include "otk/eventhandler.hh"
17 #include "otk/property.hh"
18 #include "otk/ustring.hh"
27 struct DesktopLayout {
28 enum Corner { TopLeft, TopRight, BottomRight, BottomLeft };
29 enum Direction { Horizontal, Vertical };
31 Direction orientation;
37 //! Manages a single screen
40 class Screen : public otk::EventHandler {
42 //! Holds a list of otk::Strut objects
43 typedef std::vector<otk::Strut> StrutList;
44 //! Holds a list of otk::Rect objects
45 typedef std::vector<otk::Rect> RectList;
47 static const unsigned long event_mask = ColormapChangeMask |
51 SubstructureNotifyMask |
52 SubstructureRedirectMask |
56 //! Holds a list of Clients
57 typedef std::list<Client*> ClientList;
58 //! All managed clients on the screen (in order of being mapped)
62 //! Was %Openbox able to manage the screen?
65 //! The number of the screen on the X server
68 //! Information about this screen
69 const otk::ScreenInfo *_info;
71 //! Area usable for placement etc (total - struts), one per desktop,
72 //! plus one extra for windows on all desktops
75 //! Combined strut from all of the clients' struts, one per desktop,
76 //! plus one extra for windows on all desktops
79 //! An offscreen window which gets focus when nothing else has it
82 //! An offscreen window which shows that a NETWM compliant window manager is
84 Window _supportwindow;
86 //! A list of all managed clients on the screen, in their stacking order
89 //! The desktop currently being displayed
90 unsigned int _desktop;
92 //! The number of desktops
93 unsigned int _num_desktops;
95 //! The names of all desktops
96 otk::Property::StringVect _desktop_names;
98 //! The layout of the desktops as specified by an EWMH compliant pager
99 DesktopLayout _layout;
101 //! True when the window manager is in 'showing desktop' mode
102 bool _showing_desktop;
104 //! Calculate the Screen::_area member
106 //! Set the list of supported NETWM atoms on the root window
107 void changeSupportedAtoms();
108 //! Set the client list on the root window
110 Sets the _NET_CLIENT_LIST root window property.<br>
111 Also calls Screen::updateStackingList.
113 void changeClientList();
114 //! Set the client stacking list on the root window
116 Set the _NET_CLIENT_LIST_STACKING root window property.
118 void changeStackingList();
119 //! Set the work area hint on the root window
121 Set the _NET_WORKAREA root window property.
123 void changeWorkArea();
125 //! Get desktop names from the root window property
126 void updateDesktopNames();
128 //! Gets the layout of the desktops from the root window property
129 void updateDesktopLayout();
131 //! Changes to the specified desktop, displaying windows on it and hiding
132 //! windows on the others.
134 @param desktop The number of the desktop to switch to (starts from 0).
135 If the desktop is out of valid range, it is ignored.
137 void changeDesktop(unsigned int desktop);
139 //! Changes the number of desktops.
141 @param num The number of desktops that should exist. This value must be
142 greater than 0 or it will be ignored.
144 void changeNumDesktops(unsigned int num);
148 //! Constructs a new Screen object
150 //! Destroys the Screen object
154 inline int number() const { return _number; }
156 //! Returns if the screen was successfully managed
158 If this is false, then the screen should be deleted and should NOT be
161 inline bool managed() const { return _managed; }
162 //! An offscreen window which gets focus when nothing else has it
163 inline Window focuswindow() const { return _focuswindow; }
164 //! Returns the desktop being displayed
165 inline unsigned int desktop() const { return _desktop; }
166 //! Returns the number of desktops
167 inline unsigned int numDesktops() const { return _num_desktops; }
168 //! When true, the desktop is being shown and all clients are hidden
169 inline bool showingDesktop() const { return _showing_desktop; }
171 //! Returns the area of the screen not reserved by applications' Struts
173 @param desktop The desktop number of the area to retrieve for. A value of
174 0xffffffff will return an area that combines all struts
177 const otk::Rect& area(unsigned int desktop) const;
179 const DesktopLayout& desktopLayout() const { return _layout; }
181 //! Shows and focuses the desktop and hides all the client windows, or
182 //! returns to the normal state, showing client windows.
183 void showDesktop(bool show);
185 //! Update's the screen's combined strut of all the clients.
187 Clients should call this whenever they change their strut.
191 //! Manage any pre-existing windows on the screen
192 void manageExisting();
193 //! Manage a client window
195 This gives the window a frame, reparents it, selects events on it, etc.
197 void manageWindow(Window window);
198 //! Unmanage a client
200 This removes the window's frame, reparents it to root, unselects events on
202 @param client The client to unmanage
204 void unmanageWindow(Client *client);
206 //! Raises a client window above all others in its stacking layer
208 raiseWindow has a couple of constraints that lowerWindow does not.<br>
209 1) raiseWindow can be called after changing a Client's stack layer, and
210 the list will be reorganized properly.<br>
211 2) raiseWindow guarantees that XRestackWindows() will <i>always</i> be
212 called for the specified client.
214 void raiseWindow(Client *client);
216 //! Lowers a client window below all others in its stacking layer
217 void lowerWindow(Client *client);
219 //! Sets the name of a desktop by changing the root window property
221 @param i The index of the desktop to set the name for (starts at 0)
222 @param name The name to set for the desktop
223 If the index is too large, it is simply ignored.
225 void setDesktopName(unsigned int i, const otk::ustring &name);
227 otk::ustring desktopName(unsigned int i) const;
229 void installColormap(bool install) const;
231 virtual void propertyHandler(const XPropertyEvent &e);
232 virtual void clientMessageHandler(const XClientMessageEvent &e);
233 virtual void mapRequestHandler(const XMapRequestEvent &e);