wmaker: Add window snapping feature.
[wmaker-crm.git] / src / WindowMaker.h
blob31c67d2606d27b2c3ec7c6a36ca543770842b6ac
1 /*
2 * Window Maker window manager
4 * Copyright (c) 1997-2003 Alfredo K. Kojima
5 * Copyright (c) 2014 Window Maker Team
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #ifndef WINDOWMAKER_H_
23 #define WINDOWMAKER_H_
25 #include "wconfig.h"
26 #include <assert.h>
27 #include <limits.h>
28 #include <WINGs/WINGs.h>
31 /* class codes */
32 typedef enum {
33 WCLASS_UNKNOWN = 0,
34 WCLASS_WINDOW = 1, /* managed client windows */
35 WCLASS_MENU = 2, /* root menus */
36 WCLASS_APPICON = 3,
37 WCLASS_DUMMYWINDOW = 4, /* window that holds window group leader */
38 WCLASS_MINIWINDOW = 5,
39 WCLASS_DOCK_ICON = 6,
40 WCLASS_PAGER = 7,
41 WCLASS_TEXT_INPUT = 8,
42 WCLASS_FRAME = 9
43 } WClassType;
47 * generic window levels (a superset of the N*XTSTEP ones)
48 * Applications should use levels between WMDesktopLevel and
49 * WMScreensaverLevel anything boyond that range is allowed,
50 * but discouraged.
52 enum {
53 WMBackLevel = INT_MIN+1, /* Very lowest level */
54 WMDesktopLevel = -1000, /* Lowest level of normal use */
55 WMSunkenLevel = -1,
56 WMNormalLevel = 0,
57 WMFloatingLevel = 3,
58 WMDockLevel = 5,
59 WMSubmenuLevel = 15,
60 WMMainMenuLevel = 20,
61 WMStatusLevel = 21,
62 WMModalLevel = 100,
63 WMPopUpLevel = 101,
64 WMScreensaverLevel = 1000,
65 WMOuterSpaceLevel = INT_MAX
69 * WObjDescriptor will be used by the event dispatcher to
70 * send events to a particular object through the methods in the
71 * method table. If all objects of the same class share the
72 * same methods, the class method table should be used, otherwise
73 * a new method table must be created for each object.
74 * It is also assigned to find the parent structure of a given
75 * window (like the WWindow or WMenu for a button)
78 typedef struct WObjDescriptor {
79 void *self; /* the object that will be called */
80 /* event handlers */
81 void (*handle_expose)(struct WObjDescriptor *sender, XEvent *event);
82 void (*handle_mousedown)(struct WObjDescriptor *sender, XEvent *event);
83 void (*handle_enternotify)(struct WObjDescriptor *sender, XEvent *event);
84 void (*handle_leavenotify)(struct WObjDescriptor *sender, XEvent *event);
86 WClassType parent_type; /* type code of the parent */
87 void *parent; /* parent object (WWindow or WMenu) */
88 } WObjDescriptor;
90 /* internal buttons */
91 #define WBUT_CLOSE 0
92 #define WBUT_BROKENCLOSE 1
93 #define WBUT_ICONIFY 2
94 #define WBUT_KILL 3
95 #ifdef XKB_BUTTON_HINT
96 #define WBUT_XKBGROUP1 4
97 #define WBUT_XKBGROUP2 5
98 #define WBUT_XKBGROUP3 6
99 #define WBUT_XKBGROUP4 7
100 #define PRED_BPIXMAPS 8 /* reserved for 4 groups */
101 #else
102 #define PRED_BPIXMAPS 4 /* count of WBUT icons */
103 #endif /* XKB_BUTTON_HINT */
105 /* Mouse cursors */
106 typedef enum {
107 WCUR_NORMAL,
108 WCUR_MOVE,
109 WCUR_RESIZE,
110 WCUR_TOPLEFTRESIZE,
111 WCUR_TOPRIGHTRESIZE,
112 WCUR_BOTTOMLEFTRESIZE,
113 WCUR_BOTTOMRIGHTRESIZE,
114 WCUR_VERTICALRESIZE,
115 WCUR_HORIZONRESIZE,
116 WCUR_WAIT,
117 WCUR_ARROW,
118 WCUR_QUESTION,
119 WCUR_TEXT,
120 WCUR_SELECT,
121 WCUR_ROOT,
122 WCUR_EMPTY,
124 /* Count of the number of cursors defined */
125 WCUR_LAST
126 } w_cursor;
128 /* geometry displays */
129 #define WDIS_NEW 0 /* new style */
130 #define WDIS_CENTER 1 /* center of screen */
131 #define WDIS_TOPLEFT 2 /* top left corner of screen */
132 #define WDIS_FRAME_CENTER 3 /* center of the frame */
133 #define WDIS_NONE 4
135 /* keyboard input focus mode */
136 #define WKF_CLICK 0
137 #define WKF_SLOPPY 2
139 /* colormap change mode */
140 #define WCM_CLICK 0
141 #define WCM_POINTER 1
143 /* window placement mode */
144 #define WPM_MANUAL 0
145 #define WPM_CASCADE 1
146 #define WPM_SMART 2
147 #define WPM_RANDOM 3
148 #define WPM_AUTO 4
149 #define WPM_CENTER 5
151 /* text justification */
152 #define WTJ_CENTER 0
153 #define WTJ_LEFT 1
154 #define WTJ_RIGHT 2
156 /* iconification styles */
157 #define WIS_ZOOM 0
158 #define WIS_TWIST 1
159 #define WIS_FLIP 2
160 #define WIS_NONE 3
161 #define WIS_RANDOM 4 /* secret */
163 /* switchmenu actions */
164 #define ACTION_ADD 0
165 #define ACTION_REMOVE 1
166 #define ACTION_CHANGE 2
167 #define ACTION_CHANGE_WORKSPACE 3
168 #define ACTION_CHANGE_STATE 4
171 /* speeds */
172 #define SPEED_ULTRAFAST 0
173 #define SPEED_FAST 1
174 #define SPEED_MEDIUM 2
175 #define SPEED_SLOW 3
176 #define SPEED_ULTRASLOW 4
179 /* window states */
180 #define WS_FOCUSED 0
181 #define WS_UNFOCUSED 1
182 #define WS_PFOCUSED 2
184 /* clip title colors */
185 #define CLIP_NORMAL 0
186 #define CLIP_COLLAPSED 1
189 /* icon yard position */
190 #define IY_VERT 1
191 #define IY_HORIZ 0
192 #define IY_TOP 2
193 #define IY_BOTTOM 0
194 #define IY_RIGHT 4
195 #define IY_LEFT 0
198 /* menu styles */
199 #define MS_NORMAL 0
200 #define MS_SINGLE_TEXTURE 1
201 #define MS_FLAT 2
203 /* workspace actions */
204 #define WA_NONE 0
205 #define WA_SELECT_WINDOWS 1
206 #define WA_OPEN_APPMENU 2
207 #define WA_OPEN_WINLISTMENU 3
208 #define WA_SWITCH_WORKSPACES 4
209 #define WA_MOVE_PREVWORKSPACE 5
210 #define WA_MOVE_NEXTWORKSPACE 6
211 #define WA_SWITCH_WINDOWS 7
212 #define WA_MOVE_PREVWINDOW 8
213 #define WA_MOVE_NEXTWINDOW 9
215 /* workspace display position */
216 #define WD_NONE 0
217 #define WD_CENTER 1
218 #define WD_TOP 2
219 #define WD_BOTTOM 3
220 #define WD_TOPLEFT 4
221 #define WD_TOPRIGHT 5
222 #define WD_BOTTOMLEFT 6
223 #define WD_BOTTOMRIGHT 7
225 /* titlebar style */
226 #define TS_NEW 0
227 #define TS_OLD 1
228 #define TS_NEXT 2
230 /* workspace border position */
231 #define WB_NONE 0
232 #define WB_LEFTRIGHT 1
233 #define WB_TOPBOTTOM 2
234 #define WB_ALLDIRS (WB_LEFTRIGHT|WB_TOPBOTTOM)
237 /* program states */
238 typedef enum {
239 WSTATE_NORMAL = 0,
240 WSTATE_NEED_EXIT = 1,
241 WSTATE_NEED_RESTART = 2,
242 WSTATE_EXITING = 3,
243 WSTATE_RESTARTING = 4,
244 WSTATE_MODAL = 5,
245 WSTATE_NEED_REREAD = 6
246 } wprog_state;
249 #define WCHECK_STATE(chk_state) (w_global.program.state == (chk_state))
252 #define WCHANGE_STATE(nstate) {\
253 if (w_global.program.state == WSTATE_NORMAL\
254 || (nstate) != WSTATE_MODAL) \
255 w_global.program.state = (nstate); \
256 if (w_global.program.signal_state != 0)\
257 w_global.program.state = w_global.program.signal_state;\
261 /* only call inside signal handlers, with signals blocked */
262 #define SIG_WCHANGE_STATE(nstate) {\
263 w_global.program.signal_state = (nstate);\
264 w_global.program.state = (nstate);\
268 /* Flags for the Window Maker state when restarting/crash situations */
269 #define WFLAGS_NONE (0)
270 #define WFLAGS_CRASHED (1<<0)
273 /* notifications */
275 #ifdef MAINFILE
276 #define NOTIFICATION(n) const char WN##n [] = #n
277 #else
278 #define NOTIFICATION(n) extern const char WN##n []
279 #endif
281 NOTIFICATION(WindowAppearanceSettingsChanged);
283 NOTIFICATION(IconAppearanceSettingsChanged);
285 NOTIFICATION(IconTileSettingsChanged);
287 NOTIFICATION(MenuAppearanceSettingsChanged);
289 NOTIFICATION(MenuTitleAppearanceSettingsChanged);
292 /* appearance settings clientdata flags */
293 enum {
294 WFontSettings = 1 << 0,
295 WTextureSettings = 1 << 1,
296 WColorSettings = 1 << 2
301 typedef struct {
302 int x1, y1;
303 int x2, y2;
304 } WArea;
306 typedef struct WCoord {
307 int x, y;
308 } WCoord;
310 extern struct WPreferences {
311 char *pixmap_path; /* : separated list of paths to find pixmaps */
312 char *icon_path; /* : separated list of paths to find icons */
313 WMArray *fallbackWMs; /* fallback window manager list */
314 char *logger_shell; /* shell to log child stdi/o */
315 RImage *button_images; /* titlebar button images */
316 char smooth_workspace_back;
317 signed char size_display; /* display type for resize geometry */
318 signed char move_display; /* display type for move geometry */
319 signed char window_placement; /* window placement mode */
320 signed char colormap_mode; /* colormap focus mode */
321 signed char focus_mode; /* window focusing mode */
323 char opaque_move; /* update window position during move */
324 char opaque_resize; /* update window position during resize */
325 char opaque_move_resize_keyboard; /* update window position during move,resize with keyboard */
326 char wrap_menus; /* wrap menus at edge of screen */
327 char scrollable_menus; /* let them be scrolled */
328 char vi_key_menus; /* use h/j/k/l to select */
329 char align_menus; /* align menu with their parents */
330 char use_saveunders; /* turn on SaveUnders for menus, icons etc. */
331 char no_window_over_dock;
332 char no_window_over_icons;
333 WCoord window_place_origin; /* Offset for windows placed on screen */
335 char constrain_window_size; /* don't let windows get bigger than screen */
336 char windows_cycling; /* windoze cycling */
337 char circ_raise; /* raise window after Alt-tabbing */
338 char ignore_focus_click;
339 char open_transients_with_parent; /* open transient window in same workspace as parent */
340 signed char title_justification; /* titlebar text alignment */
341 int window_title_clearance;
342 int window_title_min_height;
343 int window_title_max_height;
344 int menu_title_clearance;
345 int menu_title_min_height;
346 int menu_title_max_height;
347 int menu_text_clearance;
348 char multi_byte_text;
349 #ifdef KEEP_XKB_LOCK_STATUS
350 char modelock;
351 #endif
352 char no_dithering; /* use dithering or not */
353 char no_animations; /* enable/disable animations */
354 char no_autowrap; /* wrap workspace when window is moved to the edge */
355 char window_snapping; /* enable window snapping */
357 char highlight_active_app; /* show the focused app by highlighting its icon */
358 char auto_arrange_icons; /* automagically arrange icons */
359 char icon_box_position; /* position to place icons */
360 signed char iconification_style; /* position to place icons */
361 char disable_root_mouse; /* disable button events in root window */
362 char auto_focus; /* focus window when it's mapped */
363 char *icon_back_file; /* background image for icons */
365 WCoord *root_menu_pos; /* initial position of the root menu*/
366 WCoord *app_menu_pos;
367 WCoord *win_menu_pos;
369 signed char icon_yard; /* aka iconbox */
371 int raise_delay; /* delay for autoraise. 0 is disabled */
372 int cmap_size; /* size of dithering colormap in colors per channel */
374 int icon_size; /* size of the icon */
375 signed char menu_style; /* menu decoration style */
376 signed char workspace_name_display_position;
377 unsigned int modifier_mask; /* mask to use as kbd modifier */
378 char *modifier_labels[7]; /* Names of the modifiers */
380 unsigned int supports_tiff; /* Use tiff files */
382 char ws_advance; /* Create new workspace and advance */
383 char ws_cycle; /* Cycle existing workspaces */
384 char save_session_on_exit; /* automatically save session on exit */
385 char sticky_icons; /* If miniwindows will be onmipresent */
386 char dont_confirm_kill; /* do not confirm Kill application */
387 char disable_miniwindows;
388 char dont_blink; /* do not blink icon selection */
390 /* Appearance options */
391 char new_style; /* Use newstyle buttons */
392 char superfluous; /* Use superfluous things */
394 /* root window mouse bindings */
395 signed char mouse_button1; /* action for left mouse button */
396 signed char mouse_button2; /* action for middle mouse button */
397 signed char mouse_button3; /* action for right mouse button */
398 signed char mouse_button8; /* action for 4th button aka backward mouse button */
399 signed char mouse_button9; /* action for 5th button aka forward mouse button */
400 signed char mouse_wheel_scroll; /* action for mouse wheel scroll */
401 signed char mouse_wheel_tilt; /* action for mouse wheel tilt */
403 /* balloon text */
404 char window_balloon;
405 char miniwin_title_balloon;
406 char miniwin_apercu_balloon;
407 char appicon_balloon;
408 char help_balloon;
410 /* some constants */
411 int dblclick_time; /* double click delay time in ms */
413 /* animate menus */
414 signed char menu_scroll_speed; /* how fast menus are scrolled */
416 /* animate icon sliding */
417 signed char icon_slide_speed; /* icon slide animation speed */
419 /* shading animation */
420 signed char shade_speed;
422 /* bouncing animation */
423 char bounce_appicons_when_urgent;
424 char raise_appicons_when_bouncing;
425 char do_not_make_appicons_bounce;
427 int edge_resistance;
428 int resize_increment;
429 char attract;
431 unsigned int workspace_border_size; /* Size in pixels of the workspace border */
432 char workspace_border_position; /* Where to leave a workspace border */
433 char single_click; /* single click to lauch applications */
434 int history_lines; /* history of "Run..." dialog */
435 char cycle_active_head_only; /* Cycle only windows on the active head */
436 char cycle_ignore_minimized; /* Ignore minimized windows when cycling */
437 char strict_windoze_cycle; /* don't close switch panel when shift is released */
438 char panel_only_open; /* Only open the switch panel; don't switch */
439 char apercu_size; /* Size of apercu preview as a multiple of icon size */
441 /* All delays here are in ms. 0 means instant auto-action. */
442 int clip_auto_raise_delay; /* Delay after which the clip will be raised when entered */
443 int clip_auto_lower_delay; /* Delay after which the clip will be lowered when leaved */
444 int clip_auto_expand_delay; /* Delay after which the clip will expand when entered */
445 int clip_auto_collapse_delay; /* Delay after which the clip will collapse when leaved */
447 RImage *swtileImage;
448 RImage *swbackImage[9];
450 int show_clip_title;
452 struct {
453 unsigned int nodock:1; /* don't display the dock */
454 unsigned int noclip:1; /* don't display the clip */
455 unsigned int clip_merged_in_dock:1; /* disable clip, dock gets its workspace switching functionality */
456 unsigned int nodrawer:1; /* don't use drawers */
457 unsigned int wrap_appicons_in_dock:1; /* Whether to wrap appicons when Dock is moved up and down */
458 unsigned int noupdates:1; /* don't require ~/GNUstep (-static) */
459 unsigned int noautolaunch:1; /* don't autolaunch apps */
460 unsigned int norestore:1; /* don't restore session */
461 #ifndef HAVE_INOTIFY
462 unsigned int nopolling:1; /* don't poll the defaults database for changes */
463 #endif
464 unsigned int restarting:2;
465 } flags; /* internal flags */
467 /* Map table between w_cursor and actual X id */
468 Cursor cursor[WCUR_LAST];
470 } wPreferences;
472 /****** Global Variables ******/
473 extern Display *dpy;
475 extern struct wmaker_global_variables {
476 /* Tracking of the state of the program */
477 struct {
478 wprog_state state;
479 wprog_state signal_state;
480 } program;
482 /* locale to use. NULL==POSIX or C */
483 const char *locale;
485 /* Tracking of X events timestamps */
486 struct {
487 /* ts of the last event we received */
488 Time last_event;
490 /* ts on the last time we did XSetInputFocus() */
491 Time focus_change;
493 } timestamp;
495 /* Global Domains, for storing dictionaries */
496 struct {
497 /* Note: you must #include <defaults.h> if you want to use them */
498 struct WDDomain *wmaker;
499 struct WDDomain *window_attr;
500 struct WDDomain *root_menu;
501 } domain;
503 /* Screens related */
504 int screen_count;
506 /* Workspace related */
507 struct {
508 struct WWorkspace **array; /* data for the workspaces */
510 int count; /* number of workspaces */
511 int current; /* current workspace number */
512 int last_used; /* last used workspace number */
514 WMFont *font_for_name; /* used during workspace switch */
517 * Ignore Workspace Change:
518 * this variable is used to prevent workspace switch while certain
519 * operations are ongoing.
521 Bool ignore_change;
523 /* Menus */
524 struct WMenu *menu; /* workspace operation */
525 struct WMenu *submenu; /* workspace list for window_menu */
526 } workspace;
528 /* Clip related */
529 struct {
530 struct WAppIcon *icon; /* The clip main icon, or the dock's, if they are merged */
532 struct WMenu *menu; /* Menu for clips */
533 struct WMenu *submenu; /* Workspace list for clips */
534 struct WMenu *opt_menu; /* Options for Clip */
535 struct WMenu *ws_menu; /* workspace menu for clip */
536 } clip;
538 /* Dock related */
539 struct {
540 struct WMenu *pos_menu; /* menu for position of the dock */
541 struct WMenu *drawer_menu; /* menu for the drawers */
542 } dock;
544 #ifdef HAVE_INOTIFY
545 struct {
546 int fd_event_queue; /* Inotify's queue file descriptor */
547 int wd_defaults; /* Watch Descriptor for the 'Defaults' configuration file */
548 } inotify;
549 #endif
551 /* definition for X Atoms */
552 struct {
554 /* Window-Manager related */
555 struct {
556 Atom state;
557 Atom change_state;
558 Atom protocols;
559 Atom take_focus;
560 Atom delete_window;
561 Atom save_yourself;
562 Atom client_leader;
563 Atom colormap_windows;
564 Atom colormap_notify;
565 Atom ignore_focus_events;
566 } wm;
568 /* GNUStep related */
569 struct {
570 Atom wm_attr;
571 Atom wm_miniaturize_window;
572 Atom wm_resizebar;
573 Atom titlebar_state;
574 } gnustep;
576 /* WindowMaker specific */
577 struct {
578 Atom menu;
579 Atom wm_protocols;
580 Atom state;
582 Atom wm_function;
583 Atom noticeboard;
584 Atom command;
586 Atom icon_size;
587 Atom icon_tile;
588 } wmaker;
590 } atom;
592 /* X Contexts */
593 struct {
594 XContext client_win;
595 XContext app_win;
596 XContext stack;
597 } context;
599 /* X Extensions */
600 struct {
601 #ifdef USE_XSHAPE
602 struct {
603 Bool supported;
604 int event_base;
605 } shape;
606 #endif
608 #ifdef KEEP_XKB_LOCK_STATUS
609 struct {
610 Bool supported;
611 int event_base;
612 } xkb;
613 #endif
615 #ifdef USE_RANDR
616 struct {
617 Bool supported;
618 int event_base;
619 } randr;
620 #endif
623 * If no extension were activated, we would end up with an empty
624 * structure, which old compilers may not appreciate, so let's
625 * work around this with a simple:
627 int dummy;
628 } xext;
630 /* Session related */
631 WMPropList *session_state;
633 /* Keyboard and shortcuts */
634 struct {
636 * Bit-mask to hide special key modifiers which we don't want to
637 * impact the shortcuts (typically: CapsLock, NumLock, ScrollLock)
639 unsigned int modifiers_mask;
641 WMArray *windows[MAX_WINDOW_SHORTCUTS];
642 } shortcut;
644 /* Application related */
645 struct WAppIcon *app_icon_list; /* list of all aplication icons */
647 } w_global;
649 /****** Notifications ******/
650 extern const char WMNManaged[];
651 extern const char WMNUnmanaged[];
652 extern const char WMNChangedWorkspace[];
653 extern const char WMNChangedState[];
654 extern const char WMNChangedFocus[];
655 extern const char WMNChangedStacking[];
656 extern const char WMNChangedName[];
658 extern const char WMNWorkspaceCreated[];
659 extern const char WMNWorkspaceDestroyed[];
660 extern const char WMNWorkspaceChanged[];
661 extern const char WMNWorkspaceNameChanged[];
663 extern const char WMNResetStacking[];
665 #endif