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_
27 #include <WINGs/WINGs.h>
33 WCLASS_WINDOW
= 1, /* managed client windows */
34 WCLASS_MENU
= 2, /* root menus */
36 WCLASS_DUMMYWINDOW
= 4, /* window that holds window group leader */
37 WCLASS_MINIWINDOW
= 5,
40 WCLASS_TEXT_INPUT
= 8,
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,
52 WMBackLevel
= INT_MIN
+1, /* Very lowest level */
53 WMDesktopLevel
= -1000, /* Lowest level of normal use */
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 */
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) */
89 /* internal buttons */
91 #define WBUT_BROKENCLOSE 1
92 #define WBUT_ICONIFY 2
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 */
101 #define PRED_BPIXMAPS 4 /* count of WBUT icons */
102 #endif /* XKB_BUTTON_HINT */
111 WCUR_BOTTOMLEFTRESIZE
,
112 WCUR_BOTTOMRIGHTRESIZE
,
123 /* Count of the number of cursors defined */
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 */
134 /* keyboard input focus mode */
138 /* colormap change mode */
140 #define WCM_POINTER 1
142 /* window placement mode */
144 #define WPM_CASCADE 1
150 /* text justification */
155 /* iconification styles */
160 #define WIS_RANDOM 4 /* secret */
162 /* switchmenu actions */
164 #define ACTION_REMOVE 1
165 #define ACTION_CHANGE 2
166 #define ACTION_CHANGE_WORKSPACE 3
167 #define ACTION_CHANGE_STATE 4
171 #define SPEED_ULTRAFAST 0
173 #define SPEED_MEDIUM 2
175 #define SPEED_ULTRASLOW 4
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 */
199 #define MS_SINGLE_TEXTURE 1
202 /* workspace actions */
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 */
215 #define WD_TOPRIGHT 5
216 #define WD_BOTTOMLEFT 6
217 #define WD_BOTTOMRIGHT 7
224 /* workspace border position */
226 #define WB_LEFTRIGHT 1
227 #define WB_TOPBOTTOM 2
228 #define WB_ALLDIRS (WB_LEFTRIGHT|WB_TOPBOTTOM)
234 WSTATE_NEED_EXIT
= 1,
235 WSTATE_NEED_RESTART
= 2,
237 WSTATE_RESTARTING
= 4,
239 WSTATE_NEED_REREAD
= 6
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)
270 #define NOTIFICATION(n) const char WN##n [] = #n
272 #define NOTIFICATION(n) extern const char WN##n []
275 NOTIFICATION(WindowAppearanceSettingsChanged
);
277 NOTIFICATION(IconAppearanceSettingsChanged
);
279 NOTIFICATION(IconTileSettingsChanged
);
281 NOTIFICATION(MenuAppearanceSettingsChanged
);
283 NOTIFICATION(MenuTitleAppearanceSettingsChanged
);
286 /* appearance settings clientdata flags */
288 WFontSettings
= 1 << 0,
289 WTextureSettings
= 1 << 1,
290 WColorSettings
= 1 << 2
300 typedef struct 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
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 */
395 char miniwin_balloon
;
396 char appicon_balloon
;
400 int dblclick_time
; /* double click delay time in ms */
403 signed char menu_scroll_speed
; /* how fast menus are scrolled */
405 /* animate icon sliding */
406 signed char icon_slide_speed
; /* icon slide animation speed */
408 /* shading animation */
409 signed char shade_speed
;
411 /* bouncing animation */
412 char bounce_appicons_when_urgent
;
413 char raise_appicons_when_bouncing
;
414 char do_not_make_appicons_bounce
;
417 int resize_increment
;
420 unsigned int workspace_border_size
; /* Size in pixels of the workspace border */
421 char workspace_border_position
; /* Where to leave a workspace border */
422 char single_click
; /* single click to lauch applications */
423 int history_lines
; /* history of "Run..." dialog */
424 char cycle_active_head_only
; /* Cycle only windows on the active head */
425 char cycle_ignore_minimized
; /* Ignore minimized windows when cycling */
426 char strict_windoze_cycle
; /* don't close switchpanel when shift is released */
427 char panel_only_open
; /* Only open the switchpanel; don't switch */
429 /* All delays here are in ms. 0 means instant auto-action. */
430 int clip_auto_raise_delay
; /* Delay after which the clip will be raised when entered */
431 int clip_auto_lower_delay
; /* Delay after which the clip will be lowered when leaved */
432 int clip_auto_expand_delay
; /* Delay after which the clip will expand when entered */
433 int clip_auto_collapse_delay
; /* Delay after which the clip will collapse when leaved */
436 RImage
*swbackImage
[9];
441 unsigned int nodock
:1; /* don't display the dock */
442 unsigned int noclip
:1; /* don't display the clip */
443 unsigned int clip_merged_in_dock
:1; /* disable clip, dock gets its workspace switching functionality */
444 unsigned int nodrawer
:1; /* don't use drawers */
445 unsigned int wrap_appicons_in_dock
:1; /* Whether to wrap appicons when Dock is moved up and down */
446 unsigned int noupdates
:1; /* don't require ~/GNUstep (-static) */
447 unsigned int noautolaunch
:1; /* don't autolaunch apps */
448 unsigned int norestore
:1; /* don't restore session */
450 unsigned int nopolling
:1; /* don't poll the defaults database for changes */
452 unsigned int restarting
:2;
453 } flags
; /* internal flags */
455 /* Map table between w_cursor and actual X id */
456 Cursor cursor
[WCUR_LAST
];
460 /****** Global Variables ******/
463 extern struct wmaker_global_variables
{
464 /* Tracking of the state of the program */
467 wprog_state signal_state
;
470 /* locale to use. NULL==POSIX or C */
473 /* Tracking of X events timestamps */
475 /* ts of the last event we received */
478 /* ts on the last time we did XSetInputFocus() */
483 /* Global Domains, for storing dictionaries */
485 /* Note: you must #include <defaults.h> if you want to use them */
486 struct WDDomain
*wmaker
;
487 struct WDDomain
*window_attr
;
488 struct WDDomain
*root_menu
;
491 /* Screens related */
494 /* Workspace related */
496 struct WWorkspace
**array
; /* data for the workspaces */
498 int count
; /* number of workspaces */
499 int current
; /* current workspace number */
500 int last_used
; /* last used workspace number */
502 WMFont
*font_for_name
; /* used during workspace switch */
505 * Ignore Workspace Change:
506 * this variable is used to prevent workspace switch while certain
507 * operations are ongoing.
512 struct WMenu
*menu
; /* workspace operation */
513 struct WMenu
*submenu
; /* workspace list for window_menu */
518 struct WAppIcon
*icon
; /* The clip main icon, or the dock's, if they are merged */
520 struct WMenu
*menu
; /* Menu for clips */
521 struct WMenu
*submenu
; /* Workspace list for clips */
522 struct WMenu
*opt_menu
; /* Options for Clip */
523 struct WMenu
*ws_menu
; /* workspace menu for clip */
528 struct WMenu
*pos_menu
; /* menu for position of the dock */
529 struct WMenu
*drawer_menu
; /* menu for the drawers */
534 int fd_event_queue
; /* Inotify's queue file descriptor */
535 int wd_defaults
; /* Watch Descriptor for the 'Defaults' configuration file */
539 /* definition for X Atoms */
542 /* Window-Manager related */
551 Atom colormap_windows
;
552 Atom colormap_notify
;
553 Atom ignore_focus_events
;
556 /* GNUStep related */
559 Atom wm_miniaturize_window
;
564 /* WindowMaker specific */
596 #ifdef KEEP_XKB_LOCK_STATUS
611 * If no extension were activated, we would end up with an empty
612 * structure, which old compilers may not appreciate, so let's
613 * work around this with a simple:
618 /* Session related */
619 WMPropList
*session_state
;
621 /* Keyboard and shortcuts */
624 * Bit-mask to hide special key modifiers which we don't want to
625 * impact the shortcuts (typically: CapsLock, NumLock, ScrollLock)
627 unsigned int modifiers_mask
;
629 WMArray
*windows
[MAX_WINDOW_SHORTCUTS
];
632 /* Application related */
633 struct WAppIcon
*app_icon_list
; /* list of all aplication icons */
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
[];