src/WindowMaker.h

   1 /*
   2  *  Window Maker window manager
   3  *
   4  *  Copyright (c) 1997-2003 Alfredo K. Kojima
   5  *
   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.
  10  *
  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.
  15  *
  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.
  19  */
  20
  21 #ifndef WINDOWMAKER_H_
  22 #define WINDOWMAKER_H_
  23
  24 #include "wconfig.h"
  25 #include <assert.h>
  26 #include <limits.h>
  27 #include <WINGs/WINGs.h>
  28
  29
  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;
  43
  44
  45 /*
  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.
  50  */
  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     WMFullscreenLevel = 50,
  62     WMModalLevel = 100,
  63     WMPopUpLevel = 101,
  64     WMScreensaverLevel = 1000,
  65     WMOuterSpaceLevel = INT_MAX
  66 };
  67
  68 /*
  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)
  76  */
  77
  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);
  85
  86     WClassType parent_type;            /* type code of the parent */
  87     void *parent;                      /* parent object (WWindow or WMenu) */
  88 } WObjDescriptor;
  89
  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 */
 104
 105 /* cursors */
 106 #define WCUR_DEFAULT            0
 107 #define WCUR_NORMAL             0
 108 #define WCUR_MOVE               1
 109 #define WCUR_RESIZE             2
 110 #define WCUR_TOPLEFTRESIZE      3
 111 #define WCUR_TOPRIGHTRESIZE     4
 112 #define WCUR_BOTTOMLEFTRESIZE   5
 113 #define WCUR_BOTTOMRIGHTRESIZE  6
 114 #define WCUR_VERTICALRESIZE     7
 115 #define WCUR_HORIZONRESIZE      8
 116 #define WCUR_WAIT               9
 117 #define WCUR_ARROW              10
 118 #define WCUR_QUESTION           11
 119 #define WCUR_TEXT               12
 120 #define WCUR_SELECT             13
 121 #define WCUR_ROOT               14
 122 #define WCUR_EMPTY              15
 123 #define WCUR_LAST               16
 124
 125 /* geometry displays */
 126 #define WDIS_NEW                0       /* new style */
 127 #define WDIS_CENTER             1       /* center of screen */
 128 #define WDIS_TOPLEFT            2       /* top left corner of screen */
 129 #define WDIS_FRAME_CENTER       3       /* center of the frame */
 130 #define WDIS_NONE               4
 131
 132 /* keyboard input focus mode */
 133 #define WKF_CLICK       0
 134 #define WKF_SLOPPY      2
 135
 136 /* colormap change mode */
 137 #define WCM_CLICK       0
 138 #define WCM_POINTER     1
 139
 140 /* window placement mode */
 141 #define WPM_MANUAL      0
 142 #define WPM_CASCADE     1
 143 #define WPM_SMART       2
 144 #define WPM_RANDOM      3
 145 #define WPM_AUTO        4
 146 #define WPM_CENTER      5
 147
 148 /* text justification */
 149 #define WTJ_CENTER      0
 150 #define WTJ_LEFT        1
 151 #define WTJ_RIGHT       2
 152
 153 /* iconification styles */
 154 #define WIS_ZOOM        0
 155 #define WIS_TWIST       1
 156 #define WIS_FLIP        2
 157 #define WIS_NONE        3
 158 #define WIS_RANDOM      4 /* secret */
 159
 160 /* switchmenu actions */
 161 #define ACTION_ADD              0
 162 #define ACTION_REMOVE           1
 163 #define ACTION_CHANGE           2
 164 #define ACTION_CHANGE_WORKSPACE 3
 165 #define ACTION_CHANGE_STATE     4
 166
 167
 168 /* speeds */
 169 #define SPEED_ULTRAFAST 0
 170 #define SPEED_FAST      1
 171 #define SPEED_MEDIUM    2
 172 #define SPEED_SLOW      3
 173 #define SPEED_ULTRASLOW 4
 174
 175
 176 /* window states */
 177 #define WS_FOCUSED      0
 178 #define WS_UNFOCUSED    1
 179 #define WS_PFOCUSED     2
 180
 181 /* clip title colors */
 182 #define CLIP_NORMAL     0
 183 #define CLIP_COLLAPSED  1
 184
 185
 186 /* icon yard position */
 187 #define IY_VERT         1
 188 #define IY_HORIZ        0
 189 #define IY_TOP          2
 190 #define IY_BOTTOM       0
 191 #define IY_RIGHT        4
 192 #define IY_LEFT         0
 193
 194
 195 /* menu styles */
 196 #define MS_NORMAL               0
 197 #define MS_SINGLE_TEXTURE       1
 198 #define MS_FLAT                 2
 199
 200 /* workspace actions */
 201 #define WA_NONE                 0
 202 #define WA_SELECT_WINDOWS       1
 203 #define WA_OPEN_APPMENU         2
 204 #define WA_OPEN_WINLISTMENU     3
 205 #define WA_SWITCH_WORKSPACES    4
 206
 207 /* workspace display position */
 208 #define WD_NONE         0
 209 #define WD_CENTER       1
 210 #define WD_TOP          2
 211 #define WD_BOTTOM       3
 212 #define WD_TOPLEFT      4
 213 #define WD_TOPRIGHT     5
 214 #define WD_BOTTOMLEFT   6
 215 #define WD_BOTTOMRIGHT  7
 216
 217 /* titlebar style */
 218 #define TS_NEW          0
 219 #define TS_OLD          1
 220 #define TS_NEXT         2
 221
 222 /* workspace border position */
 223 #define WB_NONE         0
 224 #define WB_LEFTRIGHT    1
 225 #define WB_TOPBOTTOM    2
 226 #define WB_ALLDIRS      (WB_LEFTRIGHT|WB_TOPBOTTOM)
 227
 228
 229 /* program states */
 230 #define WSTATE_NORMAL           0
 231 #define WSTATE_NEED_EXIT        1
 232 #define WSTATE_NEED_RESTART     2
 233 #define WSTATE_EXITING          3
 234 #define WSTATE_RESTARTING       4
 235 #define WSTATE_MODAL            5
 236 #define WSTATE_NEED_REREAD      6
 237
 238
 239 #define WCHECK_STATE(state)     (state == WProgramState)
 240
 241
 242 #define WCHANGE_STATE(nstate) {\
 243     if (WProgramState == WSTATE_NORMAL\
 244         || nstate != WSTATE_MODAL)\
 245         WProgramState = (nstate); \
 246     if (WProgramSigState != 0)\
 247         WProgramState = WProgramSigState;\
 248 }
 249
 250
 251 /* only call inside signal handlers, with signals blocked */
 252 #define SIG_WCHANGE_STATE(nstate) {\
 253     WProgramSigState = (nstate);\
 254     WProgramState = (nstate);\
 255 }
 256
 257
 258 /* Flags for the Window Maker state when restarting/crash situations */
 259 #define WFLAGS_NONE       (0)
 260 #define WFLAGS_CRASHED    (1<<0)
 261
 262
 263 /* notifications */
 264
 265 #ifdef MAINFILE
 266 #define NOTIFICATION(n) const char WN##n [] = #n
 267 #else
 268 #define NOTIFICATION(n) extern const char WN##n []
 269 #endif
 270
 271 NOTIFICATION(WindowAppearanceSettingsChanged);
 272
 273 NOTIFICATION(IconAppearanceSettingsChanged);
 274
 275 NOTIFICATION(IconTileSettingsChanged);
 276
 277 NOTIFICATION(MenuAppearanceSettingsChanged);
 278
 279 NOTIFICATION(MenuTitleAppearanceSettingsChanged);
 280
 281
 282 /* appearance settings clientdata flags */
 283 enum {
 284     WFontSettings = 1 << 0,
 285     WTextureSettings = 1 << 1,
 286     WColorSettings = 1 << 2
 287 };
 288
 289
 290
 291 typedef struct {
 292     int x1, y1;
 293     int x2, y2;
 294 } WArea;
 295
 296 typedef struct WCoord {
 297     int x, y;
 298 } WCoord;
 299
 300 typedef struct WPreferences {
 301     char *pixmap_path;                 /* : separated list of paths to find pixmaps */
 302     char *icon_path;                   /* : separated list of paths to find icons */
 303     WMArray *fallbackWMs;              /* fallback window manager list */
 304     char *logger_shell;                /* shell to log child stdi/o */
 305     RImage *button_images;             /* titlebar button images */
 306     char smooth_workspace_back;
 307     signed char size_display;          /* display type for resize geometry */
 308     signed char move_display;          /* display type for move geometry */
 309     signed char window_placement;      /* window placement mode */
 310     signed char colormap_mode;         /* colormap focus mode */
 311     signed char focus_mode;            /* window focusing mode */
 312
 313     char opaque_move;                  /* update window position during move */
 314     char opaque_resize;                /* update window position during resize */
 315     char opaque_move_resize_keyboard; /* update window position during move,resize with keyboard */
 316     char wrap_menus;                   /* wrap menus at edge of screen */
 317     char scrollable_menus;             /* let them be scrolled */
 318     char vi_key_menus;                 /* use h/j/k/l to select */
 319     char align_menus;                  /* align menu with their parents */
 320     char use_saveunders;               /* turn on SaveUnders for menus, icons etc. */
 321     char no_window_over_dock;
 322     char no_window_over_icons;
 323     WCoord window_place_origin;        /* Offset for windows placed on screen */
 324
 325     char constrain_window_size;        /* don't let windows get bigger than screen */
 326     char windows_cycling;              /* windoze cycling */
 327     char circ_raise;                   /* raise window after Alt-tabbing */
 328     char ignore_focus_click;
 329     char open_transients_with_parent;  /* open transient window in same workspace as parent */
 330     signed char title_justification;   /* titlebar text alignment */
 331     int window_title_clearance;
 332     int window_title_min_height;
 333     int window_title_max_height;
 334     int menu_title_clearance;
 335     int menu_title_min_height;
 336     int menu_title_max_height;
 337     int menu_text_clearance;
 338     char multi_byte_text;
 339 #ifdef KEEP_XKB_LOCK_STATUS
 340     char modelock;
 341 #endif
 342     char no_dithering;                 /* use dithering or not */
 343     char no_animations;                /* enable/disable animations */
 344     char no_autowrap;                  /* wrap workspace when window is moved to the edge */
 345
 346     char highlight_active_app;         /* show the focused app by highlighting its icon */
 347     char auto_arrange_icons;           /* automagically arrange icons */
 348     char icon_box_position;            /* position to place icons */
 349     signed char iconification_style;   /* position to place icons */
 350     char disable_root_mouse;           /* disable button events in root window */
 351     char auto_focus;                   /* focus window when it's mapped */
 352     char *icon_back_file;              /* background image for icons */
 353
 354     WCoord *root_menu_pos;             /* initial position of the root menu*/
 355     WCoord *app_menu_pos;
 356     WCoord *win_menu_pos;
 357
 358     signed char icon_yard;             /* aka iconbox */
 359
 360     int raise_delay;                   /* delay for autoraise. 0 is disabled */
 361     int cmap_size;                     /* size of dithering colormap in colors per channel */
 362
 363     int icon_size;                     /* size of the icon */
 364     signed char menu_style;            /* menu decoration style */
 365     signed char workspace_name_display_position;
 366     unsigned int modifier_mask;        /* mask to use as kbd modifier */
 367     char *modifier_labels[7];          /* Names of the modifiers */
 368
 369
 370     char ws_advance;                   /* Create new workspace and advance */
 371     char ws_cycle;                     /* Cycle existing workspaces */
 372     char save_session_on_exit;         /* automatically save session on exit */
 373     char sticky_icons;                 /* If miniwindows will be onmipresent */
 374     char dont_confirm_kill;            /* do not confirm Kill application */
 375     char disable_miniwindows;
 376     char dont_blink;                   /* do not blink icon selection */
 377
 378     /* Appearance options */
 379     char new_style;                    /* Use newstyle buttons */
 380     char superfluous;                  /* Use superfluous things */
 381
 382     /* root window mouse bindings */
 383     signed char mouse_button1;         /* action for left mouse button */
 384     signed char mouse_button2;         /* action for middle mouse button */
 385     signed char mouse_button3;         /* action for right mouse button */
 386     signed char mouse_wheel;           /* action for mouse wheel */
 387
 388     /* balloon text */
 389     char window_balloon;
 390     char miniwin_balloon;
 391     char appicon_balloon;
 392     char help_balloon;
 393
 394     /* some constants */
 395     int dblclick_time;                 /* double click delay time in ms */
 396
 397     /* animate menus */
 398     signed char menu_scroll_speed;             /* how fast menus are scrolled */
 399
 400     /* animate icon sliding */
 401     signed char icon_slide_speed;              /* icon slide animation speed */
 402
 403     /* shading animation */
 404     signed char shade_speed;
 405
 406     /* bouncing animation */
 407     char bounce_appicons_when_urgent;
 408     char raise_appicons_when_bouncing;
 409     char do_not_make_appicons_bounce;
 410
 411     int edge_resistance;
 412     int resize_increment;
 413     char attract;
 414
 415     unsigned int workspace_border_size; /* Size in pixels of the workspace border */
 416     char workspace_border_position;     /* Where to leave a workspace border */
 417     char single_click;                  /* single click to lauch applications */
 418     int history_lines;                  /* history of "Run..." dialog */
 419     char cycle_active_head_only;        /* Cycle only windows on the active head */
 420     char cycle_ignore_minimized;        /* Ignore minimized windows when cycling */
 421     char strict_windoze_cycle;          /* don't close switchpanel when shift is released */
 422     char panel_only_open;               /* Only open the switchpanel; don't switch */
 423
 424     /* All delays here are in ms. 0 means instant auto-action. */
 425     int clip_auto_raise_delay;         /* Delay after which the clip will be raised when entered */
 426     int clip_auto_lower_delay;         /* Delay after which the clip will be lowered when leaved */
 427     int clip_auto_expand_delay;        /* Delay after which the clip will expand when entered */
 428     int clip_auto_collapse_delay;      /* Delay after which the clip will collapse when leaved */
 429
 430     RImage *swtileImage;
 431     RImage *swbackImage[9];
 432
 433     int show_clip_title;
 434
 435     struct {
 436         unsigned int nodock:1;         /* don't display the dock */
 437         unsigned int noclip:1;         /* don't display the clip */
 438         unsigned int clip_merged_in_dock:1; /* disable clip, dock gets its workspace switching functionality */
 439         unsigned int nodrawer:1;       /* don't use drawers */
 440         unsigned int wrap_appicons_in_dock:1; /* Whether to wrap appicons when Dock is moved up and down */
 441         unsigned int noupdates:1;      /* don't require ~/GNUstep (-static) */
 442         unsigned int noautolaunch:1;   /* don't autolaunch apps */
 443         unsigned int norestore:1;      /* don't restore session */
 444 #ifndef HAVE_INOTIFY
 445         unsigned int nopolling:1;      /* don't poll the defaults database for changes */
 446 #endif
 447         unsigned int restarting:2;
 448     } flags;                           /* internal flags */
 449 } WPreferences;
 450
 451 /****** Global Variables  ******/
 452 extern Display  *dpy;
 453 extern unsigned int ValidModMask;
 454 extern char WProgramState;
 455 extern char WProgramSigState;
 456
 457 /****** Notifications ******/
 458 extern const char *WMNManaged;
 459 extern const char *WMNUnmanaged;
 460 extern const char *WMNChangedWorkspace;
 461 extern const char *WMNChangedState;
 462 extern const char *WMNChangedFocus;
 463 extern const char *WMNChangedStacking;
 464 extern const char *WMNChangedName;
 465
 466 extern const char *WMNWorkspaceCreated;
 467 extern const char *WMNWorkspaceDestroyed;
 468 extern const char *WMNWorkspaceChanged;
 469 extern const char *WMNWorkspaceNameChanged;
 470
 471 extern const char *WMNResetStacking;
 472 #endif