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
  29 #include "WINGs.h"
  30 #include "WUtil.h"
  31
  32 #if HAVE_LIBINTL_H && 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 /* generic window levels (a superset of the N*XTSTEP ones) */
  58 enum {
  59     WMDesktopLevel = 0,
  60         WMSunkenLevel = 1,
  61         WMNormalLevel = 2,
  62         WMFloatingLevel = 3,
  63         WMDockLevel = 4,
  64         WMSubmenuLevel = 5,
  65         WMMainMenuLevel = 6,
  66         WMOuterSpaceLevel = 7
  67 };
  68 #define MAX_WINDOW_LEVELS 8
  69
  70 /*
  71  * WObjDescriptor will be used by the event dispatcher to
  72  * send events to a particular object through the methods in the
  73  * method table. If all objects of the same class share the
  74  * same methods, the class method table should be used, otherwise
  75  * a new method table must be created for each object.
  76  * It is also assigned to find the parent structure of a given
  77  * window (like the WWindow or WMenu for a button)
  78  */
  79
  80 typedef struct WObjDescriptor {
  81     void *self;                        /* the object that will be called */
  82                                        /* event handlers */
  83     void (*handle_expose)(struct WObjDescriptor *sender, XEvent *event);
  84
  85     void (*handle_mousedown)(struct WObjDescriptor *sender, XEvent *event);
  86
  87     void (*handle_anything)(struct WObjDescriptor *sender, XEvent *event);
  88
  89     void (*handle_enternotify)(struct WObjDescriptor *sender, XEvent *event);
  90     void (*handle_leavenotify)(struct WObjDescriptor *sender, XEvent *event);
  91
  92     WClassType parent_type;            /* type code of the parent */
  93     void *parent;                      /* parent object (WWindow or WMenu) */
  94 } WObjDescriptor;
  95
  96
  97 /* shutdown modes */
  98 typedef enum {
  99     WSExitMode,
 100         WSLogoutMode,
 101         WSKillMode,
 102         WSRestartPreparationMode
 103 } WShutdownMode;
 104
 105
 106 /* internal buttons */
 107 #define WBUT_CLOSE              0
 108 #define WBUT_BROKENCLOSE        1
 109 #define WBUT_ICONIFY            2
 110 #define WBUT_KILL               3
 111 #ifdef XKB_BUTTON_HINT
 112 #define WBUT_XKBGROUP1      4
 113 #define WBUT_XKBGROUP2      5
 114 #define WBUT_XKBGROUP3      6
 115 #define WBUT_XKBGROUP4      7
 116 #define PRED_BPIXMAPS           8 /* reserved for 4 groups */
 117 #else
 118 #define PRED_BPIXMAPS           4 /* count of WBUT icons */
 119 #endif /* XKB_BUTTON_HINT */
 120
 121 /* cursors */
 122 #define WCUR_DEFAULT    0
 123 #define WCUR_NORMAL     0
 124 #define WCUR_MOVE       1
 125 #define WCUR_RESIZE     2
 126 #define WCUR_WAIT       3
 127 #define WCUR_ARROW      4
 128 #define WCUR_QUESTION   5
 129 #define WCUR_TEXT       6
 130 #define WCUR_LAST       7
 131
 132
 133 /* geometry displays */
 134 #define WDIS_NEW        0              /* new style */
 135 #define WDIS_CENTER     1              /* center of screen */
 136 #define WDIS_TOPLEFT    2              /* top left corner of screen */
 137 #define WDIS_FRAME_CENTER 3            /* center of the frame */
 138
 139
 140 /* keyboard input focus mode */
 141 #define WKF_CLICK       0
 142 #define WKF_POINTER     1
 143 #define WKF_SLOPPY      2
 144
 145 /* window placement mode */
 146 #define WPM_MANUAL      0
 147 #define WPM_CASCADE     1
 148 #define WPM_SMART       2
 149 #define WPM_RANDOM      3
 150
 151 /* text justification */
 152 #define WTJ_CENTER      0
 153 #define WTJ_LEFT        1
 154 #define WTJ_RIGHT       2
 155
 156 /* iconification styles */
 157 #define WIS_ZOOM        0
 158 #define WIS_TWIST       1
 159 #define WIS_FLIP        2
 160 #define WIS_NONE        3
 161 #define WIS_RANDOM      4 /* secret */
 162
 163 /* switchmenu actions */
 164 #define ACTION_ADD      0
 165 #define ACTION_REMOVE   1
 166 #define ACTION_CHANGE   2
 167 #define ACTION_CHANGE_WORKSPACE 3
 168 #define ACTION_CHANGE_STATE     4
 169
 170
 171 /* speeds */
 172 #define SPEED_ULTRAFAST 0
 173 #define SPEED_FAST      1
 174 #define SPEED_MEDIUM    2
 175 #define SPEED_SLOW      3
 176 #define SPEED_ULTRASLOW 4
 177
 178
 179 /* window states */
 180 #define WS_FOCUSED      0
 181 #define WS_UNFOCUSED    1
 182 #define WS_PFOCUSED     2
 183
 184 /* clip title colors */
 185 #define CLIP_NORMAL    0
 186 #define CLIP_COLLAPSED 1
 187
 188
 189 /* icon yard position */
 190 #define IY_VERT         1
 191 #define IY_HORIZ        0
 192 #define IY_TOP          2
 193 #define IY_BOTTOM       0
 194 #define IY_RIGHT        4
 195 #define IY_LEFT         0
 196
 197
 198 /* menu styles */
 199 #define MS_NORMAL               0
 200 #define MS_SINGLE_TEXTURE       1
 201 #define MS_FLAT                 2
 202
 203
 204 /* workspace display position */
 205 #define WD_NONE         0
 206 #define WD_CENTER       1
 207 #define WD_TOP          2
 208 #define WD_BOTTOM       3
 209 #define WD_TOPLEFT      4
 210 #define WD_TOPRIGHT     5
 211 #define WD_BOTTOMLEFT   6
 212 #define WD_BOTTOMRIGHT  7
 213
 214
 215 /* program states */
 216 #define WSTATE_NORMAL           0
 217 #define WSTATE_NEED_EXIT        1
 218 #define WSTATE_NEED_RESTART     2
 219 #define WSTATE_EXITING          3
 220 #define WSTATE_RESTARTING       4
 221 #define WSTATE_MODAL            5
 222
 223
 224 #define WCHECK_STATE(state)     (state == WProgramState)
 225 #define WCHANGE_STATE(nstate)   \
 226         if (WProgramState == WSTATE_NORMAL\
 227                 || nstate != WSTATE_MODAL)\
 228                  WProgramState = (nstate)
 229
 230
 231 /* notifications */
 232
 233 #ifdef MAINFILE
 234 #define NOTIFICATION(n) char *WN##n = #n
 235 #else
 236 #define NOTIFICATION(n) extern char *WN##n
 237 #endif
 238
 239 NOTIFICATION(WindowAppearanceSettingsChanged);
 240
 241 NOTIFICATION(IconAppearanceSettingsChanged);
 242
 243 NOTIFICATION(IconTileSettingsChanged);
 244
 245 NOTIFICATION(MenuAppearanceSettingsChanged);
 246
 247 NOTIFICATION(MenuTitleAppearanceSettingsChanged);
 248
 249
 250 /* appearance settings clientdata flags */
 251 enum {
 252     WFontSettings = 1 << 0,
 253         WTextureSettings = 1 << 1,
 254         WColorSettings = 1 << 2
 255 };
 256
 257
 258
 259 typedef struct {
 260     int x1, y1;
 261     int x2, y2;
 262 } WArea;
 263
 264 typedef struct WCoord {
 265     int x, y;
 266 } WCoord;
 267
 268 typedef struct WPreferences {
 269     char *pixmap_path;                 /* : separate list of */
 270                                        /* paths to find pixmaps */
 271     char *icon_path;                   /* : separated list of */
 272                                        /* paths to find icons */
 273
 274     RImage *button_images;             /* titlebar button images */
 275
 276     char smooth_workspace_back;
 277     char size_display;                 /* display type for resize geometry */
 278     char move_display;                 /* display type for move geometry */
 279     char window_placement;             /* window placement mode */
 280     char colormap_mode;                /* colormap focus mode */
 281     char focus_mode;                   /* window focusing mode */
 282
 283     char opaque_move;                  /* update window position during */
 284                                        /* move */
 285
 286     char wrap_menus;                   /* wrap menus at edge of screen */
 287     char scrollable_menus;             /* let them be scrolled */
 288     char align_menus;                  /* align menu with their parents */
 289
 290     char use_saveunders;               /* turn on SaveUnders for menus,
 291                                         * icons etc. */
 292     char no_window_over_dock;
 293
 294     char no_window_over_icons;
 295
 296     WCoord window_place_origin;        /* Offset for windows placed on
 297                                         * screen */
 298
 299     char constrain_window_size;        /* don't let windows get bigger than
 300                                         * screen */
 301
 302     char circ_raise;                   /* raise window when Alt-tabbing */
 303
 304     char ignore_focus_click;
 305
 306     char open_transients_with_parent;  /* open transient window in
 307                                         same workspace as parent */
 308     char title_justification;          /* titlebar text alignment */
 309
 310     char multi_byte_text;
 311 #ifdef KEEP_XKB_LOCK_STATUS
 312     char modelock;
 313 #endif
 314
 315     char no_dithering;                 /* use dithering or not */
 316
 317     char no_sound;                     /* enable/disable sound */
 318     char no_animations;                /* enable/disable animations */
 319
 320     char no_autowrap;                  /* wrap workspace when window is moved
 321                                         * to the edge */
 322
 323     char auto_arrange_icons;           /* automagically arrange icons */
 324
 325     char icon_box_position;            /* position to place icons */
 326
 327     char iconification_style;          /* position to place icons */
 328
 329     char disable_root_mouse;           /* disable button events in root window */
 330
 331     char auto_focus;                   /* focus window when it's mapped */
 332
 333
 334     char *icon_back_file;              /* background image for icons */
 335
 336     WCoord *root_menu_pos;             /* initial position of the root menu*/
 337     WCoord *app_menu_pos;
 338
 339     WCoord *win_menu_pos;
 340
 341     char icon_yard;                    /* aka iconbox */
 342
 343     int raise_delay;                   /* delay for autoraise. 0 is disabled */
 344
 345     int cmap_size;                     /* size of dithering colormap in colors
 346                                         * per channel */
 347
 348     int icon_size;                     /* size of the icon */
 349
 350     char menu_style;                   /* menu decoration style */
 351
 352     char workspace_name_display_position;
 353
 354     unsigned int modifier_mask;        /* mask to use as kbd modifier */
 355
 356
 357     char ws_advance;                   /* Create new workspace and advance */
 358
 359     char ws_cycle;                     /* Cycle existing workspaces */
 360
 361     char save_session_on_exit;         /* automatically save session on exit */
 362
 363     char sticky_icons;                 /* If miniwindows will be onmipresent */
 364
 365     char dont_confirm_kill;            /* do not confirm Kill application */
 366
 367     char disable_miniwindows;
 368
 369     char dont_blink;                   /* do not blink icon selection */
 370
 371     /* Appearance options */
 372     char new_style;                    /* Use newstyle buttons */
 373     char superfluous;                  /* Use superfluous things */
 374
 375     /* root window mouse bindings */
 376     char select_button;                /* button for window selection */
 377     char windowl_button;               /* button for window list menu */
 378     char menu_button;                  /* button for app menu */
 379
 380     /* balloon text */
 381     char window_balloon;
 382     char miniwin_balloon;
 383     char appicon_balloon;
 384     char help_balloon;
 385
 386 #ifdef WEENDOZE_CYCLE
 387     char windoze_cycling;              /* Windoze 95 style Alt+Tabbing */
 388     char popup_switchmenu;             /* Popup the switchmenu when Alt+Tabbing */
 389 #endif /* WEENDOZE_CYCLE */
 390     /* some constants */
 391     int dblclick_time;                 /* double click delay time in ms */
 392
 393     /* animate menus */
 394     char menu_scroll_speed;            /* how fast menus are scrolled */
 395
 396     /* animate icon sliding */
 397     char icon_slide_speed;             /* icon slide animation speed */
 398
 399     /* shading animation */
 400     char shade_speed;
 401
 402     int edge_resistance;
 403     char attract;
 404
 405     struct {
 406         unsigned int nodock:1;         /* don't display the dock */
 407         unsigned int noclip:1;        /* don't display the clip */
 408         unsigned int nocpp:1;          /* don't use cpp */
 409         unsigned int noupdates:1;      /* don't require ~/GNUstep (-static) */
 410     } flags;                           /* internal flags */
 411 } WPreferences;
 412
 413
 414
 415 /****** Global Variables  ******/
 416 extern Display  *dpy;
 417 extern char *ProgName;
 418 extern unsigned int ValidModMask;
 419 extern char WProgramState;
 420
 421 /****** Global Functions ******/
 422 extern void wAbort(Bool dumpCore);
 423
 424 #endif