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_SELECT     7
 131 #define WCUR_ROOT       8
 132 #define WCUR_LAST       9
 133
 134 /* geometry displays */
 135 #define WDIS_NEW        0              /* new style */
 136 #define WDIS_CENTER     1              /* center of screen */
 137 #define WDIS_TOPLEFT    2              /* top left corner of screen */
 138 #define WDIS_FRAME_CENTER 3            /* center of the frame */
 139
 140
 141 /* keyboard input focus mode */
 142 #define WKF_CLICK       0
 143 #define WKF_POINTER     1
 144 #define WKF_SLOPPY      2
 145
 146 /* window placement mode */
 147 #define WPM_MANUAL      0
 148 #define WPM_CASCADE     1
 149 #define WPM_SMART       2
 150 #define WPM_RANDOM      3
 151 #define WPM_AUTO        4
 152
 153 /* text justification */
 154 #define WTJ_CENTER      0
 155 #define WTJ_LEFT        1
 156 #define WTJ_RIGHT       2
 157
 158 /* iconification styles */
 159 #define WIS_ZOOM        0
 160 #define WIS_TWIST       1
 161 #define WIS_FLIP        2
 162 #define WIS_NONE        3
 163 #define WIS_RANDOM      4 /* secret */
 164
 165 /* switchmenu actions */
 166 #define ACTION_ADD      0
 167 #define ACTION_REMOVE   1
 168 #define ACTION_CHANGE   2
 169 #define ACTION_CHANGE_WORKSPACE 3
 170 #define ACTION_CHANGE_STATE     4
 171
 172
 173 /* speeds */
 174 #define SPEED_ULTRAFAST 0
 175 #define SPEED_FAST      1
 176 #define SPEED_MEDIUM    2
 177 #define SPEED_SLOW      3
 178 #define SPEED_ULTRASLOW 4
 179
 180
 181 /* window states */
 182 #define WS_FOCUSED      0
 183 #define WS_UNFOCUSED    1
 184 #define WS_PFOCUSED     2
 185
 186 /* clip title colors */
 187 #define CLIP_NORMAL    0
 188 #define CLIP_COLLAPSED 1
 189
 190
 191 /* icon yard position */
 192 #define IY_VERT         1
 193 #define IY_HORIZ        0
 194 #define IY_TOP          2
 195 #define IY_BOTTOM       0
 196 #define IY_RIGHT        4
 197 #define IY_LEFT         0
 198
 199
 200 /* menu styles */
 201 #define MS_NORMAL               0
 202 #define MS_SINGLE_TEXTURE       1
 203 #define MS_FLAT                 2
 204
 205
 206 /* workspace display position */
 207 #define WD_NONE         0
 208 #define WD_CENTER       1
 209 #define WD_TOP          2
 210 #define WD_BOTTOM       3
 211 #define WD_TOPLEFT      4
 212 #define WD_TOPRIGHT     5
 213 #define WD_BOTTOMLEFT   6
 214 #define WD_BOTTOMRIGHT  7
 215
 216
 217 /* program states */
 218 #define WSTATE_NORMAL           0
 219 #define WSTATE_NEED_EXIT        1
 220 #define WSTATE_NEED_RESTART     2
 221 #define WSTATE_EXITING          3
 222 #define WSTATE_RESTARTING       4
 223 #define WSTATE_MODAL            5
 224
 225
 226 #define WCHECK_STATE(state)     (state == WProgramState)
 227 #define WCHANGE_STATE(nstate)   \
 228         if (WProgramState == WSTATE_NORMAL\
 229                 || nstate != WSTATE_MODAL)\
 230                  WProgramState = (nstate)
 231
 232
 233 /* notifications */
 234
 235 #ifdef MAINFILE
 236 #define NOTIFICATION(n) char *WN##n = #n
 237 #else
 238 #define NOTIFICATION(n) extern char *WN##n
 239 #endif
 240
 241 NOTIFICATION(WindowAppearanceSettingsChanged);
 242
 243 NOTIFICATION(IconAppearanceSettingsChanged);
 244
 245 NOTIFICATION(IconTileSettingsChanged);
 246
 247 NOTIFICATION(MenuAppearanceSettingsChanged);
 248
 249 NOTIFICATION(MenuTitleAppearanceSettingsChanged);
 250
 251
 252 /* appearance settings clientdata flags */
 253 enum {
 254     WFontSettings = 1 << 0,
 255         WTextureSettings = 1 << 1,
 256         WColorSettings = 1 << 2
 257 };
 258
 259
 260
 261 typedef struct {
 262     int x1, y1;
 263     int x2, y2;
 264 } WArea;
 265
 266 typedef struct WCoord {
 267     int x, y;
 268 } WCoord;
 269
 270 typedef struct WPreferences {
 271     char *pixmap_path;                 /* : separate list of */
 272                                        /* paths to find pixmaps */
 273     char *icon_path;                   /* : separated list of */
 274                                        /* paths to find icons */
 275
 276     char *logger_shell;                /* shell to log child stdi/o */
 277
 278     RImage *button_images;             /* titlebar button images */
 279
 280     char smooth_workspace_back;
 281     signed char size_display;                  /* display type for resize geometry */
 282     signed char move_display;                  /* display type for move geometry */
 283     signed char window_placement;              /* window placement mode */
 284     signed char colormap_mode;                 /* colormap focus mode */
 285     signed char focus_mode;                    /* window focusing mode */
 286
 287     char opaque_move;                  /* update window position during */
 288                                        /* move */
 289
 290     char wrap_menus;                   /* wrap menus at edge of screen */
 291     char scrollable_menus;             /* let them be scrolled */
 292     char align_menus;                  /* align menu with their parents */
 293
 294     char use_saveunders;               /* turn on SaveUnders for menus,
 295                                         * icons etc. */
 296     char no_window_over_dock;
 297
 298     char no_window_over_icons;
 299
 300     WCoord window_place_origin;        /* Offset for windows placed on
 301                                         * screen */
 302
 303     char constrain_window_size;        /* don't let windows get bigger than
 304                                         * screen */
 305
 306     char circ_raise;                   /* raise window after Alt-tabbing */
 307
 308     char ignore_focus_click;
 309
 310     char open_transients_with_parent;  /* open transient window in
 311                                         same workspace as parent */
 312     signed char title_justification;           /* titlebar text alignment */
 313
 314     int window_title_clearance;
 315     int menu_title_clearance;
 316     int menu_text_clearance;
 317
 318     char multi_byte_text;
 319 #ifdef KEEP_XKB_LOCK_STATUS
 320     char modelock;
 321 #endif
 322
 323     char no_dithering;                 /* use dithering or not */
 324
 325     char no_sound;                     /* enable/disable sound */
 326     char no_animations;                /* enable/disable animations */
 327
 328     char no_autowrap;                  /* wrap workspace when window is moved
 329                                         * to the edge */
 330
 331     char auto_arrange_icons;           /* automagically arrange icons */
 332
 333     char icon_box_position;            /* position to place icons */
 334
 335     signed char iconification_style;          /* position to place icons */
 336
 337     char disable_root_mouse;           /* disable button events in root window */
 338
 339     char auto_focus;                   /* focus window when it's mapped */
 340
 341
 342     char *icon_back_file;              /* background image for icons */
 343
 344     WCoord *root_menu_pos;             /* initial position of the root menu*/
 345     WCoord *app_menu_pos;
 346
 347     WCoord *win_menu_pos;
 348
 349     signed char icon_yard;                     /* aka iconbox */
 350
 351     int raise_delay;                   /* delay for autoraise. 0 is disabled */
 352
 353     int cmap_size;                     /* size of dithering colormap in colors
 354                                         * per channel */
 355
 356     int icon_size;                     /* size of the icon */
 357
 358     signed char menu_style;            /* menu decoration style */
 359
 360     signed char workspace_name_display_position;
 361
 362     unsigned int modifier_mask;        /* mask to use as kbd modifier */
 363
 364
 365     char ws_advance;                   /* Create new workspace and advance */
 366
 367 #ifdef VIRTUAL_DESKTOP
 368     unsigned int vedge_thickness;
 369     unsigned int vedge_hscrollspeed;
 370     unsigned int vedge_vscrollspeed;
 371     unsigned int vedge_height; /* could be change to workspace specific one day */
 372     unsigned int vedge_width;
 373 #endif
 374
 375     char ws_cycle;                     /* Cycle existing workspaces */
 376
 377     char save_session_on_exit;         /* automatically save session on exit */
 378
 379     char sticky_icons;                 /* If miniwindows will be onmipresent */
 380
 381     char dont_confirm_kill;            /* do not confirm Kill application */
 382
 383     char disable_miniwindows;
 384
 385     char dont_blink;                   /* do not blink icon selection */
 386
 387     /* Appearance options */
 388     char new_style;                    /* Use newstyle buttons */
 389     char superfluous;                  /* Use superfluous things */
 390
 391     /* root window mouse bindings */
 392     signed char select_button;                 /* button for window selection */
 393     signed char windowl_button;        /* button for window list menu */
 394     signed char menu_button;                   /* button for app menu */
 395
 396     /* balloon text */
 397     char window_balloon;
 398     char miniwin_balloon;
 399     char appicon_balloon;
 400     char help_balloon;
 401
 402     /* some constants */
 403     int dblclick_time;                 /* double click delay time in ms */
 404
 405     /* animate menus */
 406     signed char menu_scroll_speed;             /* how fast menus are scrolled */
 407
 408     /* animate icon sliding */
 409     signed char icon_slide_speed;              /* icon slide animation speed */
 410
 411     /* shading animation */
 412     signed char shade_speed;
 413
 414     int edge_resistance;
 415     char attract;
 416
 417     struct {
 418         unsigned int nodock:1;         /* don't display the dock */
 419         unsigned int noclip:1;        /* don't display the clip */
 420         unsigned int nocpp:1;          /* don't use cpp */
 421         unsigned int noupdates:1;      /* don't require ~/GNUstep (-static) */
 422         unsigned int noautolaunch:1;   /* don't autolaunch apps */
 423     } flags;                           /* internal flags */
 424 } WPreferences;
 425
 426
 427
 428 /****** Global Variables  ******/
 429 extern Display  *dpy;
 430 extern char *ProgName;
 431 extern unsigned int ValidModMask;
 432 extern char WProgramState;
 433
 434 /****** Global Functions ******/
 435 extern void wAbort(Bool dumpCore);
 436
 437 #endif