src/WindowMaker.h

   1 /*
   2  *  Window Maker window manager
   3  *
   4  *  Copyright (c) 1997, 1998 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
  27 #include <assert.h>
  28 #include <limits.h>
  29
  30 #include <WINGs/WINGs.h>
  31
  32 #if defined(HAVE_LIBINTL_H) && defined(I18N)
  33 # include <libintl.h>
  34 # define _(text) gettext(text)
  35 #else
  36 # define _(text) (text)
  37 #endif
  38
  39
  40
  41
  42 /* class codes */
  43 typedef enum {
  44     WCLASS_UNKNOWN = 0,
  45         WCLASS_WINDOW = 1,             /* managed client windows */
  46         WCLASS_MENU = 2,               /* root menus */
  47         WCLASS_APPICON = 3,
  48         WCLASS_DUMMYWINDOW = 4,        /* window that holds window group leader */
  49         WCLASS_MINIWINDOW = 5,
  50         WCLASS_DOCK_ICON = 6,
  51         WCLASS_PAGER = 7,
  52         WCLASS_TEXT_INPUT = 8,
  53         WCLASS_FRAME = 9
  54 } WClassType;
  55
  56
  57 /*
  58  * generic window levels (a superset of the N*XTSTEP ones)
  59  * Applications should use levels between WMDesktopLevel and
  60  * WMScreensaverLevel anything boyond that range is allowed,
  61  * but discouraged.
  62  */
  63 enum {
  64         WMBackLevel = INT_MIN+1,        /* Very lowest level */
  65         WMDesktopLevel = -1000,         /* Lowest level of normal use */
  66         WMSunkenLevel = -1,
  67         WMNormalLevel = 0,
  68         WMFloatingLevel = 3,
  69         WMDockLevel = 5,
  70         WMSubmenuLevel = 6,
  71         WMMainMenuLevel = 20,
  72         WMStatusLevel = 21,
  73         WMModalLevel = 100,
  74         WMPopUpLevel = 101,
  75         WMScreensaverLevel = 1000,
  76         WMOuterSpaceLevel = INT_MAX
  77 };
  78
  79 /*
  80  * WObjDescriptor will be used by the event dispatcher to
  81  * send events to a particular object through the methods in the
  82  * method table. If all objects of the same class share the
  83  * same methods, the class method table should be used, otherwise
  84  * a new method table must be created for each object.
  85  * It is also assigned to find the parent structure of a given
  86  * window (like the WWindow or WMenu for a button)
  87  */
  88
  89 typedef struct WObjDescriptor {
  90     void *self;                        /* the object that will be called */
  91                                        /* event handlers */
  92     void (*handle_expose)(struct WObjDescriptor *sender, XEvent *event);
  93
  94     void (*handle_mousedown)(struct WObjDescriptor *sender, XEvent *event);
  95
  96     void (*handle_anything)(struct WObjDescriptor *sender, XEvent *event);
  97
  98     void (*handle_enternotify)(struct WObjDescriptor *sender, XEvent *event);
  99     void (*handle_leavenotify)(struct WObjDescriptor *sender, XEvent *event);
 100
 101     WClassType parent_type;            /* type code of the parent */
 102     void *parent;                      /* parent object (WWindow or WMenu) */
 103 } WObjDescriptor;
 104
 105
 106 /* shutdown modes */
 107 typedef enum {
 108     WSExitMode,
 109         WSLogoutMode,
 110         WSKillMode,
 111         WSRestartPreparationMode
 112 } WShutdownMode;
 113
 114
 115 /* internal buttons */
 116 #define WBUT_CLOSE              0
 117 #define WBUT_BROKENCLOSE        1
 118 #define WBUT_ICONIFY            2
 119 #define WBUT_KILL               3
 120 #ifdef XKB_BUTTON_HINT
 121 #define WBUT_XKBGROUP1      4
 122 #define WBUT_XKBGROUP2      5
 123 #define WBUT_XKBGROUP3      6
 124 #define WBUT_XKBGROUP4      7
 125 #define PRED_BPIXMAPS           8 /* reserved for 4 groups */
 126 #else
 127 #define PRED_BPIXMAPS           4 /* count of WBUT icons */
 128 #endif /* XKB_BUTTON_HINT */
 129
 130 /* cursors */
 131 #define WCUR_DEFAULT    0
 132 #define WCUR_NORMAL     0
 133 #define WCUR_MOVE       1
 134 #define WCUR_RESIZE     2
 135 #define WCUR_TOPLEFTRESIZE      3
 136 #define WCUR_TOPRIGHTRESIZE     4
 137 #define WCUR_BOTTOMLEFTRESIZE   5
 138 #define WCUR_BOTTOMRIGHTRESIZE  6
 139 #define WCUR_VERTICALRESIZE 7
 140 #define WCUR_HORIZONRESIZE 8
 141 #define WCUR_WAIT       9
 142 #define WCUR_ARROW      10
 143 #define WCUR_QUESTION   11
 144 #define WCUR_TEXT       12
 145 #define WCUR_SELECT     13
 146 #define WCUR_ROOT       14
 147 #define WCUR_LAST   15
 148
 149 /* geometry displays */
 150 #define WDIS_NEW        0              /* new style */
 151 #define WDIS_CENTER     1              /* center of screen */
 152 #define WDIS_TOPLEFT    2              /* top left corner of screen */
 153 #define WDIS_FRAME_CENTER 3            /* center of the frame */
 154
 155
 156 /* keyboard input focus mode */
 157 #define WKF_CLICK       0
 158 #define WKF_POINTER     1
 159 #define WKF_SLOPPY      2
 160
 161 /* window placement mode */
 162 #define WPM_MANUAL      0
 163 #define WPM_CASCADE     1
 164 #define WPM_SMART       2
 165 #define WPM_RANDOM      3
 166 #define WPM_AUTO        4
 167
 168 /* text justification */
 169 #define WTJ_CENTER      0
 170 #define WTJ_LEFT        1
 171 #define WTJ_RIGHT       2
 172
 173 /* iconification styles */
 174 #define WIS_ZOOM        0
 175 #define WIS_TWIST       1
 176 #define WIS_FLIP        2
 177 #define WIS_NONE        3
 178 #define WIS_RANDOM      4 /* secret */
 179
 180 /* switchmenu actions */
 181 #define ACTION_ADD      0
 182 #define ACTION_REMOVE   1
 183 #define ACTION_CHANGE   2
 184 #define ACTION_CHANGE_WORKSPACE 3
 185 #define ACTION_CHANGE_STATE     4
 186
 187
 188 /* speeds */
 189 #define SPEED_ULTRAFAST 0
 190 #define SPEED_FAST      1
 191 #define SPEED_MEDIUM    2
 192 #define SPEED_SLOW      3
 193 #define SPEED_ULTRASLOW 4
 194
 195
 196 /* window states */
 197 #define WS_FOCUSED      0
 198 #define WS_UNFOCUSED    1
 199 #define WS_PFOCUSED     2
 200
 201 /* clip title colors */
 202 #define CLIP_NORMAL    0
 203 #define CLIP_COLLAPSED 1
 204
 205
 206 /* icon yard position */
 207 #define IY_VERT         1
 208 #define IY_HORIZ        0
 209 #define IY_TOP          2
 210 #define IY_BOTTOM       0
 211 #define IY_RIGHT        4
 212 #define IY_LEFT         0
 213
 214
 215 /* menu styles */
 216 #define MS_NORMAL               0
 217 #define MS_SINGLE_TEXTURE       1
 218 #define MS_FLAT                 2
 219
 220 /* workspace actions */
 221 #define WA_NONE                 0
 222 #define WA_SELECT_WINDOWS       1
 223 #define WA_OPEN_APPMENU         2
 224 #define WA_OPEN_WINLISTMENU     3
 225 #define WA_SWITCH_WORKSPACES    4
 226
 227 /* workspace display position */
 228 #define WD_NONE         0
 229 #define WD_CENTER       1
 230 #define WD_TOP          2
 231 #define WD_BOTTOM       3
 232 #define WD_TOPLEFT      4
 233 #define WD_TOPRIGHT     5
 234 #define WD_BOTTOMLEFT   6
 235 #define WD_BOTTOMRIGHT  7
 236
 237
 238 /* workspace border position */
 239 #define WB_NONE         0
 240 #define WB_LEFTRIGHT    1
 241 #define WB_TOPBOTTOM    2
 242 #define WB_ALLDIRS      (WB_LEFTRIGHT|WB_TOPBOTTOM)
 243
 244
 245 /* program states */
 246 #define WSTATE_NORMAL           0
 247 #define WSTATE_NEED_EXIT        1
 248 #define WSTATE_NEED_RESTART     2
 249 #define WSTATE_EXITING          3
 250 #define WSTATE_RESTARTING       4
 251 #define WSTATE_MODAL            5
 252 #define WSTATE_NEED_REREAD      6
 253
 254
 255 #define WCHECK_STATE(state)     (state == WProgramState)
 256
 257
 258 #define WCHANGE_STATE(nstate) {\
 259     if (WProgramState == WSTATE_NORMAL\
 260             || nstate != WSTATE_MODAL)\
 261         WProgramState = (nstate); \
 262     if (WProgramSigState != 0)\
 263         WProgramState = WProgramSigState;\
 264 }
 265
 266
 267 /* only call inside signal handlers, with signals blocked */
 268 #define SIG_WCHANGE_STATE(nstate) {\
 269     WProgramSigState = (nstate);\
 270     WProgramState = (nstate);\
 271 }
 272
 273
 274 /* Flags for the Window Maker state when restarting/crash situations */
 275 #define WFLAGS_NONE       (0)
 276 #define WFLAGS_CRASHED    (1<<0)
 277
 278
 279 /* notifications */
 280
 281 #ifdef MAINFILE
 282 #define NOTIFICATION(n) char *WN##n = #n
 283 #else
 284 #define NOTIFICATION(n) extern char *WN##n
 285 #endif
 286
 287 NOTIFICATION(WindowAppearanceSettingsChanged);
 288
 289 NOTIFICATION(IconAppearanceSettingsChanged);
 290
 291 NOTIFICATION(IconTileSettingsChanged);
 292
 293 NOTIFICATION(MenuAppearanceSettingsChanged);
 294
 295 NOTIFICATION(MenuTitleAppearanceSettingsChanged);
 296
 297
 298 /* appearance settings clientdata flags */
 299 enum {
 300     WFontSettings = 1 << 0,
 301         WTextureSettings = 1 << 1,
 302         WColorSettings = 1 << 2
 303 };
 304
 305
 306
 307 typedef struct {
 308     int x1, y1;
 309     int x2, y2;
 310 } WArea;
 311
 312 typedef struct WCoord {
 313     int x, y;
 314 } WCoord;
 315
 316 typedef struct WPreferences {
 317     char *pixmap_path;                 /* : separate list of */
 318                                        /* paths to find pixmaps */
 319     char *icon_path;                   /* : separated list of */
 320                                        /* paths to find icons */
 321
 322     char *logger_shell;                /* shell to log child stdi/o */
 323
 324     RImage *button_images;             /* titlebar button images */
 325
 326     char smooth_workspace_back;
 327     signed char size_display;                  /* display type for resize geometry */
 328     signed char move_display;                  /* display type for move geometry */
 329     signed char window_placement;              /* window placement mode */
 330     signed char colormap_mode;                 /* colormap focus mode */
 331     signed char focus_mode;                    /* window focusing mode */
 332
 333     char opaque_move;                  /* update window position during */
 334                                        /* move */
 335
 336     char wrap_menus;                   /* wrap menus at edge of screen */
 337     char scrollable_menus;             /* let them be scrolled */
 338     char align_menus;                  /* align menu with their parents */
 339
 340     char use_saveunders;               /* turn on SaveUnders for menus,
 341                                         * icons etc. */
 342     char no_window_over_dock;
 343
 344     char no_window_over_icons;
 345
 346     WCoord window_place_origin;        /* Offset for windows placed on
 347                                         * screen */
 348
 349     char constrain_window_size;        /* don't let windows get bigger than
 350                                         * screen */
 351
 352     char windows_cycling;              /* windoze cycling */
 353     char circ_raise;                   /* raise window after Alt-tabbing */
 354
 355     char ignore_focus_click;
 356
 357     char open_transients_with_parent;  /* open transient window in
 358                                         same workspace as parent */
 359     signed char title_justification;           /* titlebar text alignment */
 360
 361     int window_title_clearance;
 362     int menu_title_clearance;
 363     int menu_text_clearance;
 364
 365     char multi_byte_text;
 366 #ifdef KEEP_XKB_LOCK_STATUS
 367     char modelock;
 368 #endif
 369
 370     char no_dithering;                 /* use dithering or not */
 371
 372     char no_sound;                     /* enable/disable sound */
 373     char no_animations;                /* enable/disable animations */
 374
 375     char no_autowrap;                  /* wrap workspace when window is moved
 376                                         * to the edge */
 377
 378     char auto_arrange_icons;           /* automagically arrange icons */
 379
 380     char icon_box_position;            /* position to place icons */
 381
 382     signed char iconification_style;          /* position to place icons */
 383
 384     char disable_root_mouse;           /* disable button events in root window */
 385
 386     char auto_focus;                   /* focus window when it's mapped */
 387
 388
 389     char *icon_back_file;              /* background image for icons */
 390
 391     WCoord *root_menu_pos;             /* initial position of the root menu*/
 392     WCoord *app_menu_pos;
 393
 394     WCoord *win_menu_pos;
 395
 396     signed char icon_yard;                     /* aka iconbox */
 397
 398     int raise_delay;                   /* delay for autoraise. 0 is disabled */
 399
 400     int cmap_size;                     /* size of dithering colormap in colors
 401                                         * per channel */
 402
 403     int icon_size;                     /* size of the icon */
 404
 405     signed char menu_style;            /* menu decoration style */
 406
 407     signed char workspace_name_display_position;
 408
 409     unsigned int modifier_mask;        /* mask to use as kbd modifier */
 410
 411
 412     char ws_advance;                   /* Create new workspace and advance */
 413
 414 #ifdef VIRTUAL_DESKTOP
 415     unsigned int vedge_thickness;
 416     unsigned int vedge_bordersize;
 417     unsigned int vedge_hscrollspeed;
 418     unsigned int vedge_vscrollspeed;
 419     unsigned int vedge_maxheight;
 420     unsigned int vedge_maxwidth;
 421 #endif
 422
 423     char ws_cycle;                     /* Cycle existing workspaces */
 424
 425     char save_session_on_exit;         /* automatically save session on exit */
 426
 427     char sticky_icons;                 /* If miniwindows will be onmipresent */
 428
 429     char dont_confirm_kill;            /* do not confirm Kill application */
 430
 431     char disable_miniwindows;
 432
 433     char dont_blink;                   /* do not blink icon selection */
 434
 435     /* Appearance options */
 436     char new_style;                    /* Use newstyle buttons */
 437     char superfluous;                  /* Use superfluous things */
 438
 439     /* root window mouse bindings */
 440     signed char mouse_button1;         /* action for left mouse button */
 441     signed char mouse_button2;         /* action for middle mouse button */
 442     signed char mouse_button3;         /* action for right mouse button */
 443     signed char mouse_wheel;           /* action for mouse wheel */
 444
 445     /* balloon text */
 446     char window_balloon;
 447     char miniwin_balloon;
 448     char appicon_balloon;
 449     char help_balloon;
 450
 451     /* some constants */
 452     int dblclick_time;                 /* double click delay time in ms */
 453
 454     /* animate menus */
 455     signed char menu_scroll_speed;             /* how fast menus are scrolled */
 456
 457     /* animate icon sliding */
 458     signed char icon_slide_speed;              /* icon slide animation speed */
 459
 460     /* shading animation */
 461     signed char shade_speed;
 462
 463     int edge_resistance;
 464     char attract;
 465
 466     unsigned int workspace_border_size; /* Size in pixels of the workspace border */
 467     char workspace_border_position;     /* Where to leave a workspace border */
 468
 469     struct {
 470         unsigned int nodock:1;         /* don't display the dock */
 471         unsigned int noclip:1;         /* don't display the clip */
 472         unsigned int nocpp:1;          /* don't use cpp */
 473         unsigned int noupdates:1;      /* don't require ~/GNUstep (-static) */
 474         unsigned int noautolaunch:1;   /* don't autolaunch apps */
 475         unsigned int norestore:1;      /* don't restore session */
 476         unsigned int create_stdcmap:1; /* create std colormap */
 477         unsigned int nopolling:1;      /* don't poll for defaults changes */
 478     } flags;                           /* internal flags */
 479 } WPreferences;
 480
 481
 482
 483 /****** Global Variables  ******/
 484 extern Display  *dpy;
 485 extern char *ProgName;
 486 extern unsigned int ValidModMask;
 487 extern char WProgramState;
 488 extern char WProgramSigState;
 489
 490 /****** Global Functions ******/
 491 extern void wAbort(Bool dumpCore);
 492
 493 #endif