1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
6 @brief Screen manages a single screen
14 #include "otk/strut.hh"
15 #include "otk/rect.hh"
16 #include "otk/screeninfo.hh"
17 #include "otk/eventhandler.hh"
18 #include "otk/property.hh"
19 #include "otk/ustring.hh"
28 struct DesktopLayout {
29 enum Corner { TopLeft, TopRight, BottomRight, BottomLeft };
30 enum Direction { Horizontal, Vertical };
32 Direction orientation;
38 //! Manages a single screen
41 class Screen : public otk::EventHandler {
43 //! Holds a list of otk::Strut objects
44 typedef std::vector<otk::Strut> StrutList;
45 //! Holds a list of otk::Rect objects
46 typedef std::vector<otk::Rect> RectList;
48 static const unsigned long event_mask = ColormapChangeMask |
52 SubstructureNotifyMask |
53 SubstructureRedirectMask |
57 //! All managed clients on the screen (in order of being mapped)
58 std::list<Client*> clients;
61 //! Was %Openbox able to manage the screen?
64 //! The number of the screen on the X server
67 //! Information about this screen
68 const otk::ScreenInfo *_info;
70 //! Configuration options from the user scripts
73 //! Area usable for placement etc (total - struts), one per desktop,
74 //! plus one extra for windows on all desktops
77 //! Combined strut from all of the clients' struts, one per desktop,
78 //! plus one extra for windows on all desktops
81 //! An offscreen window which gets focus when nothing else has it
84 //! An offscreen window which shows that a NETWM compliant window manager is
86 Window _supportwindow;
88 //! A list of all managed clients on the screen, in their stacking order
89 std::list<Client*> _stacking;
91 //! The desktop currently being displayed
92 unsigned int _desktop;
94 //! The number of desktops
95 unsigned int _num_desktops;
97 //! The names of all desktops
98 otk::Property::StringVect _desktop_names;
100 //! The layout of the desktops as specified by an EWMH compliant pager
101 DesktopLayout _layout;
103 //! True when the window manager is in 'showing desktop' mode
104 bool _showing_desktop;
106 //! Calculate the Screen::_area member
108 //! Set the list of supported NETWM atoms on the root window
109 void changeSupportedAtoms();
110 //! Set the client list on the root window
112 Sets the _NET_CLIENT_LIST root window property.<br>
113 Also calls Screen::updateStackingList.
115 void changeClientList();
116 //! Set the client stacking list on the root window
118 Set the _NET_CLIENT_LIST_STACKING root window property.
120 void changeStackingList();
121 //! Set the work area hint on the root window
123 Set the _NET_WORKAREA root window property.
125 void changeWorkArea();
127 //! Get desktop names from the root window property
128 void updateDesktopNames();
130 //! Gets the layout of the desktops from the root window property
131 void updateDesktopLayout();
133 //! Changes to the specified desktop, displaying windows on it and hiding
134 //! windows on the others.
136 @param desktop The number of the desktop to switch to (starts from 0).
137 If the desktop is out of valid range, it is ignored.
139 void changeDesktop(unsigned int desktop);
141 //! Changes the number of desktops.
143 @param num The number of desktops that should exist. This value must be
144 greater than 0 or it will be ignored.
146 void changeNumDesktops(unsigned int num);
149 //! Constructs a new Screen object
151 //! 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; }
163 //! Returns the config options set by the user scripts
164 Config& config() { return _config; }
166 //! An offscreen window which gets focus when nothing else has it
167 inline Window focuswindow() const { return _focuswindow; }
168 //! Returns the desktop being displayed
169 inline unsigned int desktop() const { return _desktop; }
170 //! Returns the number of desktops
171 inline unsigned int numDesktops() const { return _num_desktops; }
172 //! When true, the desktop is being shown and all clients are hidden
173 inline bool showingDesktop() const { return _showing_desktop; }
175 //! Returns the area of the screen not reserved by applications' Struts
177 @param desktop The desktop number of the area to retrieve for. A value of
178 0xffffffff will return an area that combines all struts
181 const otk::Rect& area(unsigned int desktop) const;
183 //! Gives the layout of how the desktops are being displayed, the number of
184 //! rows and columns etc.
185 const DesktopLayout& desktopLayout() const { return _layout; }
187 //! Shows and focuses the desktop and hides all the client windows, or
188 //! returns to the normal state, showing client windows.
189 void showDesktop(bool show);
191 //! Update's the screen's combined strut of all the clients.
193 Clients should call this whenever they change their strut.
197 //! Manage any pre-existing windows on the screen
198 void manageExisting();
199 //! Manage a client window
201 This gives the window a frame, reparents it, selects events on it, etc.
203 void manageWindow(Window window);
204 //! Unmanage a client
206 This removes the window's frame, reparents it to root, unselects events on
208 @param client The client to unmanage
210 void unmanageWindow(Client *client);
212 //! Raises a client window above all others in its stacking layer
214 raiseWindow has a couple of constraints that lowerWindow does not.<br>
215 1) raiseWindow can be called after changing a Client's stack layer, and
216 the list will be reorganized properly.<br>
217 2) raiseWindow guarantees that XRestackWindows() will <i>always</i> be
218 called for the specified client.
220 void raiseWindow(Client *client);
222 //! Lowers a client window below all others in its stacking layer
223 void lowerWindow(Client *client);
225 //! Sets the name of a desktop by changing the root window property
227 @param i The index of the desktop to set the name for (starts at 0)
228 @param name The name to set for the desktop
229 If the index is too large, it is simply ignored.
231 void setDesktopName(unsigned int i, const otk::ustring &name);
233 otk::ustring desktopName(unsigned int i) const;
235 void installColormap(bool install) const;
237 virtual void propertyHandler(const XPropertyEvent &e);
238 virtual void clientMessageHandler(const XClientMessageEvent &e);
239 virtual void mapRequestHandler(const XMapRequestEvent &e);