WPrefs: Code formatting in TexturePanel.c; minimizes checkpatch.pl warnings.
[wmaker-crm.git] / src / WindowMaker.h
blobfe22a79c02d8a418008939e00543e658a3b84a63
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)
236 /* drag maximized window behaviors */
237 enum {
238 DRAGMAX_MOVE,
239 DRAGMAX_RESTORE,
240 DRAGMAX_UNMAXIMIZE,
241 DRAGMAX_NOMOVE
244 /* program states */
245 typedef enum {
246 WSTATE_NORMAL = 0,
247 WSTATE_NEED_EXIT = 1,
248 WSTATE_NEED_RESTART = 2,
249 WSTATE_EXITING = 3,
250 WSTATE_RESTARTING = 4,
251 WSTATE_MODAL = 5,
252 WSTATE_NEED_REREAD = 6
253 } wprog_state;
256 #define WCHECK_STATE(chk_state) (w_global.program.state == (chk_state))
259 #define WCHANGE_STATE(nstate) {\
260 if (w_global.program.state == WSTATE_NORMAL \
261 || (nstate) != WSTATE_MODAL) \
262 w_global.program.state = (nstate); \
263 if (w_global.program.signal_state != 0) \
264 w_global.program.state = w_global.program.signal_state; \
268 /* only call inside signal handlers, with signals blocked */
269 #define SIG_WCHANGE_STATE(nstate) {\
270 w_global.program.signal_state = (nstate); \
271 w_global.program.state = (nstate); \
275 /* Flags for the Window Maker state when restarting/crash situations */
276 #define WFLAGS_NONE (0)
277 #define WFLAGS_CRASHED (1<<0)
280 /* notifications */
282 #ifdef MAINFILE
283 #define NOTIFICATION(n) const char WN##n [] = #n
284 #else
285 #define NOTIFICATION(n) extern const char WN##n []
286 #endif
288 NOTIFICATION(WindowAppearanceSettingsChanged);
290 NOTIFICATION(IconAppearanceSettingsChanged);
292 NOTIFICATION(IconTileSettingsChanged);
294 NOTIFICATION(MenuAppearanceSettingsChanged);
296 NOTIFICATION(MenuTitleAppearanceSettingsChanged);
299 /* appearance settings clientdata flags */
300 enum {
301 WFontSettings = 1 << 0,
302 WTextureSettings = 1 << 1,
303 WColorSettings = 1 << 2
308 typedef struct {
309 int x1, y1;
310 int x2, y2;
311 } WArea;
313 typedef struct WCoord {
314 int x, y;
315 } WCoord;
317 extern struct WPreferences {
318 char *pixmap_path; /* : separated list of paths to find pixmaps */
319 char *icon_path; /* : separated list of paths to find icons */
320 WMArray *fallbackWMs; /* fallback window manager list */
321 char *logger_shell; /* shell to log child stdi/o */
322 RImage *button_images; /* titlebar button images */
323 char smooth_workspace_back;
324 signed char size_display; /* display type for resize geometry */
325 signed char move_display; /* display type for move geometry */
326 signed char window_placement; /* window placement mode */
327 signed char colormap_mode; /* colormap focus mode */
328 signed char focus_mode; /* window focusing mode */
330 char opaque_move; /* update window position during move */
331 char opaque_resize; /* update window position during resize */
332 char opaque_move_resize_keyboard; /* update window position during move,resize with keyboard */
333 char wrap_menus; /* wrap menus at edge of screen */
334 char scrollable_menus; /* let them be scrolled */
335 char vi_key_menus; /* use h/j/k/l to select */
336 char align_menus; /* align menu with their parents */
337 char use_saveunders; /* turn on SaveUnders for menus, icons etc. */
338 char no_window_over_dock;
339 char no_window_over_icons;
340 WCoord window_place_origin; /* Offset for windows placed on screen */
342 char constrain_window_size; /* don't let windows get bigger than screen */
343 char windows_cycling; /* windoze cycling */
344 char circ_raise; /* raise window after Alt-tabbing */
345 char ignore_focus_click;
346 char open_transients_with_parent; /* open transient window in same workspace as parent */
347 signed char title_justification; /* titlebar text alignment */
348 int window_title_clearance;
349 int window_title_min_height;
350 int window_title_max_height;
351 int menu_title_clearance;
352 int menu_title_min_height;
353 int menu_title_max_height;
354 int menu_text_clearance;
355 char multi_byte_text;
356 #ifdef KEEP_XKB_LOCK_STATUS
357 char modelock;
358 #endif
359 char no_dithering; /* use dithering or not */
360 char no_animations; /* enable/disable animations */
361 char no_autowrap; /* wrap workspace when window is moved to the edge */
362 char window_snapping; /* enable window snapping */
363 int snap_edge_detect; /* how far from edge to begin snap */
364 int snap_corner_detect; /* how far from corner to begin snap */
365 char snap_to_top_maximizes_fullscreen;
366 char drag_maximized_window; /* behavior when a maximized window is dragged */
368 char highlight_active_app; /* show the focused app by highlighting its icon */
369 char auto_arrange_icons; /* automagically arrange icons */
370 char icon_box_position; /* position to place icons */
371 signed char iconification_style; /* position to place icons */
372 char disable_root_mouse; /* disable button events in root window */
373 char auto_focus; /* focus window when it's mapped */
374 char *icon_back_file; /* background image for icons */
376 WCoord *root_menu_pos; /* initial position of the root menu*/
377 WCoord *app_menu_pos;
378 WCoord *win_menu_pos;
380 signed char icon_yard; /* aka iconbox */
382 int raise_delay; /* delay for autoraise. 0 is disabled */
383 int cmap_size; /* size of dithering colormap in colors per channel */
385 int icon_size; /* size of the icon */
386 signed char menu_style; /* menu decoration style */
387 signed char workspace_name_display_position;
388 unsigned int modifier_mask; /* mask to use as kbd modifier */
389 char *modifier_labels[7]; /* Names of the modifiers */
391 unsigned int supports_tiff; /* Use tiff files */
393 char ws_advance; /* Create new workspace and advance */
394 char ws_cycle; /* Cycle existing workspaces */
395 char save_session_on_exit; /* automatically save session on exit */
396 char sticky_icons; /* If miniwindows will be onmipresent */
397 char dont_confirm_kill; /* do not confirm Kill application */
398 char disable_miniwindows;
399 char enable_workspace_pager;
400 char ignore_gtk_decoration_hints;
402 char dont_blink; /* do not blink icon selection */
404 /* Appearance options */
405 char new_style; /* Use newstyle buttons */
406 char superfluous; /* Use superfluous things */
408 /* root window mouse bindings */
409 signed char mouse_button1; /* action for left mouse button */
410 signed char mouse_button2; /* action for middle mouse button */
411 signed char mouse_button3; /* action for right mouse button */
412 signed char mouse_button8; /* action for 4th button aka backward mouse button */
413 signed char mouse_button9; /* action for 5th button aka forward mouse button */
414 signed char mouse_wheel_scroll; /* action for mouse wheel scroll */
415 signed char mouse_wheel_tilt; /* action for mouse wheel tilt */
417 /* balloon text */
418 char window_balloon;
419 char miniwin_title_balloon;
420 char miniwin_preview_balloon;
421 char appicon_balloon;
422 char help_balloon;
424 /* some constants */
425 int dblclick_time; /* double click delay time in ms */
427 /* animate menus */
428 signed char menu_scroll_speed; /* how fast menus are scrolled */
430 /* animate icon sliding */
431 signed char icon_slide_speed; /* icon slide animation speed */
433 /* shading animation */
434 signed char shade_speed;
436 /* bouncing animation */
437 char bounce_appicons_when_urgent;
438 char raise_appicons_when_bouncing;
439 char do_not_make_appicons_bounce;
441 int edge_resistance;
442 int resize_increment;
443 char attract;
445 unsigned int workspace_border_size; /* Size in pixels of the workspace border */
446 char workspace_border_position; /* Where to leave a workspace border */
447 char single_click; /* single click to lauch applications */
448 int history_lines; /* history of "Run..." dialog */
449 char cycle_active_head_only; /* Cycle only windows on the active head */
450 char cycle_ignore_minimized; /* Ignore minimized windows when cycling */
451 char strict_windoze_cycle; /* don't close switch panel when shift is released */
452 char panel_only_open; /* Only open the switch panel; don't switch */
453 int minipreview_size; /* Size of Mini-Previews in pixels */
455 /* All delays here are in ms. 0 means instant auto-action. */
456 int clip_auto_raise_delay; /* Delay after which the clip will be raised when entered */
457 int clip_auto_lower_delay; /* Delay after which the clip will be lowered when leaved */
458 int clip_auto_expand_delay; /* Delay after which the clip will expand when entered */
459 int clip_auto_collapse_delay; /* Delay after which the clip will collapse when leaved */
461 RImage *swtileImage;
462 RImage *swbackImage[9];
464 union WTexture *wsmbackTexture;
466 char show_clip_title;
468 struct {
469 #ifdef USE_ICCCM_WMREPLACE
470 unsigned int replace:1; /* replace existing window manager */
471 #endif
472 unsigned int nodock:1; /* don't display the dock */
473 unsigned int noclip:1; /* don't display the clip */
474 unsigned int clip_merged_in_dock:1; /* disable clip, switch workspaces with dock */
475 unsigned int nodrawer:1; /* don't use drawers */
476 unsigned int wrap_appicons_in_dock:1; /* Whether to wrap appicons when Dock is moved up and down */
477 unsigned int noupdates:1; /* don't require ~/GNUstep (-static) */
478 unsigned int noautolaunch:1; /* don't autolaunch apps */
479 unsigned int norestore:1; /* don't restore session */
480 unsigned int restarting:2;
481 } flags; /* internal flags */
483 /* Map table between w_cursor and actual X id */
484 Cursor cursor[WCUR_LAST];
486 } wPreferences;
488 /****** Global Variables ******/
489 extern Display *dpy;
491 extern struct wmaker_global_variables {
492 /* Tracking of the state of the program */
493 struct {
494 wprog_state state;
495 wprog_state signal_state;
496 } program;
498 /* locale to use. NULL==POSIX or C */
499 const char *locale;
501 /* Tracking of X events timestamps */
502 struct {
503 /* ts of the last event we received */
504 Time last_event;
506 /* ts on the last time we did XSetInputFocus() */
507 Time focus_change;
509 } timestamp;
511 /* Global Domains, for storing dictionaries */
512 struct {
513 /* Note: you must #include <defaults.h> if you want to use them */
514 struct WDDomain *wmaker;
515 struct WDDomain *window_attr;
516 struct WDDomain *root_menu;
517 } domain;
519 /* Screens related */
520 int screen_count;
523 * Ignore Workspace Change:
524 * this variable is used to prevent workspace switch while certain
525 * operations are ongoing.
527 Bool ignore_workspace_change;
530 * Process WorkspaceMap Event:
531 * this variable is set when the Workspace Map window is being displayed,
532 * it is mainly used to avoid re-opening another one at the same time
534 Bool process_workspacemap_event;
536 #ifdef HAVE_INOTIFY
537 struct {
538 int fd_event_queue; /* Inotify's queue file descriptor */
539 int wd_defaults; /* Watch Descriptor for the 'Defaults' configuration file */
540 } inotify;
541 #endif
543 /* definition for X Atoms */
544 struct {
546 /* Window-Manager related */
547 struct {
548 Atom state;
549 Atom change_state;
550 Atom protocols;
551 Atom take_focus;
552 Atom delete_window;
553 Atom save_yourself;
554 Atom client_leader;
555 Atom colormap_windows;
556 Atom colormap_notify;
557 Atom ignore_focus_events;
558 } wm;
560 /* GNUStep related */
561 struct {
562 Atom wm_attr;
563 Atom wm_miniaturize_window;
564 Atom wm_resizebar;
565 Atom titlebar_state;
566 } gnustep;
568 /* Destkop-environment related */
569 struct {
570 Atom gtk_object_path;
571 } desktop;
573 /* WindowMaker specific */
574 struct {
575 Atom menu;
576 Atom wm_protocols;
577 Atom state;
579 Atom wm_function;
580 Atom noticeboard;
581 Atom command;
583 Atom icon_size;
584 Atom icon_tile;
585 } wmaker;
587 } atom;
589 /* X Contexts */
590 struct {
591 XContext client_win;
592 XContext app_win;
593 XContext stack;
594 } context;
596 /* X Extensions */
597 struct {
598 #ifdef USE_XSHAPE
599 struct {
600 Bool supported;
601 int event_base;
602 } shape;
603 #endif
605 #ifdef KEEP_XKB_LOCK_STATUS
606 struct {
607 Bool supported;
608 int event_base;
609 } xkb;
610 #endif
612 #ifdef USE_RANDR
613 struct {
614 Bool supported;
615 int event_base;
616 } randr;
617 #endif
620 * If no extension were activated, we would end up with an empty
621 * structure, which old compilers may not appreciate, so let's
622 * work around this with a simple:
624 int dummy;
625 } xext;
627 /* Keyboard and shortcuts */
628 struct {
630 * Bit-mask to hide special key modifiers which we don't want to
631 * impact the shortcuts (typically: CapsLock, NumLock, ScrollLock)
633 unsigned int modifiers_mask;
634 } shortcut;
635 } w_global;
637 /****** Notifications ******/
638 extern const char WMNManaged[];
639 extern const char WMNUnmanaged[];
640 extern const char WMNChangedWorkspace[];
641 extern const char WMNChangedState[];
642 extern const char WMNChangedFocus[];
643 extern const char WMNChangedStacking[];
644 extern const char WMNChangedName[];
646 extern const char WMNWorkspaceCreated[];
647 extern const char WMNWorkspaceDestroyed[];
648 extern const char WMNWorkspaceChanged[];
649 extern const char WMNWorkspaceNameChanged[];
651 extern const char WMNResetStacking[];
653 #endif