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
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  19  *  USA.
  20  */
  21
  22 #ifndef WINDOWMAKER_H_
  23 #define WINDOWMAKER_H_
  24
  25 #include "wconfig.h"
  26 #include <assert.h>
  27 #include <limits.h>
  28 #include <WINGs/WINGs.h>
  29
  30
  31 /* class codes */
  32 typedef enum {
  33     WCLASS_UNKNOWN = 0,
  34     WCLASS_WINDOW = 1,          /* managed client windows */
  35     WCLASS_MENU = 2,            /* root menus */
  36     WCLASS_APPICON = 3,
  37     WCLASS_DUMMYWINDOW = 4,     /* window that holds window group leader */
  38     WCLASS_MINIWINDOW = 5,
  39     WCLASS_DOCK_ICON = 6,
  40     WCLASS_PAGER = 7,
  41     WCLASS_TEXT_INPUT = 8,
  42     WCLASS_FRAME = 9
  43 } WClassType;
  44
  45
  46 /*
  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,
  50  * but discouraged.
  51  */
  52 enum {
  53     WMBackLevel = INT_MIN+1,    /* Very lowest level */
  54     WMDesktopLevel = -1000,             /* Lowest level of normal use */
  55     WMSunkenLevel = -1,
  56     WMNormalLevel = 0,
  57     WMFloatingLevel = 3,
  58     WMDockLevel = 5,
  59     WMSubmenuLevel = 15,
  60     WMMainMenuLevel = 20,
  61     WMStatusLevel = 21,
  62     WMFullscreenLevel = 50,
  63     WMModalLevel = 100,
  64     WMPopUpLevel = 101,
  65     WMScreensaverLevel = 1000,
  66     WMOuterSpaceLevel = INT_MAX
  67 };
  68
  69 /*
  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)
  77  */
  78
  79 typedef struct WObjDescriptor {
  80     void *self;                        /* the object that will be called */
  81     /* event handlers */
  82     void (*handle_expose)(struct WObjDescriptor *sender, XEvent *event);
  83
  84     void (*handle_mousedown)(struct WObjDescriptor *sender, XEvent *event);
  85
  86     void (*handle_anything)(struct WObjDescriptor *sender, XEvent *event);
  87
  88     void (*handle_enternotify)(struct WObjDescriptor *sender, XEvent *event);
  89     void (*handle_leavenotify)(struct WObjDescriptor *sender, XEvent *event);
  90
  91     WClassType parent_type;            /* type code of the parent */
  92     void *parent;                      /* parent object (WWindow or WMenu) */
  93 } WObjDescriptor;
  94
  95
  96 /* shutdown modes */
  97 typedef enum {
  98     WSExitMode,
  99     WSLogoutMode,
 100     WSKillMode,
 101     WSRestartPreparationMode
 102 } WShutdownMode;
 103
 104
 105 /* internal buttons */
 106 #define WBUT_CLOSE              0
 107 #define WBUT_BROKENCLOSE        1
 108 #define WBUT_ICONIFY            2
 109 #define WBUT_KILL               3
 110 #ifdef XKB_BUTTON_HINT
 111 #define WBUT_XKBGROUP1          4
 112 #define WBUT_XKBGROUP2          5
 113 #define WBUT_XKBGROUP3          6
 114 #define WBUT_XKBGROUP4          7
 115 #define PRED_BPIXMAPS           8 /* reserved for 4 groups */
 116 #else
 117 #define PRED_BPIXMAPS           4 /* count of WBUT icons */
 118 #endif /* XKB_BUTTON_HINT */
 119
 120 /* cursors */
 121 #define WCUR_DEFAULT            0
 122 #define WCUR_NORMAL             0
 123 #define WCUR_MOVE               1
 124 #define WCUR_RESIZE             2
 125 #define WCUR_TOPLEFTRESIZE      3
 126 #define WCUR_TOPRIGHTRESIZE     4
 127 #define WCUR_BOTTOMLEFTRESIZE   5
 128 #define WCUR_BOTTOMRIGHTRESIZE  6
 129 #define WCUR_VERTICALRESIZE     7
 130 #define WCUR_HORIZONRESIZE      8
 131 #define WCUR_WAIT               9
 132 #define WCUR_ARROW              10
 133 #define WCUR_QUESTION           11
 134 #define WCUR_TEXT               12
 135 #define WCUR_SELECT             13
 136 #define WCUR_ROOT               14
 137 #define WCUR_EMPTY              15
 138 #define WCUR_LAST               16
 139
 140 /* geometry displays */
 141 #define WDIS_NEW                0       /* new style */
 142 #define WDIS_CENTER             1       /* center of screen */
 143 #define WDIS_TOPLEFT            2       /* top left corner of screen */
 144 #define WDIS_FRAME_CENTER       3       /* center of the frame */
 145 #define WDIS_NONE               4
 146
 147 /* keyboard input focus mode */
 148 #define WKF_CLICK       0
 149 #define WKF_SLOPPY      2
 150
 151 /* colormap change mode */
 152 #define WCM_CLICK       0
 153 #define WCM_POINTER     1
 154
 155 /* window placement mode */
 156 #define WPM_MANUAL      0
 157 #define WPM_CASCADE     1
 158 #define WPM_SMART       2
 159 #define WPM_RANDOM      3
 160 #define WPM_AUTO        4
 161
 162 /* text justification */
 163 #define WTJ_CENTER      0
 164 #define WTJ_LEFT        1
 165 #define WTJ_RIGHT       2
 166
 167 /* iconification styles */
 168 #define WIS_ZOOM        0
 169 #define WIS_TWIST       1
 170 #define WIS_FLIP        2
 171 #define WIS_NONE        3
 172 #define WIS_RANDOM      4 /* secret */
 173
 174 /* switchmenu actions */
 175 #define ACTION_ADD              0
 176 #define ACTION_REMOVE           1
 177 #define ACTION_CHANGE           2
 178 #define ACTION_CHANGE_WORKSPACE 3
 179 #define ACTION_CHANGE_STATE     4
 180
 181
 182 /* speeds */
 183 #define SPEED_ULTRAFAST 0
 184 #define SPEED_FAST      1
 185 #define SPEED_MEDIUM    2
 186 #define SPEED_SLOW      3
 187 #define SPEED_ULTRASLOW 4
 188
 189
 190 /* window states */
 191 #define WS_FOCUSED      0
 192 #define WS_UNFOCUSED    1
 193 #define WS_PFOCUSED     2
 194
 195 /* clip title colors */
 196 #define CLIP_NORMAL     0
 197 #define CLIP_COLLAPSED  1
 198
 199
 200 /* icon yard position */
 201 #define IY_VERT         1
 202 #define IY_HORIZ        0
 203 #define IY_TOP          2
 204 #define IY_BOTTOM       0
 205 #define IY_RIGHT        4
 206 #define IY_LEFT         0
 207
 208
 209 /* menu styles */
 210 #define MS_NORMAL               0
 211 #define MS_SINGLE_TEXTURE       1
 212 #define MS_FLAT                 2
 213
 214 /* workspace actions */
 215 #define WA_NONE                 0
 216 #define WA_SELECT_WINDOWS       1
 217 #define WA_OPEN_APPMENU         2
 218 #define WA_OPEN_WINLISTMENU     3
 219 #define WA_SWITCH_WORKSPACES    4
 220
 221 /* workspace display position */
 222 #define WD_NONE         0
 223 #define WD_CENTER       1
 224 #define WD_TOP          2
 225 #define WD_BOTTOM       3
 226 #define WD_TOPLEFT      4
 227 #define WD_TOPRIGHT     5
 228 #define WD_BOTTOMLEFT   6
 229 #define WD_BOTTOMRIGHT  7
 230
 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 wrap_menus;                   /* wrap menus at edge of screen */
 325     char scrollable_menus;             /* let them be scrolled */
 326     char align_menus;                  /* align menu with their parents */
 327     char use_saveunders;               /* turn on SaveUnders for menus, icons etc. */
 328     char no_window_over_dock;
 329     char no_window_over_icons;
 330     WCoord window_place_origin;        /* Offset for windows placed on screen */
 331
 332     char constrain_window_size;        /* don't let windows get bigger than screen */
 333     char windows_cycling;              /* windoze cycling */
 334     char circ_raise;                   /* raise window after Alt-tabbing */
 335     char ignore_focus_click;
 336     char open_transients_with_parent;  /* open transient window in same workspace as parent */
 337     signed char title_justification;   /* titlebar text alignment */
 338     int window_title_clearance;
 339     int menu_title_clearance;
 340     int menu_text_clearance;
 341     char multi_byte_text;
 342 #ifdef KEEP_XKB_LOCK_STATUS
 343     char modelock;
 344 #endif
 345     char no_dithering;                 /* use dithering or not */
 346     char no_animations;                /* enable/disable animations */
 347     char no_autowrap;                  /* wrap workspace when window is moved
 348     * to the edge */
 349
 350     char auto_arrange_icons;           /* automagically arrange icons */
 351     char icon_box_position;            /* position to place icons */
 352     signed char iconification_style;          /* position to place icons */
 353     char disable_root_mouse;           /* disable button events in root window */
 354     char auto_focus;                   /* focus window when it's mapped */
 355     char *icon_back_file;              /* background image for icons */
 356
 357     WCoord *root_menu_pos;             /* initial position of the root menu*/
 358     WCoord *app_menu_pos;
 359     WCoord *win_menu_pos;
 360
 361     signed char icon_yard;             /* aka iconbox */
 362
 363     int raise_delay;                   /* delay for autoraise. 0 is disabled */
 364     int cmap_size;                     /* size of dithering colormap in colors per channel */
 365
 366     int icon_size;                     /* size of the icon */
 367     signed char menu_style;            /* menu decoration style */
 368     signed char workspace_name_display_position;
 369     unsigned int modifier_mask;        /* mask to use as kbd modifier */
 370
 371
 372     char ws_advance;                   /* Create new workspace and advance */
 373     char ws_cycle;                     /* Cycle existing workspaces */
 374     char save_session_on_exit;         /* automatically save session on exit */
 375     char sticky_icons;                 /* If miniwindows will be onmipresent */
 376     char dont_confirm_kill;            /* do not confirm Kill application */
 377     char disable_miniwindows;
 378     char dont_blink;                   /* do not blink icon selection */
 379
 380     /* Appearance options */
 381     char new_style;                    /* Use newstyle buttons */
 382     char superfluous;                  /* Use superfluous things */
 383
 384     /* root window mouse bindings */
 385     signed char mouse_button1;         /* action for left mouse button */
 386     signed char mouse_button2;         /* action for middle mouse button */
 387     signed char mouse_button3;         /* action for right mouse button */
 388     signed char mouse_wheel;           /* action for mouse wheel */
 389
 390     /* balloon text */
 391     char window_balloon;
 392     char miniwin_balloon;
 393     char appicon_balloon;
 394     char help_balloon;
 395
 396     /* some constants */
 397     int dblclick_time;                 /* double click delay time in ms */
 398
 399     /* animate menus */
 400     signed char menu_scroll_speed;             /* how fast menus are scrolled */
 401
 402     /* animate icon sliding */
 403     signed char icon_slide_speed;              /* icon slide animation speed */
 404
 405     /* shading animation */
 406     signed char shade_speed;
 407
 408     int edge_resistance;
 409     int resize_increment;
 410     char attract;
 411
 412     unsigned int workspace_border_size; /* Size in pixels of the workspace border */
 413     char workspace_border_position;     /* Where to leave a workspace border */
 414     char single_click;                  /* single click to lauch applications */
 415     int history_lines;                  /* history of "Run..." dialog */
 416
 417     RImage *swtileImage;
 418     RImage *swbackImage[9];
 419
 420     struct {
 421         unsigned int nodock:1;         /* don't display the dock */
 422         unsigned int noclip:1;         /* don't display the clip */
 423         unsigned int nocpp:1;          /* don't use cpp */
 424         unsigned int noupdates:1;      /* don't require ~/GNUstep (-static) */
 425         unsigned int noautolaunch:1;   /* don't autolaunch apps */
 426         unsigned int norestore:1;      /* don't restore session */
 427         unsigned int create_stdcmap:1; /* create std colormap */
 428         unsigned int restarting:2;
 429     } flags;                           /* internal flags */
 430 } WPreferences;
 431
 432
 433
 434 /****** Global Variables  ******/
 435 extern Display  *dpy;
 436 extern char *ProgName;
 437 extern unsigned int ValidModMask;
 438 extern char WProgramState;
 439 extern char WProgramSigState;
 440
 441
 442 /****** Global Functions ******/
 443 extern void wAbort(Bool dumpCore);
 444
 445
 446 /****** Notifications ******/
 447 extern const char *WMNManaged;
 448 extern const char *WMNUnmanaged;
 449 extern const char *WMNChangedWorkspace;
 450 extern const char *WMNChangedState;
 451 extern const char *WMNChangedFocus;
 452 extern const char *WMNChangedStacking;
 453 extern const char *WMNChangedName;
 454
 455 extern const char *WMNWorkspaceCreated;
 456 extern const char *WMNWorkspaceDestroyed;
 457 extern const char *WMNWorkspaceChanged;
 458 extern const char *WMNWorkspaceNameChanged;
 459
 460 extern const char *WMNResetStacking;
 461 #endif
 462