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 //! All managed clients on the screen (in order of being mapped)
57 std::list
<Client
*> clients
;
60 //! Was %Openbox able to manage the screen?
63 //! The number of the screen on the X server
66 //! Information about this screen
67 const otk::ScreenInfo
*_info
;
69 //! Area usable for placement etc (total - struts), one per desktop,
70 //! plus one extra for windows on all desktops
73 //! Combined strut from all of the clients' struts, one per desktop,
74 //! plus one extra for windows on all desktops
77 //! An offscreen window which gets focus when nothing else has it
80 //! An offscreen window which shows that a NETWM compliant window manager is
82 Window _supportwindow
;
84 //! A list of all managed clients on the screen, in their stacking order
85 std::list
<Client
*> _stacking
;
87 //! The desktop currently being displayed
88 unsigned int _desktop
;
90 //! The number of desktops
91 unsigned int _num_desktops
;
93 //! The names of all desktops
94 otk::Property::StringVect _desktop_names
;
96 //! The layout of the desktops as specified by an EWMH compliant pager
97 DesktopLayout _layout
;
99 //! True when the window manager is in 'showing desktop' mode
100 bool _showing_desktop
;
102 //! Calculate the Screen::_area member
104 //! Set the list of supported NETWM atoms on the root window
105 void changeSupportedAtoms();
106 //! Set the client list on the root window
108 Sets the _NET_CLIENT_LIST root window property.<br>
109 Also calls Screen::updateStackingList.
111 void changeClientList();
112 //! Set the client stacking list on the root window
114 Set the _NET_CLIENT_LIST_STACKING root window property.
116 void changeStackingList();
117 //! Set the work area hint on the root window
119 Set the _NET_WORKAREA root window property.
121 void changeWorkArea();
123 //! Get desktop names from the root window property
124 void updateDesktopNames();
126 //! Gets the layout of the desktops from the root window property
127 void updateDesktopLayout();
129 //! Changes to the specified desktop, displaying windows on it and hiding
130 //! windows on the others.
132 @param desktop The number of the desktop to switch to (starts from 0).
133 If the desktop is out of valid range, it is ignored.
135 void changeDesktop(unsigned int desktop
);
137 //! Changes the number of desktops.
139 @param num The number of desktops that should exist. This value must be
140 greater than 0 or it will be ignored.
142 void changeNumDesktops(unsigned int num
);
145 //! Constructs a new Screen object
147 //! Destroys the Screen object
150 inline int number() const { return _number
; }
152 //! Returns if the screen was successfully managed
154 If this is false, then the screen should be deleted and should NOT be
157 inline bool managed() const { return _managed
; }
159 //! An offscreen window which gets focus when nothing else has it
160 inline Window
focuswindow() const { return _focuswindow
; }
161 //! Returns the desktop being displayed
162 inline unsigned int desktop() const { return _desktop
; }
163 //! Returns the number of desktops
164 inline unsigned int numDesktops() const { return _num_desktops
; }
165 //! When true, the desktop is being shown and all clients are hidden
166 inline bool showingDesktop() const { return _showing_desktop
; }
168 //! Returns the area of the screen not reserved by applications' Struts
170 @param desktop The desktop number of the area to retrieve for. A value of
171 0xffffffff will return an area that combines all struts
174 const otk::Rect
& area(unsigned int desktop
) const;
176 //! Gives the layout of how the desktops are being displayed, the number of
177 //! rows and columns etc.
178 const DesktopLayout
& desktopLayout() const { return _layout
; }
180 //! Shows and focuses the desktop and hides all the client windows, or
181 //! returns to the normal state, showing client windows.
182 void showDesktop(bool show
);
184 //! Update's the screen's combined strut of all the clients.
186 Clients should call this whenever they change their strut.
190 //! Manage any pre-existing windows on the screen
191 void manageExisting();
192 //! Manage a client window
194 This gives the window a frame, reparents it, selects events on it, etc.
196 void manageWindow(Window window
);
197 //! Unmanage a client
199 This removes the window's frame, reparents it to root, unselects events on
201 @param client The client to unmanage
203 void unmanageWindow(Client
*client
);
205 //! Raises a client window above all others in its stacking layer
207 raiseWindow has a couple of constraints that lowerWindow does not.<br>
208 1) raiseWindow can be called after changing a Client's stack layer, and
209 the list will be reorganized properly.<br>
210 2) raiseWindow guarantees that XRestackWindows() will <i>always</i> be
211 called for the specified client.
213 void raiseWindow(Client
*client
);
215 //! Lowers a client window below all others in its stacking layer
216 void lowerWindow(Client
*client
);
218 const otk::Property::StringVect
& desktopNames() const
219 { return _desktop_names
; }
221 void installColormap(bool install
) const;
223 virtual void propertyHandler(const XPropertyEvent
&e
);
224 virtual void clientMessageHandler(const XClientMessageEvent
&e
);
225 virtual void mapRequestHandler(const XMapRequestEvent
&e
);