src/WindowMaker.h

   1 /*
   2  *  Window Maker window manager
   3  *
   4  *  Copyright (c) 1997-2002 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 #define WDIS_NONE       4
 155
 156 /* keyboard input focus mode */
 157 #define WKF_CLICK       0
 158 #define WKF_SLOPPY      2
 159
 160 /* colormap change mode */
 161 #define WCM_CLICK       0
 162 #define WCM_POINTER     1
 163
 164 /* window placement mode */
 165 #define WPM_MANUAL      0
 166 #define WPM_CASCADE     1
 167 #define WPM_SMART       2
 168 #define WPM_RANDOM      3
 169 #define WPM_AUTO        4
 170
 171 /* text justification */
 172 #define WTJ_CENTER      0
 173 #define WTJ_LEFT        1
 174 #define WTJ_RIGHT       2
 175
 176 /* iconification styles */
 177 #define WIS_ZOOM        0
 178 #define WIS_TWIST       1
 179 #define WIS_FLIP        2
 180 #define WIS_NONE        3
 181 #define WIS_RANDOM      4 /* secret */
 182
 183 /* switchmenu actions */
 184 #define ACTION_ADD      0
 185 #define ACTION_REMOVE   1
 186 #define ACTION_CHANGE   2
 187 #define ACTION_CHANGE_WORKSPACE 3
 188 #define ACTION_CHANGE_STATE     4
 189
 190
 191 /* speeds */
 192 #define SPEED_ULTRAFAST 0
 193 #define SPEED_FAST      1
 194 #define SPEED_MEDIUM    2
 195 #define SPEED_SLOW      3
 196 #define SPEED_ULTRASLOW 4
 197
 198
 199 /* window states */
 200 #define WS_FOCUSED      0
 201 #define WS_UNFOCUSED    1
 202 #define WS_PFOCUSED     2
 203
 204 /* clip title colors */
 205 #define CLIP_NORMAL    0
 206 #define CLIP_COLLAPSED 1
 207
 208
 209 /* icon yard position */
 210 #define IY_VERT         1
 211 #define IY_HORIZ        0
 212 #define IY_TOP          2
 213 #define IY_BOTTOM       0
 214 #define IY_RIGHT        4
 215 #define IY_LEFT         0
 216
 217
 218 /* menu styles */
 219 #define MS_NORMAL               0
 220 #define MS_SINGLE_TEXTURE       1
 221 #define MS_FLAT                 2
 222
 223 /* workspace actions */
 224 #define WA_NONE                 0
 225 #define WA_SELECT_WINDOWS       1
 226 #define WA_OPEN_APPMENU         2
 227 #define WA_OPEN_WINLISTMENU     3
 228 #define WA_SWITCH_WORKSPACES    4
 229
 230 /* workspace display position */
 231 #define WD_NONE         0
 232 #define WD_CENTER       1
 233 #define WD_TOP          2
 234 #define WD_BOTTOM       3
 235 #define WD_TOPLEFT      4
 236 #define WD_TOPRIGHT     5
 237 #define WD_BOTTOMLEFT   6
 238 #define WD_BOTTOMRIGHT  7
 239
 240
 241 /* workspace border position */
 242 #define WB_NONE         0
 243 #define WB_LEFTRIGHT    1
 244 #define WB_TOPBOTTOM    2
 245 #define WB_ALLDIRS      (WB_LEFTRIGHT|WB_TOPBOTTOM)
 246
 247
 248 /* program states */
 249 #define WSTATE_NORMAL           0
 250 #define WSTATE_NEED_EXIT        1
 251 #define WSTATE_NEED_RESTART     2
 252 #define WSTATE_EXITING          3
 253 #define WSTATE_RESTARTING       4
 254 #define WSTATE_MODAL            5
 255 #define WSTATE_NEED_REREAD      6
 256
 257
 258 #define WCHECK_STATE(state)     (state == WProgramState)
 259
 260
 261 #define WCHANGE_STATE(nstate) {\
 262     if (WProgramState == WSTATE_NORMAL\
 263             || nstate != WSTATE_MODAL)\
 264         WProgramState = (nstate); \
 265     if (WProgramSigState != 0)\
 266         WProgramState = WProgramSigState;\
 267 }
 268
 269
 270 /* only call inside signal handlers, with signals blocked */
 271 #define SIG_WCHANGE_STATE(nstate) {\
 272     WProgramSigState = (nstate);\
 273     WProgramState = (nstate);\
 274 }
 275
 276
 277 /* Flags for the Window Maker state when restarting/crash situations */
 278 #define WFLAGS_NONE       (0)
 279 #define WFLAGS_CRASHED    (1<<0)
 280
 281
 282 /* notifications */
 283
 284 #ifdef MAINFILE
 285 #define NOTIFICATION(n) char *WN##n = #n
 286 #else
 287 #define NOTIFICATION(n) extern char *WN##n
 288 #endif
 289
 290 NOTIFICATION(WindowAppearanceSettingsChanged);
 291
 292 NOTIFICATION(IconAppearanceSettingsChanged);
 293
 294 NOTIFICATION(IconTileSettingsChanged);
 295
 296 NOTIFICATION(MenuAppearanceSettingsChanged);
 297
 298 NOTIFICATION(MenuTitleAppearanceSettingsChanged);
 299
 300
 301 /* appearance settings clientdata flags */
 302 enum {
 303     WFontSettings = 1 << 0,
 304         WTextureSettings = 1 << 1,
 305         WColorSettings = 1 << 2
 306 };
 307
 308
 309
 310 typedef struct {
 311     int x1, y1;
 312     int x2, y2;
 313 } WArea;
 314
 315 typedef struct WCoord {
 316     int x, y;
 317 } WCoord;
 318
 319 typedef struct WPreferences {
 320     char *pixmap_path;                 /* : separate list of */
 321                                        /* paths to find pixmaps */
 322     char *icon_path;                   /* : separated list of */
 323                                        /* paths to find icons */
 324     WMArray *fallbackWMs;              /* fallback window manager list */
 325
 326     char *logger_shell;                /* shell to log child stdi/o */
 327
 328     RImage *button_images;             /* titlebar button images */
 329
 330     char smooth_workspace_back;
 331     signed char size_display;                  /* display type for resize geometry */
 332     signed char move_display;                  /* display type for move geometry */
 333     signed char window_placement;              /* window placement mode */
 334     signed char colormap_mode;                 /* colormap focus mode */
 335     signed char focus_mode;                    /* window focusing mode */
 336
 337     char opaque_move;                  /* update window position during */
 338                                        /* move */
 339
 340     char wrap_menus;                   /* wrap menus at edge of screen */
 341     char scrollable_menus;             /* let them be scrolled */
 342     char align_menus;                  /* align menu with their parents */
 343
 344     char use_saveunders;               /* turn on SaveUnders for menus,
 345                                         * icons etc. */
 346     char no_window_over_dock;
 347
 348     char no_window_over_icons;
 349
 350     WCoord window_place_origin;        /* Offset for windows placed on
 351                                         * screen */
 352
 353     char constrain_window_size;        /* don't let windows get bigger than
 354                                         * screen */
 355
 356     char windows_cycling;              /* windoze cycling */
 357     char circ_raise;                   /* raise window after Alt-tabbing */
 358
 359     char ignore_focus_click;
 360
 361     char open_transients_with_parent;  /* open transient window in
 362                                         same workspace as parent */
 363     signed char title_justification;           /* titlebar text alignment */
 364
 365     int window_title_clearance;
 366     int menu_title_clearance;
 367     int menu_text_clearance;
 368
 369     char multi_byte_text;
 370 #ifdef KEEP_XKB_LOCK_STATUS
 371     char modelock;
 372 #endif
 373
 374     char no_dithering;                 /* use dithering or not */
 375
 376     char no_sound;                     /* enable/disable sound */
 377     char no_animations;                /* enable/disable animations */
 378
 379     char no_autowrap;                  /* wrap workspace when window is moved
 380                                         * to the edge */
 381
 382     char auto_arrange_icons;           /* automagically arrange icons */
 383
 384     char icon_box_position;            /* position to place icons */
 385
 386     signed char iconification_style;          /* position to place icons */
 387
 388     char disable_root_mouse;           /* disable button events in root window */
 389
 390     char auto_focus;                   /* focus window when it's mapped */
 391
 392
 393     char *icon_back_file;              /* background image for icons */
 394
 395     WCoord *root_menu_pos;             /* initial position of the root menu*/
 396     WCoord *app_menu_pos;
 397
 398     WCoord *win_menu_pos;
 399
 400     signed char icon_yard;                     /* aka iconbox */
 401
 402     int raise_delay;                   /* delay for autoraise. 0 is disabled */
 403
 404     int cmap_size;                     /* size of dithering colormap in colors
 405                                         * per channel */
 406
 407     int icon_size;                     /* size of the icon */
 408
 409     signed char menu_style;            /* menu decoration style */
 410
 411     signed char workspace_name_display_position;
 412
 413     unsigned int modifier_mask;        /* mask to use as kbd modifier */
 414
 415
 416     char ws_advance;                   /* Create new workspace and advance */
 417
 418 #ifdef VIRTUAL_DESKTOP
 419     unsigned int vedge_thickness;
 420     unsigned int vedge_bordersize;
 421     unsigned int vedge_hscrollspeed;
 422     unsigned int vedge_vscrollspeed;
 423     unsigned int vedge_maxheight;
 424     unsigned int vedge_maxwidth;
 425 #endif
 426
 427     char ws_cycle;                     /* Cycle existing workspaces */
 428
 429     char save_session_on_exit;         /* automatically save session on exit */
 430
 431     char sticky_icons;                 /* If miniwindows will be onmipresent */
 432
 433     char dont_confirm_kill;            /* do not confirm Kill application */
 434
 435     char disable_miniwindows;
 436
 437     char dont_blink;                   /* do not blink icon selection */
 438
 439     /* Appearance options */
 440     char new_style;                    /* Use newstyle buttons */
 441     char superfluous;                  /* Use superfluous things */
 442
 443     /* root window mouse bindings */
 444     signed char mouse_button1;         /* action for left mouse button */
 445     signed char mouse_button2;         /* action for middle mouse button */
 446     signed char mouse_button3;         /* action for right mouse button */
 447     signed char mouse_wheel;           /* action for mouse wheel */
 448
 449     /* balloon text */
 450     char window_balloon;
 451     char miniwin_balloon;
 452     char appicon_balloon;
 453     char help_balloon;
 454
 455     /* some constants */
 456     int dblclick_time;                 /* double click delay time in ms */
 457
 458     /* animate menus */
 459     signed char menu_scroll_speed;             /* how fast menus are scrolled */
 460
 461     /* animate icon sliding */
 462     signed char icon_slide_speed;              /* icon slide animation speed */
 463
 464     /* shading animation */
 465     signed char shade_speed;
 466
 467     int edge_resistance;
 468     char attract;
 469
 470     unsigned int workspace_border_size; /* Size in pixels of the workspace border */
 471     char workspace_border_position;     /* Where to leave a workspace border */
 472
 473     struct {
 474         unsigned int nodock:1;         /* don't display the dock */
 475         unsigned int noclip:1;         /* don't display the clip */
 476         unsigned int nocpp:1;          /* don't use cpp */
 477         unsigned int noupdates:1;      /* don't require ~/GNUstep (-static) */
 478         unsigned int noautolaunch:1;   /* don't autolaunch apps */
 479         unsigned int norestore:1;      /* don't restore session */
 480         unsigned int create_stdcmap:1; /* create std colormap */
 481         unsigned int nopolling:1;      /* don't poll for defaults changes */
 482     } flags;                           /* internal flags */
 483 } WPreferences;
 484
 485
 486
 487 /****** Global Variables  ******/
 488 extern Display  *dpy;
 489 extern char *ProgName;
 490 extern unsigned int ValidModMask;
 491 extern char WProgramState;
 492 extern char WProgramSigState;
 493
 494
 495 /****** Global Functions ******/
 496 extern void wAbort(Bool dumpCore);
 497
 498
 499 /****** Notifications ******/
 500 extern const char *WMNManaged;
 501 extern const char *WMNUnmanaged;
 502 extern const char *WMNChangedWorkspace;
 503 extern const char *WMNChangedState;
 504 extern const char *WMNChangedFocus;
 505 extern const char *WMNChangedStacking;
 506 extern const char *WMNChangedName;
 507
 508 extern const char *WMNWorkspaceCreated;
 509 extern const char *WMNWorkspaceDestroyed;
 510 extern const char *WMNWorkspaceChanged;
 511 extern const char *WMNWorkspaceNameChanged;
 512
 513 extern const char *WMNResetStacking;
 514 #endif