1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
2 // Window.hh for Blackbox - an X11 Window manager
3 // Copyright (c) 2001 - 2002 Sean 'Shaleh' Perry <shaleh@debian.org>
4 // Copyright (c) 1997 - 2000 Brad Hughes (bhughes@tcac.net)
6 // Permission is hereby granted, free of charge, to any person obtaining a
7 // copy of this software and associated documentation files (the "Software"),
8 // to deal in the Software without restriction, including without limitation
9 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 // and/or sell copies of the Software, and to permit persons to whom the
11 // Software is furnished to do so, subject to the following conditions:
13 // The above copyright notice and this permission notice shall be included in
14 // all copies or substantial portions of the Software.
16 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 // DEALINGS IN THE SOFTWARE.
29 #include <X11/Xutil.h>
31 # include <X11/extensions/shape.h>
37 #include "BaseDisplay.hh"
40 #include "Windowmenu.hh"
42 #define MwmHintsFunctions (1l << 0)
43 #define MwmHintsDecorations (1l << 1)
45 #define MwmFuncAll (1l << 0)
46 #define MwmFuncResize (1l << 1)
47 #define MwmFuncMove (1l << 2)
48 #define MwmFuncIconify (1l << 3)
49 #define MwmFuncMaximize (1l << 4)
50 #define MwmFuncClose (1l << 5)
52 #define MwmDecorAll (1l << 0)
53 #define MwmDecorBorder (1l << 1)
54 #define MwmDecorHandle (1l << 2)
55 #define MwmDecorTitle (1l << 3)
56 #define MwmDecorMenu (1l << 4) // not used
57 #define MwmDecorIconify (1l << 5)
58 #define MwmDecorMaximize (1l << 6)
60 // this structure only contains 3 elements... the Motif 2.0 structure contains
61 // 5... we only need the first 3... so that is all we will define
62 typedef struct MwmHints {
63 unsigned long flags, functions, decorations;
66 #define PropMwmHintsElements 3
72 BlackboxWindowList windowList;
75 BWindowGroup(Blackbox *b, Window _group);
78 inline Window groupWindow(void) const { return group; }
80 inline bool empty(void) const { return windowList.empty(); }
82 void addWindow(BlackboxWindow *w) { windowList.push_back(w); }
83 void removeWindow(BlackboxWindow *w) { windowList.remove(w); }
86 find a window on the specified screen. the focused window (if any) is
87 checked first, otherwise the first matching window found is returned.
88 transients are returned only if allow_transients is True.
90 BlackboxWindow *find(BScreen *screen, bool allow_transients = False) const;
94 class BlackboxWindow : public TimeoutHandler {
96 enum Function { Func_Resize = (1l << 0),
97 Func_Move = (1l << 1),
98 Func_Iconify = (1l << 2),
99 Func_Maximize = (1l << 3),
100 Func_Close = (1l << 4) };
101 typedef unsigned char FunctionFlags;
103 enum Decoration { Decor_Titlebar = (1l << 0),
104 Decor_Handle = (1l << 1),
105 Decor_Border = (1l << 2),
106 Decor_Iconify = (1l << 3),
107 Decor_Maximize = (1l << 4),
108 Decor_Close = (1l << 5) };
109 typedef unsigned char DecorationFlags;
111 enum WindowType { Type_Desktop,
120 enum Corner { TopLeft,
130 BlackboxAttributes blackbox_attrib;
132 Time lastButtonPressTime; // used for double clicks, when were we clicked
133 Windowmenu *windowmenu;
135 unsigned int window_number;
136 unsigned long current_state;
138 enum FocusMode { F_NoInput = 0, F_Passive,
139 F_LocallyActive, F_GloballyActive };
140 FocusMode focus_mode;
143 bool moving, // is moving?
144 resizing, // is resizing?
145 shaded, // is shaded?
146 visible, // is visible?
147 iconic, // is iconified?
148 focused, // has focus?
149 stuck, // is omnipresent?
150 modal, // is modal? (must be dismissed to continue)
151 skip_taskbar, // skipped by taskbars?
152 skip_pager, // skipped by pagers?
153 fullscreen, // a fullscreen window?
154 send_focus_message, // should we send focus messages to our client?
155 shaped; // does the frame use the shape extension?
156 unsigned int maximized; // maximize is special, the number corresponds
157 // with a mouse button
158 // if 0, not maximized
159 // 1 = HorizVert, 2 = Vertical, 3 = Horizontal
163 Window window, // the client's window
165 BlackboxWindow *transient_for; // which window are we a transient for?
166 BlackboxWindowList transientList; // which windows are our transients?
168 std::string title, icon_title;
173 int old_bw; // client's borderwidth
176 min_width, min_height, // can not be resized smaller
177 max_width, max_height, // can not be resized larger
178 width_inc, height_inc, // increment step
179 #if 0 // not supported at the moment
180 min_aspect_x, min_aspect_y, // minimum aspect ratio
181 max_aspect_x, max_aspect_y, // maximum aspect ratio
183 base_width, base_height,
186 unsigned long initial_state, normal_hint_flags, wm_hint_flags;
189 FunctionFlags functions;
191 * what decorations do we have?
192 * this is based on the type of the client window as well as user input
193 * the menu is not really decor, but it goes hand in hand with the decor
195 DecorationFlags decorations;
197 WindowType window_type;
200 * client window = the application's window
201 * frame window = the window drawn around the outside of the client window
202 * by the window manager which contains items like the
203 * titlebar and close button
204 * title = the titlebar drawn above the client window, it displays the
205 * window's name and any buttons for interacting with the window,
206 * such as iconify, maximize, and close
207 * label = the window in the titlebar where the title is drawn
208 * buttons = maximize, iconify, close
209 * handle = the bar drawn at the bottom of the window, which contains the
210 * left and right grips used for resizing the window
211 * grips = the smaller reactangles in the handle, one of each side of it.
212 * When clicked and dragged, these resize the window interactively
213 * border = the line drawn around the outside edge of the frame window,
214 * between the title, the bordered client window, and the handle.
215 * Also drawn between the grips and the handle
219 // u -> unfocused, f -> has focus
220 unsigned long ulabel_pixel, flabel_pixel, utitle_pixel,
221 ftitle_pixel, uhandle_pixel, fhandle_pixel, ubutton_pixel,
222 fbutton_pixel, pbutton_pixel, uborder_pixel, fborder_pixel,
223 ugrip_pixel, fgrip_pixel;
224 Pixmap ulabel, flabel, utitle, ftitle, uhandle, fhandle,
225 ubutton, fbutton, pbutton, ugrip, fgrip;
227 Window window, // the frame
228 plate, // holds the client
232 close_button, iconify_button, maximize_button,
233 right_grip, left_grip;
236 * size and location of the box drawn while the window dimensions or
237 * location is being changed, ie. resized or moved
241 Rect rect; // frame geometry
242 Strut margin; // margins between the frame and client
244 int grab_x, grab_y; // where was the window when it was grabbed?
246 unsigned int inside_w, inside_h, // window w/h without border_w
247 title_h, label_w, label_h, handle_h,
248 button_w, grip_w, mwm_border_w, border_w,
252 BlackboxWindow(const BlackboxWindow&);
253 BlackboxWindow& operator=(const BlackboxWindow&);
256 Window createToplevelWindow();
257 Window createChildWindow(Window parent, Cursor = None);
259 void getWindowType(void);
260 void updateStrut(void);
261 void getWMName(void);
262 void getWMIconName(void);
263 void getWMNormalHints(void);
264 void getWMProtocols(void);
265 void getWMHints(void);
266 void getNetWMHints(void);
267 void getMWMHints(void);
268 bool getBlackboxHints(void);
269 void getTransientInfo(void);
270 bool isKDESystrayWindow(void);
271 void setNetWMAttributes(void);
272 void associateClientWindow(void);
274 void decorateLabel(void);
275 void positionButtons(bool redecorate_label = False);
276 void positionWindows(void);
277 void createHandle(void);
278 void destroyHandle(void);
279 void createTitlebar(void);
280 void destroyTitlebar(void);
281 void createCloseButton(void);
282 void destroyCloseButton(void);
283 void createIconifyButton(void);
284 void destroyIconifyButton(void);
285 void createMaximizeButton(void);
286 void destroyMaximizeButton(void);
287 void redrawWindowFrame(void) const;
288 void redrawLabel(void) const;
289 void redrawAllButtons(void) const;
290 void redrawCloseButton(bool pressed) const;
291 void redrawIconifyButton(bool pressed) const;
292 void redrawMaximizeButton(bool pressed) const;
293 void applyGravity(Rect &r);
294 void restoreGravity(Rect &r);
295 void setAllowedActions(void);
296 void setState(unsigned long new_state);
298 void doMove(int x_root, int y_root);
300 void doResize(int x_root, int y_root);
301 void endResize(void);
303 void constrain(Corner anchor, int *pw = 0, int *ph = 0);
306 BlackboxWindow(Blackbox *b, Window w, BScreen *s);
307 virtual ~BlackboxWindow(void);
309 inline bool isTransient(void) const { return client.transient_for != 0; }
310 inline bool isFocused(void) const { return flags.focused; }
311 inline bool isVisible(void) const { return flags.visible; }
312 inline bool isIconic(void) const { return flags.iconic; }
313 inline bool isShaded(void) const { return flags.shaded; }
314 inline bool isMaximized(void) const { return flags.maximized; }
315 inline bool isMaximizedHoriz(void) const { return flags.maximized == 3; }
316 inline bool isMaximizedVert(void) const { return flags.maximized == 2; }
317 inline bool isMaximizedFull(void) const { return flags.maximized == 1; }
318 inline bool isStuck(void) const { return flags.stuck; }
319 inline bool isModal(void) const { return flags.modal; }
320 inline bool isIconifiable(void) const { return functions & Func_Iconify; }
321 inline bool isMaximizable(void) const { return functions & Func_Maximize; }
322 inline bool isResizable(void) const { return functions & Func_Resize; }
323 inline bool isClosable(void) const { return functions & Func_Close; }
324 inline bool isDesktop(void) const { return window_type == Type_Desktop; }
326 inline bool hasTitlebar(void) const { return decorations & Decor_Titlebar; }
328 inline const BlackboxWindowList &getTransients(void) const
329 { return client.transientList; }
330 BlackboxWindow *getTransientFor(void) const;
332 inline BScreen *getScreen(void) const { return screen; }
334 inline Window getFrameWindow(void) const { return frame.window; }
335 inline Window getClientWindow(void) const { return client.window; }
336 inline Window getGroupWindow(void) const { return client.window_group; }
338 inline Windowmenu * getWindowmenu(void) const { return windowmenu; }
340 inline const char *getTitle(void) const
341 { return client.title.c_str(); }
342 inline const char *getIconTitle(void) const
343 { return client.icon_title.c_str(); }
345 inline unsigned int getWorkspaceNumber(void) const
346 { return blackbox_attrib.workspace; }
347 inline unsigned int getWindowNumber(void) const { return window_number; }
349 inline const Rect &frameRect(void) const { return frame.rect; }
350 inline const Rect &clientRect(void) const { return client.rect; }
352 inline unsigned int getTitleHeight(void) const
353 { return frame.title_h; }
355 inline void setWindowNumber(int n) { window_number = n; }
357 bool validateClient(void) const;
358 bool setInputFocus(void);
360 // none of these are used by the window manager, they are here to persist
361 // them properly in the window's netwm state property.
362 inline bool skipTaskbar(void) const { return flags.skip_taskbar; }
363 inline void setSkipTaskbar(const bool s) { flags.skip_taskbar = s; }
364 inline bool skipPager(void) const { return flags.skip_pager; }
365 inline void setSkipPager(const bool s) { flags.skip_pager = s; }
366 inline bool isFullscreen(void) const { return flags.fullscreen; }
367 inline void setFullscreen(const bool f) { flags.fullscreen = f; }
369 inline void setModal(const bool m) { flags.modal = m; }
371 void beginMove(int x_root, int y_root);
372 void beginResize(int x_root, int y_root, Corner dir);
373 void setFocusFlag(bool focus);
375 void deiconify(bool reassoc = True, bool raise = True);
379 void maximize(unsigned int button);
380 void remaximize(void);
383 void reconfigure(void);
384 void grabButtons(void);
385 void ungrabButtons(void);
386 void installColormap(bool install);
387 void restore(bool remap);
388 void configure(int dx, int dy, unsigned int dw, unsigned int dh);
389 void setWorkspace(unsigned int n);
390 void changeBlackboxHints(BlackboxHints *net);
391 void restoreAttributes(void);
393 void buttonPressEvent(const XButtonEvent *be);
394 void buttonReleaseEvent(const XButtonEvent *re);
395 void motionNotifyEvent(const XMotionEvent *me);
396 void destroyNotifyEvent(const XDestroyWindowEvent */*unused*/);
397 void mapRequestEvent(const XMapRequestEvent *mre);
398 void unmapNotifyEvent(const XUnmapEvent */*unused*/);
399 void reparentNotifyEvent(const XReparentEvent */*unused*/);
400 void propertyNotifyEvent(const XPropertyEvent *pe);
401 void exposeEvent(const XExposeEvent *ee);
402 void configureRequestEvent(const XConfigureRequestEvent *cr);
405 void configureShape(void);
406 void shapeEvent(XShapeEvent * /*unused*/);
409 virtual void timeout(void);
413 #endif // __Window_hh