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_
28 #include <WINGs/WINGs.h>
34 WCLASS_WINDOW
= 1, /* managed client windows */
35 WCLASS_MENU
= 2, /* root menus */
37 WCLASS_DUMMYWINDOW
= 4, /* window that holds window group leader */
38 WCLASS_MINIWINDOW
= 5,
41 WCLASS_TEXT_INPUT
= 8,
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,
53 WMBackLevel
= INT_MIN
+1, /* Very lowest level */
54 WMDesktopLevel
= -1000, /* Lowest level of normal use */
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 */
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) */
90 /* internal buttons */
92 #define WBUT_BROKENCLOSE 1
93 #define WBUT_ICONIFY 2
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 */
102 #define PRED_BPIXMAPS 4 /* count of WBUT icons */
103 #endif /* XKB_BUTTON_HINT */
112 WCUR_BOTTOMLEFTRESIZE
,
113 WCUR_BOTTOMRIGHTRESIZE
,
124 /* Count of the number of cursors defined */
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 */
135 /* keyboard input focus mode */
139 /* colormap change mode */
141 #define WCM_POINTER 1
143 /* window placement mode */
145 #define WPM_CASCADE 1
151 /* text justification */
156 /* iconification styles */
161 #define WIS_RANDOM 4 /* secret */
163 /* switchmenu actions */
165 #define ACTION_REMOVE 1
166 #define ACTION_CHANGE 2
167 #define ACTION_CHANGE_WORKSPACE 3
168 #define ACTION_CHANGE_STATE 4
172 #define SPEED_ULTRAFAST 0
174 #define SPEED_MEDIUM 2
176 #define SPEED_ULTRASLOW 4
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 */
200 #define MS_SINGLE_TEXTURE 1
203 /* workspace actions */
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 */
221 #define WD_TOPRIGHT 5
222 #define WD_BOTTOMLEFT 6
223 #define WD_BOTTOMRIGHT 7
230 /* workspace border position */
232 #define WB_LEFTRIGHT 1
233 #define WB_TOPBOTTOM 2
234 #define WB_ALLDIRS (WB_LEFTRIGHT|WB_TOPBOTTOM)
240 WSTATE_NEED_EXIT
= 1,
241 WSTATE_NEED_RESTART
= 2,
243 WSTATE_RESTARTING
= 4,
245 WSTATE_NEED_REREAD
= 6
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)
276 #define NOTIFICATION(n) const char WN##n [] = #n
278 #define NOTIFICATION(n) extern const char WN##n []
281 NOTIFICATION(WindowAppearanceSettingsChanged
);
283 NOTIFICATION(IconAppearanceSettingsChanged
);
285 NOTIFICATION(IconTileSettingsChanged
);
287 NOTIFICATION(MenuAppearanceSettingsChanged
);
289 NOTIFICATION(MenuTitleAppearanceSettingsChanged
);
292 /* appearance settings clientdata flags */
294 WFontSettings
= 1 << 0,
295 WTextureSettings
= 1 << 1,
296 WColorSettings
= 1 << 2
306 typedef struct 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
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 */
356 char highlight_active_app
; /* show the focused app by highlighting its icon */
357 char auto_arrange_icons
; /* automagically arrange icons */
358 char icon_box_position
; /* position to place icons */
359 signed char iconification_style
; /* position to place icons */
360 char disable_root_mouse
; /* disable button events in root window */
361 char auto_focus
; /* focus window when it's mapped */
362 char *icon_back_file
; /* background image for icons */
364 WCoord
*root_menu_pos
; /* initial position of the root menu*/
365 WCoord
*app_menu_pos
;
366 WCoord
*win_menu_pos
;
368 signed char icon_yard
; /* aka iconbox */
370 int raise_delay
; /* delay for autoraise. 0 is disabled */
371 int cmap_size
; /* size of dithering colormap in colors per channel */
373 int icon_size
; /* size of the icon */
374 signed char menu_style
; /* menu decoration style */
375 signed char workspace_name_display_position
;
376 unsigned int modifier_mask
; /* mask to use as kbd modifier */
377 char *modifier_labels
[7]; /* Names of the modifiers */
379 unsigned int supports_tiff
; /* Use tiff files */
381 char ws_advance
; /* Create new workspace and advance */
382 char ws_cycle
; /* Cycle existing workspaces */
383 char save_session_on_exit
; /* automatically save session on exit */
384 char sticky_icons
; /* If miniwindows will be onmipresent */
385 char dont_confirm_kill
; /* do not confirm Kill application */
386 char disable_miniwindows
;
387 char dont_blink
; /* do not blink icon selection */
389 /* Appearance options */
390 char new_style
; /* Use newstyle buttons */
391 char superfluous
; /* Use superfluous things */
393 /* root window mouse bindings */
394 signed char mouse_button1
; /* action for left mouse button */
395 signed char mouse_button2
; /* action for middle mouse button */
396 signed char mouse_button3
; /* action for right mouse button */
397 signed char mouse_button8
; /* action for 4th button aka backward mouse button */
398 signed char mouse_button9
; /* action for 5th button aka forward mouse button */
399 signed char mouse_wheel_scroll
; /* action for mouse wheel scroll */
400 signed char mouse_wheel_tilt
; /* action for mouse wheel tilt */
404 char miniwin_title_balloon
;
405 char miniwin_apercu_balloon
;
406 char appicon_balloon
;
410 int dblclick_time
; /* double click delay time in ms */
413 signed char menu_scroll_speed
; /* how fast menus are scrolled */
415 /* animate icon sliding */
416 signed char icon_slide_speed
; /* icon slide animation speed */
418 /* shading animation */
419 signed char shade_speed
;
421 /* bouncing animation */
422 char bounce_appicons_when_urgent
;
423 char raise_appicons_when_bouncing
;
424 char do_not_make_appicons_bounce
;
427 int resize_increment
;
430 unsigned int workspace_border_size
; /* Size in pixels of the workspace border */
431 char workspace_border_position
; /* Where to leave a workspace border */
432 char single_click
; /* single click to lauch applications */
433 int history_lines
; /* history of "Run..." dialog */
434 char cycle_active_head_only
; /* Cycle only windows on the active head */
435 char cycle_ignore_minimized
; /* Ignore minimized windows when cycling */
436 char strict_windoze_cycle
; /* don't close switch panel when shift is released */
437 char panel_only_open
; /* Only open the switch panel; don't switch */
438 char apercu_size
; /* Size of apercu preview as a multiple of icon size */
440 /* All delays here are in ms. 0 means instant auto-action. */
441 int clip_auto_raise_delay
; /* Delay after which the clip will be raised when entered */
442 int clip_auto_lower_delay
; /* Delay after which the clip will be lowered when leaved */
443 int clip_auto_expand_delay
; /* Delay after which the clip will expand when entered */
444 int clip_auto_collapse_delay
; /* Delay after which the clip will collapse when leaved */
447 RImage
*swbackImage
[9];
452 unsigned int nodock
:1; /* don't display the dock */
453 unsigned int noclip
:1; /* don't display the clip */
454 unsigned int clip_merged_in_dock
:1; /* disable clip, dock gets its workspace switching functionality */
455 unsigned int nodrawer
:1; /* don't use drawers */
456 unsigned int wrap_appicons_in_dock
:1; /* Whether to wrap appicons when Dock is moved up and down */
457 unsigned int noupdates
:1; /* don't require ~/GNUstep (-static) */
458 unsigned int noautolaunch
:1; /* don't autolaunch apps */
459 unsigned int norestore
:1; /* don't restore session */
461 unsigned int nopolling
:1; /* don't poll the defaults database for changes */
463 unsigned int restarting
:2;
464 } flags
; /* internal flags */
466 /* Map table between w_cursor and actual X id */
467 Cursor cursor
[WCUR_LAST
];
471 /****** Global Variables ******/
474 extern struct wmaker_global_variables
{
475 /* Tracking of the state of the program */
478 wprog_state signal_state
;
481 /* locale to use. NULL==POSIX or C */
484 /* Tracking of X events timestamps */
486 /* ts of the last event we received */
489 /* ts on the last time we did XSetInputFocus() */
494 /* Global Domains, for storing dictionaries */
496 /* Note: you must #include <defaults.h> if you want to use them */
497 struct WDDomain
*wmaker
;
498 struct WDDomain
*window_attr
;
499 struct WDDomain
*root_menu
;
502 /* Screens related */
505 /* Workspace related */
507 struct WWorkspace
**array
; /* data for the workspaces */
509 int count
; /* number of workspaces */
510 int current
; /* current workspace number */
511 int last_used
; /* last used workspace number */
513 WMFont
*font_for_name
; /* used during workspace switch */
516 * Ignore Workspace Change:
517 * this variable is used to prevent workspace switch while certain
518 * operations are ongoing.
523 struct WMenu
*menu
; /* workspace operation */
524 struct WMenu
*submenu
; /* workspace list for window_menu */
529 struct WAppIcon
*icon
; /* The clip main icon, or the dock's, if they are merged */
531 struct WMenu
*menu
; /* Menu for clips */
532 struct WMenu
*submenu
; /* Workspace list for clips */
533 struct WMenu
*opt_menu
; /* Options for Clip */
534 struct WMenu
*ws_menu
; /* workspace menu for clip */
539 struct WMenu
*pos_menu
; /* menu for position of the dock */
540 struct WMenu
*drawer_menu
; /* menu for the drawers */
545 int fd_event_queue
; /* Inotify's queue file descriptor */
546 int wd_defaults
; /* Watch Descriptor for the 'Defaults' configuration file */
550 /* definition for X Atoms */
553 /* Window-Manager related */
562 Atom colormap_windows
;
563 Atom colormap_notify
;
564 Atom ignore_focus_events
;
567 /* GNUStep related */
570 Atom wm_miniaturize_window
;
575 /* WindowMaker specific */
607 #ifdef KEEP_XKB_LOCK_STATUS
622 * If no extension were activated, we would end up with an empty
623 * structure, which old compilers may not appreciate, so let's
624 * work around this with a simple:
629 /* Session related */
630 WMPropList
*session_state
;
632 /* Keyboard and shortcuts */
635 * Bit-mask to hide special key modifiers which we don't want to
636 * impact the shortcuts (typically: CapsLock, NumLock, ScrollLock)
638 unsigned int modifiers_mask
;
640 WMArray
*windows
[MAX_WINDOW_SHORTCUTS
];
643 /* Application related */
644 struct WAppIcon
*app_icon_list
; /* list of all aplication icons */
648 /****** Notifications ******/
649 extern const char WMNManaged
[];
650 extern const char WMNUnmanaged
[];
651 extern const char WMNChangedWorkspace
[];
652 extern const char WMNChangedState
[];
653 extern const char WMNChangedFocus
[];
654 extern const char WMNChangedStacking
[];
655 extern const char WMNChangedName
[];
657 extern const char WMNWorkspaceCreated
[];
658 extern const char WMNWorkspaceDestroyed
[];
659 extern const char WMNWorkspaceChanged
[];
660 extern const char WMNWorkspaceNameChanged
[];
662 extern const char WMNResetStacking
[];