2 * Window Maker window manager
4 * Copyright (c) 1997-2003 Alfredo K. Kojima
5 * Copyright (c) 2014-2023 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 */
62 WMFullscreenLevel
= 50,
65 WMScreensaverLevel
= 1000,
66 WMOuterSpaceLevel
= INT_MAX
70 * WObjDescriptor will be used by the event dispatcher to
71 * send events to a particular object through the methods in the
72 * method table. If all objects of the same class share the
73 * same methods, the class method table should be used, otherwise
74 * a new method table must be created for each object.
75 * It is also assigned to find the parent structure of a given
76 * window (like the WWindow or WMenu for a button)
79 typedef struct WObjDescriptor
{
80 void *self
; /* the object that will be called */
82 void (*handle_expose
)(struct WObjDescriptor
*sender
, XEvent
*event
);
83 void (*handle_mousedown
)(struct WObjDescriptor
*sender
, XEvent
*event
);
84 void (*handle_enternotify
)(struct WObjDescriptor
*sender
, XEvent
*event
);
85 void (*handle_leavenotify
)(struct WObjDescriptor
*sender
, XEvent
*event
);
87 WClassType parent_type
; /* type code of the parent */
88 void *parent
; /* parent object (WWindow or WMenu) */
91 /* internal buttons */
93 #define WBUT_BROKENCLOSE 1
94 #define WBUT_ICONIFY 2
96 #ifdef XKB_BUTTON_HINT
97 #define WBUT_XKBGROUP1 4
98 #define WBUT_XKBGROUP2 5
99 #define WBUT_XKBGROUP3 6
100 #define WBUT_XKBGROUP4 7
101 #define PRED_BPIXMAPS 8 /* reserved for 4 groups */
103 #define PRED_BPIXMAPS 4 /* count of WBUT icons */
104 #endif /* XKB_BUTTON_HINT */
113 WCUR_BOTTOMLEFTRESIZE
,
114 WCUR_BOTTOMRIGHTRESIZE
,
126 /* Count of the number of cursors defined */
130 /* geometry displays */
131 #define WDIS_NEW 0 /* new style */
132 #define WDIS_CENTER 1 /* center of screen */
133 #define WDIS_TOPLEFT 2 /* top left corner of screen */
134 #define WDIS_FRAME_CENTER 3 /* center of the frame */
137 /* keyboard input focus mode */
141 /* colormap change mode */
143 #define WCM_POINTER 1
145 /* window placement mode */
147 #define WPM_CASCADE 1
153 /* text justification */
158 /* iconification styles */
163 #define WIS_RANDOM 4 /* secret */
165 /* switchmenu actions */
167 #define ACTION_REMOVE 1
168 #define ACTION_CHANGE 2
169 #define ACTION_CHANGE_WORKSPACE 3
170 #define ACTION_CHANGE_STATE 4
174 #define SPEED_ULTRAFAST 0
176 #define SPEED_MEDIUM 2
178 #define SPEED_ULTRASLOW 4
183 #define WS_UNFOCUSED 1
184 #define WS_PFOCUSED 2
186 /* clip title colors */
187 #define CLIP_NORMAL 0
188 #define CLIP_COLLAPSED 1
191 /* icon yard position */
202 #define MS_SINGLE_TEXTURE 1
205 /* workspace actions */
207 #define WA_SELECT_WINDOWS 1
208 #define WA_OPEN_APPMENU 2
209 #define WA_OPEN_WINLISTMENU 3
210 #define WA_SWITCH_WORKSPACES 4
211 #define WA_MOVE_PREVWORKSPACE 5
212 #define WA_MOVE_NEXTWORKSPACE 6
213 #define WA_SWITCH_WINDOWS 7
214 #define WA_MOVE_PREVWINDOW 8
215 #define WA_MOVE_NEXTWINDOW 9
217 /* workspace display position */
223 #define WD_TOPRIGHT 5
224 #define WD_BOTTOMLEFT 6
225 #define WD_BOTTOMRIGHT 7
232 /* workspace border position */
234 #define WB_LEFTRIGHT 1
235 #define WB_TOPBOTTOM 2
236 #define WB_ALLDIRS (WB_LEFTRIGHT|WB_TOPBOTTOM)
238 /* drag maximized window behaviors */
249 WSTATE_NEED_EXIT
= 1,
250 WSTATE_NEED_RESTART
= 2,
252 WSTATE_RESTARTING
= 4,
254 WSTATE_NEED_REREAD
= 6
258 #define WCHECK_STATE(chk_state) (w_global.program.state == (chk_state))
261 #define WCHANGE_STATE(nstate) {\
262 if (w_global.program.state == WSTATE_NORMAL \
263 || (nstate) != WSTATE_MODAL) \
264 w_global.program.state = (nstate); \
265 if (w_global.program.signal_state != 0) \
266 w_global.program.state = w_global.program.signal_state; \
270 /* only call inside signal handlers, with signals blocked */
271 #define SIG_WCHANGE_STATE(nstate) {\
272 w_global.program.signal_state = (nstate); \
273 w_global.program.state = (nstate); \
277 /* Flags for the Window Maker state when restarting/crash situations */
278 #define WFLAGS_NONE (0)
279 #define WFLAGS_CRASHED (1<<0)
285 #define NOTIFICATION(n) const char WN##n [] = #n
287 #define NOTIFICATION(n) extern const char WN##n []
290 NOTIFICATION(WindowAppearanceSettingsChanged
);
292 NOTIFICATION(IconAppearanceSettingsChanged
);
294 NOTIFICATION(IconTileSettingsChanged
);
296 NOTIFICATION(MenuAppearanceSettingsChanged
);
298 NOTIFICATION(MenuTitleAppearanceSettingsChanged
);
301 /* appearance settings clientdata flags */
303 WFontSettings
= 1 << 0,
304 WTextureSettings
= 1 << 1,
305 WColorSettings
= 1 << 2
315 typedef struct WCoord
{
319 extern struct WPreferences
{
320 char *pixmap_path
; /* : separated list of paths to find pixmaps */
321 char *icon_path
; /* : separated list of paths to find icons */
322 WMArray
*fallbackWMs
; /* fallback window manager list */
323 char *logger_shell
; /* shell to log child stdi/o */
324 RImage
*button_images
; /* titlebar button images */
325 char smooth_workspace_back
;
326 signed char size_display
; /* display type for resize geometry */
327 signed char move_display
; /* display type for move geometry */
328 signed char window_placement
; /* window placement mode */
329 signed char colormap_mode
; /* colormap focus mode */
330 signed char focus_mode
; /* window focusing mode */
332 char opaque_move
; /* update window position during move */
333 char opaque_resize
; /* update window position during resize */
334 char opaque_move_resize_keyboard
; /* update window position during move,resize with keyboard */
335 char wrap_menus
; /* wrap menus at edge of screen */
336 char scrollable_menus
; /* let them be scrolled */
337 char vi_key_menus
; /* use h/j/k/l to select */
338 char align_menus
; /* align menu with their parents */
339 char use_saveunders
; /* turn on SaveUnders for menus, icons etc. */
340 char no_window_over_dock
;
341 char no_window_over_icons
;
342 WCoord window_place_origin
; /* Offset for windows placed on screen */
344 char constrain_window_size
; /* don't let windows get bigger than screen */
345 char windows_cycling
; /* windoze cycling */
346 char circ_raise
; /* raise window after Alt-tabbing */
347 char ignore_focus_click
;
348 char open_transients_with_parent
; /* open transient window in same workspace as parent */
349 signed char title_justification
; /* titlebar text alignment */
350 int window_title_clearance
;
351 int window_title_min_height
;
352 int window_title_max_height
;
353 int menu_title_clearance
;
354 int menu_title_min_height
;
355 int menu_title_max_height
;
356 int menu_text_clearance
;
357 char multi_byte_text
;
358 #ifdef KEEP_XKB_LOCK_STATUS
361 char no_dithering
; /* use dithering or not */
362 char no_animations
; /* enable/disable animations */
363 char no_autowrap
; /* wrap workspace when window is moved to the edge */
364 char window_snapping
; /* enable window snapping */
365 int snap_edge_detect
; /* how far from edge to begin snap */
366 int snap_corner_detect
; /* how far from corner to begin snap */
367 char snap_to_top_maximizes_fullscreen
;
368 char drag_maximized_window
; /* behavior when a maximized window is dragged */
369 char move_half_max_between_heads
; /* move half maximized window between available heads */
370 char alt_half_maximize
; /* alternative half-maximize feature behavior */
371 char pointer_with_half_max_windows
;
373 char highlight_active_app
; /* show the focused app by highlighting its icon */
374 char auto_arrange_icons
; /* automagically arrange icons */
375 char icon_box_position
; /* position to place icons */
376 signed char iconification_style
; /* position to place icons */
377 char disable_root_mouse
; /* disable button events in root window */
378 char auto_focus
; /* focus window when it's mapped */
379 char *icon_back_file
; /* background image for icons */
380 char enforce_icon_margin
; /* auto-shrink icon images */
382 WCoord
*root_menu_pos
; /* initial position of the root menu*/
383 WCoord
*app_menu_pos
;
384 WCoord
*win_menu_pos
;
386 signed char icon_yard
; /* aka iconbox */
388 int raise_delay
; /* delay for autoraise. 0 is disabled */
389 int cmap_size
; /* size of dithering colormap in colors per channel */
391 int icon_size
; /* size of the icon */
392 signed char menu_style
; /* menu decoration style */
393 signed char workspace_name_display_position
;
394 unsigned int modifier_mask
; /* mask to use as kbd modifier */
395 char *modifier_labels
[7]; /* Names of the modifiers */
397 unsigned int supports_tiff
; /* Use tiff files */
399 char ws_advance
; /* Create new workspace and advance */
400 char ws_cycle
; /* Cycle existing workspaces */
401 char save_session_on_exit
; /* automatically save session on exit */
402 char sticky_icons
; /* If miniwindows will be onmipresent */
403 char dont_confirm_kill
; /* do not confirm Kill application */
404 char disable_miniwindows
;
405 char enable_workspace_pager
;
406 char ignore_gtk_decoration_hints
;
408 char dont_blink
; /* do not blink icon selection */
409 char keep_dock_on_primary_head
; /* keep dock on primary head */
411 /* Appearance options */
412 char new_style
; /* Use newstyle buttons */
413 char superfluous
; /* Use superfluous things */
415 /* root window mouse bindings */
416 signed char mouse_button1
; /* action for left mouse button */
417 signed char mouse_button2
; /* action for middle mouse button */
418 signed char mouse_button3
; /* action for right mouse button */
419 signed char mouse_button8
; /* action for 4th button aka backward mouse button */
420 signed char mouse_button9
; /* action for 5th button aka forward mouse button */
421 signed char mouse_wheel_scroll
; /* action for mouse wheel scroll */
422 signed char mouse_wheel_tilt
; /* action for mouse wheel tilt */
426 char miniwin_title_balloon
;
427 char miniwin_preview_balloon
;
428 char appicon_balloon
;
432 int dblclick_time
; /* double click delay time in ms */
435 signed char menu_scroll_speed
; /* how fast menus are scrolled */
437 /* animate icon sliding */
438 signed char icon_slide_speed
; /* icon slide animation speed */
440 /* shading animation */
441 signed char shade_speed
;
443 /* bouncing animation */
444 char bounce_appicons_when_urgent
;
445 char raise_appicons_when_bouncing
;
446 char do_not_make_appicons_bounce
;
449 int resize_increment
;
452 unsigned int workspace_border_size
; /* Size in pixels of the workspace border */
453 char workspace_border_position
; /* Where to leave a workspace border */
454 char single_click
; /* single click to lauch applications */
455 int history_lines
; /* history of "Run..." dialog */
456 char cycle_active_head_only
; /* Cycle only windows on the active head */
457 char cycle_ignore_minimized
; /* Ignore minimized windows when cycling */
458 char double_click_fullscreen
; /* Double click on titlebar maximize a window to full screen*/
459 char close_rootmenu_left_right_click
;/* Close application menu when mouse (left or right) is clicked outside focus */
460 char strict_windoze_cycle
; /* don't close switch panel when shift is released */
461 char panel_only_open
; /* Only open the switch panel; don't switch */
462 int minipreview_size
; /* Size of Mini-Previews in pixels */
464 /* All delays here are in ms. 0 means instant auto-action. */
465 int clip_auto_raise_delay
; /* Delay after which the clip will be raised when entered */
466 int clip_auto_lower_delay
; /* Delay after which the clip will be lowered when leaved */
467 int clip_auto_expand_delay
; /* Delay after which the clip will expand when entered */
468 int clip_auto_collapse_delay
; /* Delay after which the clip will collapse when leaved */
471 RImage
*swbackImage
[9];
473 union WTexture
*wsmbackTexture
;
475 char show_clip_title
;
477 char hot_corners
; /* let corners execute actions */
478 int hot_corner_delay
; /* Delay after which the hot corner is triggered */
479 int hot_corner_edge
; /* Hot corner edge size */
480 char *hot_corner_actions
[4]; /* Action of each corner */
483 #ifdef USE_ICCCM_WMREPLACE
484 unsigned int replace
:1; /* replace existing window manager */
486 unsigned int nodock
:1; /* don't display the dock */
487 unsigned int noclip
:1; /* don't display the clip */
488 unsigned int clip_merged_in_dock
:1; /* disable clip, switch workspaces with dock */
489 unsigned int nodrawer
:1; /* don't use drawers */
490 unsigned int wrap_appicons_in_dock
:1; /* Whether to wrap appicons when Dock is moved up and down */
491 unsigned int noupdates
:1; /* don't require ~/GNUstep (-static) */
492 unsigned int noautolaunch
:1; /* don't autolaunch apps */
493 unsigned int norestore
:1; /* don't restore session */
494 unsigned int restarting
:2;
495 } flags
; /* internal flags */
497 /* Map table between w_cursor and actual X id */
498 Cursor cursor
[WCUR_LAST
];
500 int switch_panel_icon_size
; /* icon size in switch panel */
504 /****** Global Variables ******/
507 extern struct wmaker_global_variables
{
508 /* Tracking of the state of the program */
511 wprog_state signal_state
;
514 /* locale to use. NULL==POSIX or C */
517 /* Tracking of X events timestamps */
519 /* ts of the last event we received */
522 /* ts on the last time we did XSetInputFocus() */
527 /* Global Domains, for storing dictionaries */
529 /* Note: you must #include <defaults.h> if you want to use them */
530 struct WDDomain
*wmaker
;
531 struct WDDomain
*window_attr
;
532 struct WDDomain
*root_menu
;
535 /* Screens related */
539 * Ignore Workspace Change:
540 * this variable is used to prevent workspace switch while certain
541 * operations are ongoing.
543 Bool ignore_workspace_change
;
546 * Process WorkspaceMap Event:
547 * this variable is set when the Workspace Map window is being displayed,
548 * it is mainly used to avoid re-opening another one at the same time
550 Bool process_workspacemap_event
;
554 int fd_event_queue
; /* Inotify's queue file descriptor */
555 int wd_defaults
; /* Watch Descriptor for the 'Defaults' configuration file */
559 /* definition for X Atoms */
562 /* Window-Manager related */
571 Atom colormap_windows
;
572 Atom colormap_notify
;
573 Atom ignore_focus_events
;
576 /* GNUStep related */
579 Atom wm_miniaturize_window
;
584 /* Destkop-environment related */
586 Atom gtk_object_path
;
589 /* WindowMaker specific */
621 #ifdef KEEP_XKB_LOCK_STATUS
636 * If no extension were activated, we would end up with an empty
637 * structure, which old compilers may not appreciate, so let's
638 * work around this with a simple:
643 /* Keyboard and shortcuts */
646 * Bit-mask to hide special key modifiers which we don't want to
647 * impact the shortcuts (typically: CapsLock, NumLock, ScrollLock)
649 unsigned int modifiers_mask
;
653 /****** Notifications ******/
654 extern const char WMNManaged
[];
655 extern const char WMNUnmanaged
[];
656 extern const char WMNChangedWorkspace
[];
657 extern const char WMNChangedState
[];
658 extern const char WMNChangedFocus
[];
659 extern const char WMNChangedStacking
[];
660 extern const char WMNChangedName
[];
662 extern const char WMNWorkspaceCreated
[];
663 extern const char WMNWorkspaceDestroyed
[];
664 extern const char WMNWorkspaceChanged
[];
665 extern const char WMNWorkspaceNameChanged
[];
667 extern const char WMNResetStacking
[];