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
  91 /* shutdown modes */
  92 typedef enum {
  93     WSExitMode,
  94     WSLogoutMode,
  95     WSKillMode,
  96     WSRestartPreparationMode
  97 } WShutdownMode;
  98
  99
 100 /* internal buttons */
 101 #define WBUT_CLOSE              0
 102 #define WBUT_BROKENCLOSE        1
 103 #define WBUT_ICONIFY            2
 104 #define WBUT_KILL               3
 105 #ifdef XKB_BUTTON_HINT
 106 #define WBUT_XKBGROUP1          4
 107 #define WBUT_XKBGROUP2          5
 108 #define WBUT_XKBGROUP3          6
 109 #define WBUT_XKBGROUP4          7
 110 #define PRED_BPIXMAPS           8 /* reserved for 4 groups */
 111 #else
 112 #define PRED_BPIXMAPS           4 /* count of WBUT icons */
 113 #endif /* XKB_BUTTON_HINT */
 114
 115 /* cursors */
 116 #define WCUR_DEFAULT            0
 117 #define WCUR_NORMAL             0
 118 #define WCUR_MOVE               1
 119 #define WCUR_RESIZE             2
 120 #define WCUR_TOPLEFTRESIZE      3
 121 #define WCUR_TOPRIGHTRESIZE     4
 122 #define WCUR_BOTTOMLEFTRESIZE   5
 123 #define WCUR_BOTTOMRIGHTRESIZE  6
 124 #define WCUR_VERTICALRESIZE     7
 125 #define WCUR_HORIZONRESIZE      8
 126 #define WCUR_WAIT               9
 127 #define WCUR_ARROW              10
 128 #define WCUR_QUESTION           11
 129 #define WCUR_TEXT               12
 130 #define WCUR_SELECT             13
 131 #define WCUR_ROOT               14
 132 #define WCUR_EMPTY              15
 133 #define WCUR_LAST               16
 134
 135 /* geometry displays */
 136 #define WDIS_NEW                0       /* new style */
 137 #define WDIS_CENTER             1       /* center of screen */
 138 #define WDIS_TOPLEFT            2       /* top left corner of screen */
 139 #define WDIS_FRAME_CENTER       3       /* center of the frame */
 140 #define WDIS_NONE               4
 141
 142 /* keyboard input focus mode */
 143 #define WKF_CLICK       0
 144 #define WKF_SLOPPY      2
 145
 146 /* colormap change mode */
 147 #define WCM_CLICK       0
 148 #define WCM_POINTER     1
 149
 150 /* window placement mode */
 151 #define WPM_MANUAL      0
 152 #define WPM_CASCADE     1
 153 #define WPM_SMART       2
 154 #define WPM_RANDOM      3
 155 #define WPM_AUTO        4
 156 #define WPM_CENTER      5
 157
 158 /* text justification */
 159 #define WTJ_CENTER      0
 160 #define WTJ_LEFT        1
 161 #define WTJ_RIGHT       2
 162
 163 /* iconification styles */
 164 #define WIS_ZOOM        0
 165 #define WIS_TWIST       1
 166 #define WIS_FLIP        2
 167 #define WIS_NONE        3
 168 #define WIS_RANDOM      4 /* secret */
 169
 170 /* switchmenu actions */
 171 #define ACTION_ADD              0
 172 #define ACTION_REMOVE           1
 173 #define ACTION_CHANGE           2
 174 #define ACTION_CHANGE_WORKSPACE 3
 175 #define ACTION_CHANGE_STATE     4
 176
 177
 178 /* speeds */
 179 #define SPEED_ULTRAFAST 0
 180 #define SPEED_FAST      1
 181 #define SPEED_MEDIUM    2
 182 #define SPEED_SLOW      3
 183 #define SPEED_ULTRASLOW 4
 184
 185
 186 /* window states */
 187 #define WS_FOCUSED      0
 188 #define WS_UNFOCUSED    1
 189 #define WS_PFOCUSED     2
 190
 191 /* clip title colors */
 192 #define CLIP_NORMAL     0
 193 #define CLIP_COLLAPSED  1
 194
 195
 196 /* icon yard position */
 197 #define IY_VERT         1
 198 #define IY_HORIZ        0
 199 #define IY_TOP          2
 200 #define IY_BOTTOM       0
 201 #define IY_RIGHT        4
 202 #define IY_LEFT         0
 203
 204
 205 /* menu styles */
 206 #define MS_NORMAL               0
 207 #define MS_SINGLE_TEXTURE       1
 208 #define MS_FLAT                 2
 209
 210 /* workspace actions */
 211 #define WA_NONE                 0
 212 #define WA_SELECT_WINDOWS       1
 213 #define WA_OPEN_APPMENU         2
 214 #define WA_OPEN_WINLISTMENU     3
 215 #define WA_SWITCH_WORKSPACES    4
 216
 217 /* workspace display position */
 218 #define WD_NONE         0
 219 #define WD_CENTER       1
 220 #define WD_TOP          2
 221 #define WD_BOTTOM       3
 222 #define WD_TOPLEFT      4
 223 #define WD_TOPRIGHT     5
 224 #define WD_BOTTOMLEFT   6
 225 #define WD_BOTTOMRIGHT  7
 226
 227 /* titlebar style */
 228 #define TS_NEW          0
 229 #define TS_OLD          1
 230 #define TS_NEXT         2
 231
 232 /* workspace border position */
 233 #define WB_NONE         0
 234 #define WB_LEFTRIGHT    1
 235 #define WB_TOPBOTTOM    2
 236 #define WB_ALLDIRS      (WB_LEFTRIGHT|WB_TOPBOTTOM)
 237
 238
 239 /* program states */
 240 #define WSTATE_NORMAL           0
 241 #define WSTATE_NEED_EXIT        1
 242 #define WSTATE_NEED_RESTART     2
 243 #define WSTATE_EXITING          3
 244 #define WSTATE_RESTARTING       4
 245 #define WSTATE_MODAL            5
 246 #define WSTATE_NEED_REREAD      6
 247
 248
 249 #define WCHECK_STATE(state)     (state == WProgramState)
 250
 251
 252 #define WCHANGE_STATE(nstate) {\
 253     if (WProgramState == WSTATE_NORMAL\
 254         || nstate != WSTATE_MODAL)\
 255         WProgramState = (nstate); \
 256     if (WProgramSigState != 0)\
 257         WProgramState = WProgramSigState;\
 258 }
 259
 260
 261 /* only call inside signal handlers, with signals blocked */
 262 #define SIG_WCHANGE_STATE(nstate) {\
 263     WProgramSigState = (nstate);\
 264     WProgramState = (nstate);\
 265 }
 266
 267
 268 /* Flags for the Window Maker state when restarting/crash situations */
 269 #define WFLAGS_NONE       (0)
 270 #define WFLAGS_CRASHED    (1<<0)
 271
 272
 273 /* notifications */
 274
 275 #ifdef MAINFILE
 276 #define NOTIFICATION(n) char *WN##n = #n
 277 #else
 278 #define NOTIFICATION(n) extern char *WN##n
 279 #endif
 280
 281 NOTIFICATION(WindowAppearanceSettingsChanged);
 282
 283 NOTIFICATION(IconAppearanceSettingsChanged);
 284
 285 NOTIFICATION(IconTileSettingsChanged);
 286
 287 NOTIFICATION(MenuAppearanceSettingsChanged);
 288
 289 NOTIFICATION(MenuTitleAppearanceSettingsChanged);
 290
 291
 292 /* appearance settings clientdata flags */
 293 enum {
 294     WFontSettings = 1 << 0,
 295     WTextureSettings = 1 << 1,
 296     WColorSettings = 1 << 2
 297 };
 298
 299
 300
 301 typedef struct {
 302     int x1, y1;
 303     int x2, y2;
 304 } WArea;
 305
 306 typedef struct WCoord {
 307     int x, y;
 308 } WCoord;
 309
 310 typedef 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 */
 322
 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 */
 334
 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
 350     char modelock;
 351 #endif
 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 */
 355
 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 */
 363
 364     WCoord *root_menu_pos;             /* initial position of the root menu*/
 365     WCoord *app_menu_pos;
 366     WCoord *win_menu_pos;
 367
 368     signed char icon_yard;             /* aka iconbox */
 369
 370     int raise_delay;                   /* delay for autoraise. 0 is disabled */
 371     int cmap_size;                     /* size of dithering colormap in colors per channel */
 372
 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 */
 378
 379
 380     char ws_advance;                   /* Create new workspace and advance */
 381     char ws_cycle;                     /* Cycle existing workspaces */
 382     char save_session_on_exit;         /* automatically save session on exit */
 383     char sticky_icons;                 /* If miniwindows will be onmipresent */
 384     char dont_confirm_kill;            /* do not confirm Kill application */
 385     char disable_miniwindows;
 386     char dont_blink;                   /* do not blink icon selection */
 387
 388     /* Appearance options */
 389     char new_style;                    /* Use newstyle buttons */
 390     char superfluous;                  /* Use superfluous things */
 391
 392     /* root window mouse bindings */
 393     signed char mouse_button1;         /* action for left mouse button */
 394     signed char mouse_button2;         /* action for middle mouse button */
 395     signed char mouse_button3;         /* action for right mouse button */
 396     signed char mouse_wheel;           /* action for mouse wheel */
 397
 398     /* balloon text */
 399     char window_balloon;
 400     char miniwin_balloon;
 401     char appicon_balloon;
 402     char help_balloon;
 403
 404     /* some constants */
 405     int dblclick_time;                 /* double click delay time in ms */
 406
 407     /* animate menus */
 408     signed char menu_scroll_speed;             /* how fast menus are scrolled */
 409
 410     /* animate icon sliding */
 411     signed char icon_slide_speed;              /* icon slide animation speed */
 412
 413     /* shading animation */
 414     signed char shade_speed;
 415
 416     /* bouncing animation */
 417     char bounce_appicons_when_urgent;
 418     char raise_appicons_when_bouncing;
 419     char do_not_make_appicons_bounce;
 420
 421     int edge_resistance;
 422     int resize_increment;
 423     char attract;
 424
 425     unsigned int workspace_border_size; /* Size in pixels of the workspace border */
 426     char workspace_border_position;     /* Where to leave a workspace border */
 427     char single_click;                  /* single click to lauch applications */
 428     int history_lines;                  /* history of "Run..." dialog */
 429     char cycle_active_head_only;        /* Cycle only windows on the active head */
 430
 431     RImage *swtileImage;
 432     RImage *swbackImage[9];
 433
 434     int show_clip_title;
 435
 436     struct {
 437         unsigned int nodock:1;         /* don't display the dock */
 438         unsigned int noclip:1;         /* don't display the clip */
 439         unsigned int noupdates:1;      /* don't require ~/GNUstep (-static) */
 440         unsigned int noautolaunch:1;   /* don't autolaunch apps */
 441         unsigned int norestore:1;      /* don't restore session */
 442         unsigned int create_stdcmap:1; /* create std colormap */
 443 #ifndef HAVE_INOTIFY
 444         unsigned int nopolling:1;      /* don't poll the defaults database for changes */
 445 #endif
 446         unsigned int restarting:2;
 447     } flags;                           /* internal flags */
 448 } WPreferences;
 449
 450 /****** Global Variables  ******/
 451 extern Display  *dpy;
 452 extern unsigned int ValidModMask;
 453 extern char WProgramState;
 454 extern char WProgramSigState;
 455
 456 /****** Notifications ******/
 457 extern const char *WMNManaged;
 458 extern const char *WMNUnmanaged;
 459 extern const char *WMNChangedWorkspace;
 460 extern const char *WMNChangedState;
 461 extern const char *WMNChangedFocus;
 462 extern const char *WMNChangedStacking;
 463 extern const char *WMNChangedName;
 464
 465 extern const char *WMNWorkspaceCreated;
 466 extern const char *WMNWorkspaceDestroyed;
 467 extern const char *WMNWorkspaceChanged;
 468 extern const char *WMNWorkspaceNameChanged;
 469
 470 extern const char *WMNResetStacking;
 471 #endif