1 // Window.h for Openbox
2 // Copyright (c) 2001 Sean 'Shaleh' Perry <shaleh@debian.org>
3 // Copyright (c) 1997 - 2000 Brad Hughes (bhughes@tcac.net)
5 // Permission is hereby granted, free of charge, to any person obtaining a
6 // copy of this software and associated documentation files (the "Software"),
7 // to deal in the Software without restriction, including without limitation
8 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 // and/or sell copies of the Software, and to permit persons to whom the
10 // Software is furnished to do so, subject to the following conditions:
12 // The above copyright notice and this permission notice shall be included in
13 // all copies or substantial portions of the Software.
15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 // DEALINGS IN THE SOFTWARE.
27 #include <X11/Xutil.h>
29 # include <X11/extensions/shape.h>
32 #include "BaseDisplay.h"
34 #include "Windowmenu.h"
36 // forward declaration
39 #define MwmHintsFunctions (1l << 0)
40 #define MwmHintsDecorations (1l << 1)
42 #define MwmFuncAll (1l << 0)
43 #define MwmFuncResize (1l << 1)
44 #define MwmFuncMove (1l << 2)
45 #define MwmFuncIconify (1l << 3)
46 #define MwmFuncMaximize (1l << 4)
47 #define MwmFuncClose (1l << 5)
49 #define MwmDecorAll (1l << 0)
50 #define MwmDecorBorder (1l << 1)
51 #define MwmDecorHandle (1l << 2)
52 #define MwmDecorTitle (1l << 3)
53 #define MwmDecorMenu (1l << 4)
54 #define MwmDecorIconify (1l << 5)
55 #define MwmDecorMaximize (1l << 6)
57 // this structure only contains 3 elements... the Motif 2.0 structure contains
58 // 5... we only need the first 3... so that is all we will define
59 typedef struct MwmHints
{
60 unsigned long flags
, functions
, decorations
;
63 #define PropMwmHintsElements 3
66 class OpenboxWindow
: public TimeoutHandler
{
68 BImageControl
*image_ctrl
;
73 OpenboxAttributes openbox_attrib
;
75 Time lastButtonPressTime
; // used for double clicks, when were we clicked
76 Windowmenu
*windowmenu
;
78 int window_number
, workspace_number
;
79 unsigned long current_state
;
81 enum FocusMode
{ F_NoInput
= 0, F_Passive
,
82 F_LocallyActive
, F_GloballyActive
};
91 unsigned int resize_zone
; // bitmask of ResizeZones values
94 Bool moving
, // is moving?
95 resizing
, // is resizing?
97 visible
, // is visible?
98 iconic
, // is iconified?
99 transient
, // is a transient window?
100 focused
, // has focus?
101 stuck
, // is omnipresent
102 modal
, // is modal? (must be dismissed to continue)
103 send_focus_message
, // should we send focus messages to our client?
104 shaped
, // does the frame use the shape extension?
105 managed
; // under openbox's control?
106 // maximize is special, the number corresponds
107 // with a mouse button
108 // if 0, not maximized
109 unsigned int maximized
; // 1 = HorizVert, 2 = Vertical, 3 = Horizontal
113 OpenboxWindow
*transient_for
, // which window are we a transient for?
114 *transient
; // which window is our transient?
116 Window window
, // the client's window
117 window_group
; // the client's window group
119 char *title
, *icon_title
;
120 size_t title_len
; // strlen(title)
123 old_bw
; // client's borderwidth
125 unsigned int width
, height
,
126 title_text_w
, // width as rendered in the current font
127 min_width
, min_height
, // can not be resized smaller
128 max_width
, max_height
, // can not be resized larger
129 width_inc
, height_inc
, // increment step
130 min_aspect_x
, min_aspect_y
, // minimum aspect ratio
131 max_aspect_x
, max_aspect_y
, // maximum aspect ratio
132 base_width
, base_height
,
135 unsigned long initial_state
, normal_hint_flags
, wm_hint_flags
;
138 OpenboxHints
*openbox_hint
;
142 Bool resize
, move
, iconify
, maximize
, close
;
146 * client window = the application's window
147 * frame window = the window drawn around the outside of the client window
148 * by the window manager which contains items like the
149 * titlebar and close button
150 * title = the titlebar drawn above the client window, it displays the
151 * window's name and any buttons for interacting with the window,
152 * such as iconify, maximize, and close
153 * label = the window in the titlebar where the title is drawn
154 * buttons = maximize, iconify, close
155 * handle = the bar drawn at the bottom of the window, which contains the
156 * left and right grips used for resizing the window
157 * grips = the smaller reactangles in the handle, one of each side of it.
158 * When clicked and dragged, these resize the window interactively
159 * border = the line drawn around the outside edge of the frame window,
160 * between the title, the bordered client window, and the handle.
161 * Also drawn between the grips and the handle
165 * what decorations do we have?
166 * this is based on the type of the client window as well as user input
167 * the menu is not really decor, but it goes hand in hand with the decor
169 struct _decorations
{
170 Bool titlebar
, handle
, border
, iconify
, maximize
, close
, menu
;
174 // u -> unfocused, f -> has focus
175 unsigned long ulabel_pixel
, flabel_pixel
, utitle_pixel
,
176 ftitle_pixel
, uhandle_pixel
, fhandle_pixel
, ubutton_pixel
,
177 fbutton_pixel
, pbutton_pixel
, uborder_pixel
, fborder_pixel
,
178 ugrip_pixel
, fgrip_pixel
;
179 Pixmap ulabel
, flabel
, utitle
, ftitle
, uhandle
, fhandle
,
180 ubutton
, fbutton
, pbutton
, ugrip
, fgrip
;
182 Window window
, // the frame
183 plate
, // holds the client
187 close_button
, iconify_button
, maximize_button
,
188 right_grip
, left_grip
;
191 unsigned int resize_w
, resize_h
;
192 int resize_x
, resize_y
, // size and location of box drawn while resizing
193 move_x
, move_y
; // location of box drawn while moving
196 grab_x
, grab_y
, // where was the window when it was grabbed?
197 y_border
, y_handle
; // where within frame is the border and handle
199 unsigned int width
, height
, title_h
, label_w
, label_h
, handle_h
,
200 button_w
, button_h
, grip_w
, grip_h
, mwm_border_w
, border_h
, border_w
,
201 bevel_w
, snap_w
, snap_h
;
206 Window
createToplevelWindow(int x
, int y
, unsigned int width
,
207 unsigned int height
, unsigned int borderwidth
);
208 Window
createChildWindow(Window parent
, Cursor
= None
);
210 void getWMName(void);
211 void getWMIconName(void);
212 void getWMNormalHints(void);
213 void getWMProtocols(void);
214 void getWMHints(void);
215 void getMWMHints(void);
216 void getOpenboxHints(void);
217 void setNetWMAttributes(void);
218 void associateClientWindow(void);
220 void decorateLabel(void);
221 void positionButtons(Bool redecorate_label
= False
);
222 void positionWindows(void);
223 void createCloseButton(void);
224 void createIconifyButton(void);
225 void createMaximizeButton(void);
226 void redrawLabel(void);
227 void redrawAllButtons(void);
228 void redrawCloseButton(Bool
);
229 void redrawIconifyButton(Bool
);
230 void redrawMaximizeButton(Bool
);
231 void restoreGravity(void);
232 void setGravityOffsets(void);
233 void setState(unsigned long);
236 void right_fixsize(int *gx
= 0, int *gy
= 0);
237 void left_fixsize(int *gx
= 0, int *gy
= 0);
241 OpenboxWindow(Openbox
*b
, Window w
, BScreen
*s
= (BScreen
*) 0);
242 virtual ~OpenboxWindow(void);
244 inline Bool
isTransient(void) const { return flags
.transient
; }
245 inline Bool
isFocused(void) const { return flags
.focused
; }
246 inline Bool
isVisible(void) const { return flags
.visible
; }
247 inline Bool
isIconic(void) const { return flags
.iconic
; }
248 inline Bool
isShaded(void) const { return flags
.shaded
; }
249 inline Bool
isMaximized(void) const { return flags
.maximized
; }
250 inline Bool
isMaximizedFull(void) const { return flags
.maximized
== 1; }
251 inline Bool
isStuck(void) const { return flags
.stuck
; }
252 inline Bool
isIconifiable(void) const { return functions
.iconify
; }
253 inline Bool
isMaximizable(void) const { return functions
.maximize
; }
254 inline Bool
isResizable(void) const { return functions
.resize
; }
255 inline Bool
isClosable(void) const { return functions
.close
; }
257 inline Bool
hasTitlebar(void) const { return decorations
.titlebar
; }
258 inline Bool
hasTransient(void) const
259 { return ((client
.transient
) ? True
: False
); }
261 inline OpenboxWindow
*getTransient(void) { return client
.transient
; }
262 inline OpenboxWindow
*getTransientFor(void) { return client
.transient_for
; }
264 inline BScreen
*getScreen(void) { return screen
; }
266 inline const Window
&getFrameWindow(void) const { return frame
.window
; }
267 inline const Window
&getClientWindow(void) const { return client
.window
; }
269 inline Windowmenu
* getWindowmenu(void) { return windowmenu
; }
271 inline char **getTitle(void) { return &client
.title
; }
272 inline char **getIconTitle(void) { return &client
.icon_title
; }
273 inline const int &getXFrame(void) const { return frame
.x
; }
274 inline const int &getYFrame(void) const { return frame
.y
; }
275 inline const int &getXClient(void) const { return client
.x
; }
276 inline const int &getYClient(void) const { return client
.y
; }
277 inline const int &getWorkspaceNumber(void) const { return workspace_number
; }
278 inline const int &getWindowNumber(void) const { return window_number
; }
280 inline const unsigned int &getWidth(void) const { return frame
.width
; }
281 inline const unsigned int &getHeight(void) const { return frame
.height
; }
282 inline const unsigned int &getClientHeight(void) const
283 { return client
.height
; }
284 inline const unsigned int &getClientWidth(void) const
285 { return client
.width
; }
286 inline const unsigned int &getTitleHeight(void) const
287 { return frame
.title_h
; }
289 inline void setWindowNumber(int n
) { window_number
= n
; }
291 Bool
validateClient(void);
292 Bool
setInputFocus(void);
294 void setFocusFlag(Bool
);
296 void deiconify(Bool reassoc
= True
, Bool raise
= True
);
299 void maximize(unsigned int button
);
303 void reconfigure(void);
304 void installColormap(Bool
);
306 void configure(int dx
, int dy
, unsigned int dw
, unsigned int dh
);
307 void setWorkspace(int n
);
308 void changeOpenboxHints(OpenboxHints
*);
309 void restoreAttributes(void);
311 void buttonPressEvent(XButtonEvent
*);
312 void buttonReleaseEvent(XButtonEvent
*);
313 void motionNotifyEvent(XMotionEvent
*);
314 void destroyNotifyEvent(XDestroyWindowEvent
*);
315 void mapRequestEvent(XMapRequestEvent
*);
316 void mapNotifyEvent(XMapEvent
*);
317 void unmapNotifyEvent(XUnmapEvent
*);
318 void propertyNotifyEvent(Atom
);
319 void exposeEvent(XExposeEvent
*);
320 void configureRequestEvent(XConfigureRequestEvent
*);
323 void shapeEvent(XShapeEvent
*);
326 virtual void timeout(void);
330 #endif // __Window_hh