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