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;
137 unsigned int mod_mask; // the mod mask used to grab buttons
139 enum FocusMode { F_NoInput = 0, F_Passive,
140 F_LocallyActive, F_GloballyActive };
141 FocusMode focus_mode;
144 bool moving, // is moving?
145 resizing, // is resizing?
146 shaded, // is shaded?
147 visible, // is visible?
148 iconic, // is iconified?
149 focused, // has focus?
150 stuck, // is omnipresent?
151 modal, // is modal? (must be dismissed to continue)
152 skip_taskbar, // skipped by taskbars?
153 skip_pager, // skipped by pagers?
154 fullscreen, // a fullscreen window?
155 send_focus_message, // should we send focus messages to our client?
156 shaped; // does the frame use the shape extension?
157 unsigned int maximized; // maximize is special, the number corresponds
158 // with a mouse button
159 // if 0, not maximized
160 // 1 = HorizVert, 2 = Vertical, 3 = Horizontal
164 Window window, // the client's window
166 BlackboxWindow *transient_for; // which window are we a transient for?
167 BlackboxWindowList transientList; // which windows are our transients?
169 std::string title, icon_title;
174 int old_bw; // client's borderwidth
177 min_width, min_height, // can not be resized smaller
178 max_width, max_height, // can not be resized larger
179 width_inc, height_inc, // increment step
180 #if 0 // not supported at the moment
181 min_aspect_x, min_aspect_y, // minimum aspect ratio
182 max_aspect_x, max_aspect_y, // maximum aspect ratio
184 base_width, base_height,
187 unsigned long initial_state, normal_hint_flags;
190 FunctionFlags functions;
192 * what decorations do we have?
193 * this is based on the type of the client window as well as user input
195 DecorationFlags decorations;
196 DecorationFlags mwm_decorations;
198 WindowType window_type;
201 * client window = the application's window
202 * frame window = the window drawn around the outside of the client window
203 * by the window manager which contains items like the
204 * titlebar and close button
205 * title = the titlebar drawn above the client window, it displays the
206 * window's name and any buttons for interacting with the window,
207 * such as iconify, maximize, and close
208 * label = the window in the titlebar where the title is drawn
209 * buttons = maximize, iconify, close
210 * handle = the bar drawn at the bottom of the window, which contains the
211 * left and right grips used for resizing the window
212 * grips = the smaller reactangles in the handle, one of each side of it.
213 * When clicked and dragged, these resize the window interactively
214 * border = the line drawn around the outside edge of the frame window,
215 * between the title, the bordered client window, and the handle.
216 * Also drawn between the grips and the handle
220 // u -> unfocused, f -> has focus
221 unsigned long ulabel_pixel, flabel_pixel, utitle_pixel,
222 ftitle_pixel, uhandle_pixel, fhandle_pixel, ubutton_pixel,
223 fbutton_pixel, pbutton_pixel, uborder_pixel, fborder_pixel,
224 ugrip_pixel, fgrip_pixel;
225 Pixmap ulabel, flabel, utitle, ftitle, uhandle, fhandle,
226 ubutton, fbutton, pbutton, ugrip, fgrip;
228 Window window, // the frame
229 plate, // holds the client
233 close_button, iconify_button, maximize_button,
234 right_grip, left_grip;
237 * size and location of the box drawn while the window dimensions or
238 * location is being changed, ie. resized or moved
242 Rect rect; // frame geometry
243 Strut margin; // margins between the frame and client
245 int grab_x, grab_y; // where was the window when it was grabbed?
247 unsigned int inside_w, inside_h, // window w/h without border_w
248 title_h, label_w, label_h, handle_h,
249 button_w, grip_w, mwm_border_w, border_w,
253 BlackboxWindow(const BlackboxWindow&);
254 BlackboxWindow& operator=(const BlackboxWindow&);
257 Window createToplevelWindow();
258 Window createChildWindow(Window parent, unsigned long event_mask,
261 bool getWindowType(void);
262 void updateStrut(void);
263 void getWMName(void);
264 void getWMIconName(void);
265 void getWMNormalHints(void);
266 void getWMProtocols(void);
267 void getWMHints(void);
268 void getNetWMHints(void);
269 void getMWMHints(void);
270 bool getBlackboxHints(void);
271 void getTransientInfo(void);
272 void setNetWMAttributes(void);
273 void associateClientWindow(void);
275 void decorateLabel(void);
276 void positionButtons(bool redecorate_label = False);
277 void positionWindows(void);
278 void createHandle(void);
279 void destroyHandle(void);
280 void createTitlebar(void);
281 void destroyTitlebar(void);
282 void createCloseButton(void);
283 void destroyCloseButton(void);
284 void createIconifyButton(void);
285 void destroyIconifyButton(void);
286 void createMaximizeButton(void);
287 void destroyMaximizeButton(void);
288 void redrawWindowFrame(void) const;
289 void redrawLabel(void) const;
290 void redrawAllButtons(void) const;
291 void redrawCloseButton(bool pressed) const;
292 void redrawIconifyButton(bool pressed) const;
293 void redrawMaximizeButton(bool pressed) const;
294 void applyGravity(Rect &r);
295 void restoreGravity(Rect &r);
296 void setAllowedActions(void);
297 void setState(unsigned long new_state);
299 void doMove(int x_root, int y_root);
300 void doWorkspaceWarping(int x_root, int y_root, int &dx);
301 void doWindowSnapping(int &dx, int &dy);
303 void doResize(int x_root, int y_root);
304 void endResize(void);
306 void constrain(Corner anchor, unsigned int *pw = 0, unsigned int *ph = 0);
309 BlackboxWindow(Blackbox *b, Window w, BScreen *s);
310 virtual ~BlackboxWindow(void);
312 inline bool isTransient(void) const { return client.transient_for != 0; }
313 inline bool isFocused(void) const { return flags.focused; }
314 inline bool isVisible(void) const { return flags.visible; }
315 inline bool isIconic(void) const { return flags.iconic; }
316 inline bool isShaded(void) const { return flags.shaded; }
317 inline bool isMaximized(void) const { return flags.maximized; }
318 inline bool isMaximizedHoriz(void) const { return flags.maximized == 3; }
319 inline bool isMaximizedVert(void) const { return flags.maximized == 2; }
320 inline bool isMaximizedFull(void) const { return flags.maximized == 1; }
321 inline bool isStuck(void) const { return flags.stuck; }
322 inline bool isModal(void) const { return flags.modal; }
323 inline bool isIconifiable(void) const { return functions & Func_Iconify; }
324 inline bool isMaximizable(void) const { return functions & Func_Maximize; }
325 inline bool isResizable(void) const { return functions & Func_Resize; }
326 inline bool isClosable(void) const { return functions & Func_Close; }
328 // is a 'normal' window? meaning, a standard client application
329 inline bool isNormal(void) const
330 { return window_type == Type_Dialog || window_type == Type_Normal ||
331 window_type == Type_Toolbar || window_type == Type_Utility; }
332 inline bool isTopmost(void) const
333 { return window_type == Type_Toolbar || window_type == Type_Utility; }
334 inline bool isDesktop(void) const { return window_type == Type_Desktop; }
336 inline bool hasTitlebar(void) const { return decorations & Decor_Titlebar; }
338 inline const BlackboxWindowList &getTransients(void) const
339 { return client.transientList; }
340 BlackboxWindow *getTransientFor(void) const;
342 inline BScreen *getScreen(void) const { return screen; }
344 inline Window getFrameWindow(void) const { return frame.window; }
345 inline Window getClientWindow(void) const { return client.window; }
346 inline Window getGroupWindow(void) const { return client.window_group; }
348 inline Windowmenu * getWindowmenu(void) const { return windowmenu; }
350 inline const char *getTitle(void) const
351 { return client.title.c_str(); }
352 inline const char *getIconTitle(void) const
353 { return client.icon_title.c_str(); }
355 inline unsigned int getWorkspaceNumber(void) const
356 { return blackbox_attrib.workspace; }
357 inline unsigned int getWindowNumber(void) const { return window_number; }
359 inline const Rect &frameRect(void) const { return frame.rect; }
360 inline const Rect &clientRect(void) const { return client.rect; }
362 inline unsigned int getTitleHeight(void) const
363 { return frame.title_h; }
365 inline void setWindowNumber(int n) { window_number = n; }
367 bool validateClient(void) const;
368 bool setInputFocus(void);
370 // none of these are used by the window manager, they are here to persist
371 // them properly in the window's netwm state property.
372 inline bool skipTaskbar(void) const { return flags.skip_taskbar; }
373 inline void setSkipTaskbar(const bool s) { flags.skip_taskbar = s; }
374 inline bool skipPager(void) const { return flags.skip_pager; }
375 inline void setSkipPager(const bool s) { flags.skip_pager = s; }
376 inline bool isFullscreen(void) const { return flags.fullscreen; }
377 inline void setFullscreen(const bool f) { flags.fullscreen = f; }
379 inline void setModal(const bool m) { flags.modal = m; }
381 void beginMove(int x_root, int y_root);
382 void beginResize(int x_root, int y_root, Corner dir);
383 void enableDecor(bool enable);
385 void setFocusFlag(bool focus);
387 void deiconify(bool reassoc = True, bool raise = True);
391 void maximize(unsigned int button);
392 void remaximize(void);
395 void reconfigure(void);
396 void grabButtons(void);
397 void ungrabButtons(void);
398 void installColormap(bool install);
399 void restore(bool remap);
400 void configure(int dx, int dy, unsigned int dw, unsigned int dh);
401 void setWorkspace(unsigned int n);
402 void changeBlackboxHints(const BlackboxHints *net);
403 void restoreAttributes(void);
405 void buttonPressEvent(const XButtonEvent *be);
406 void buttonReleaseEvent(const XButtonEvent *re);
407 void motionNotifyEvent(const XMotionEvent *me);
408 void destroyNotifyEvent(const XDestroyWindowEvent* /*unused*/);
409 void mapRequestEvent(const XMapRequestEvent *mre);
410 void unmapNotifyEvent(const XUnmapEvent* /*unused*/);
411 void reparentNotifyEvent(const XReparentEvent* /*unused*/);
412 void propertyNotifyEvent(const XPropertyEvent *pe);
413 void exposeEvent(const XExposeEvent *ee);
414 void configureRequestEvent(const XConfigureRequestEvent *cr);
415 void enterNotifyEvent(const XCrossingEvent *ce);
416 void leaveNotifyEvent(const XCrossingEvent* /*unused*/);
419 void configureShape(void);
420 void clearShape(void);
421 void shapeEvent(XShapeEvent * /*unused*/);
424 virtual void timeout(void);
428 #endif // __Window_hh