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
 112 #define PRED_BPIXMAPS           4 /* count of WBUT icons */
 113
 114 /* cursors */
 115 #define WCUR_DEFAULT    0
 116 #define WCUR_NORMAL     0
 117 #define WCUR_MOVE       1
 118 #define WCUR_RESIZE     2
 119 #define WCUR_WAIT       3
 120 #define WCUR_ARROW      4
 121 #define WCUR_QUESTION   5
 122 #define WCUR_TEXT       6
 123 #define WCUR_LAST       7
 124
 125
 126 /* geometry displays */
 127 #define WDIS_NEW        0              /* new style */
 128 #define WDIS_CENTER     1              /* center of screen */
 129 #define WDIS_TOPLEFT    2              /* top left corner of screen */
 130 #define WDIS_FRAME_CENTER 3            /* center of the frame */
 131
 132
 133 /* keyboard input focus mode */
 134 #define WKF_CLICK       0
 135 #define WKF_POINTER     1
 136 #define WKF_SLOPPY      2
 137
 138 /* window placement mode */
 139 #define WPM_MANUAL      0
 140 #define WPM_CASCADE     1
 141 #define WPM_SMART       2
 142 #define WPM_RANDOM      3
 143
 144 /* text justification */
 145 #define WTJ_CENTER      0
 146 #define WTJ_LEFT        1
 147 #define WTJ_RIGHT       2
 148
 149 /* iconification styles */
 150 #define WIS_ZOOM        0
 151 #define WIS_TWIST       1
 152 #define WIS_FLIP        2
 153 #define WIS_NONE        3
 154 #define WIS_RANDOM      4 /* secret */
 155
 156 /* switchmenu actions */
 157 #define ACTION_ADD      0
 158 #define ACTION_REMOVE   1
 159 #define ACTION_CHANGE   2
 160 #define ACTION_CHANGE_WORKSPACE 3
 161 #define ACTION_CHANGE_STATE     4
 162
 163
 164 /* speeds */
 165 #define SPEED_ULTRAFAST 0
 166 #define SPEED_FAST      1
 167 #define SPEED_MEDIUM    2
 168 #define SPEED_SLOW      3
 169 #define SPEED_ULTRASLOW 4
 170
 171
 172 /* window states */
 173 #define WS_FOCUSED      0
 174 #define WS_UNFOCUSED    1
 175 #define WS_PFOCUSED     2
 176 #ifdef TITLE_TEXT_SHADOW
 177 #define WS_SMENU       3
 178 #define WS_SFOCUSED    3
 179 #define WS_SUNFOCUSED  4
 180 #define WS_SPFOCUSED   5
 181 #endif /* TITLE_TEXT_SHADOW */
 182
 183 /* clip title colors */
 184 #define CLIP_NORMAL    0
 185 #define CLIP_COLLAPSED 1
 186
 187
 188 /* icon yard position */
 189 #define IY_VERT         1
 190 #define IY_HORIZ        0
 191 #define IY_TOP          2
 192 #define IY_BOTTOM       0
 193 #define IY_RIGHT        4
 194 #define IY_LEFT         0
 195
 196
 197 /* program states */
 198 #define WSTATE_NORMAL           0
 199 #define WSTATE_NEED_EXIT        1
 200 #define WSTATE_NEED_RESTART     2
 201 #define WSTATE_EXITING          3
 202 #define WSTATE_RESTARTING       4
 203 #define WSTATE_MODAL            5
 204
 205
 206 #define WCHECK_STATE(state)     (state == WProgramState)
 207 #define WCHANGE_STATE(nstate)   \
 208         if (WProgramState == WSTATE_NORMAL\
 209                 || nstate != WSTATE_MODAL)\
 210                  WProgramState = (nstate)
 211
 212
 213 typedef struct {
 214     int x1, y1;
 215     int x2, y2;
 216 } WArea;
 217
 218 typedef struct WCoord {
 219     int x, y;
 220 } WCoord;
 221
 222 typedef struct WPreferences {
 223     char *pixmap_path;                 /* : separate list of */
 224                                        /* paths to find pixmaps */
 225     char *icon_path;                   /* : separated list of */
 226                                        /* paths to find icons */
 227
 228     RImage *button_images;             /* titlebar button images */
 229
 230     char size_display;                 /* display type for resize geometry */
 231     char move_display;                 /* display type for move geometry */
 232     char window_placement;             /* window placement mode */
 233     char colormap_mode;                /* colormap focus mode */
 234     char focus_mode;                   /* window focusing mode */
 235
 236     char opaque_move;                  /* update window position during */
 237                                        /* move */
 238
 239     char wrap_menus;                   /* wrap menus at edge of screen */
 240     char scrollable_menus;             /* let them be scrolled */
 241     char align_menus;                  /* align menu with their parents */
 242
 243     char use_saveunders;               /* turn on SaveUnders for menus,
 244                                         * icons etc. */
 245     char no_window_over_dock;
 246
 247     char no_window_over_icons;
 248
 249     WCoord window_place_origin;        /* Offset for windows placed on
 250                                         * screen */
 251
 252     char constrain_window_size;        /* don't let windows get bigger than
 253                                         * screen */
 254
 255     char circ_raise;                   /* raise window when Alt-tabbing */
 256
 257     char ignore_focus_click;
 258
 259     char open_transients_with_parent;  /* open transient window in
 260                                         same workspace as parent */
 261     char title_justification;          /* titlebar text alignment */
 262
 263 #ifdef TITLE_TEXT_SHADOW
 264     char title_shadow;
 265 #endif
 266
 267 #ifdef KEEP_XKB_LOCK_STATUS
 268     char modelock;
 269 #endif
 270
 271     char no_dithering;                 /* use dithering or not */
 272
 273     char no_sound;                     /* enable/disable sound */
 274     char no_animations;                /* enable/disable animations */
 275
 276     char no_autowrap;                  /* wrap workspace when window is moved
 277                                         * to the edge */
 278
 279     char auto_arrange_icons;           /* automagically arrange icons */
 280
 281     char icon_box_position;            /* position to place icons */
 282
 283     char iconification_style;          /* position to place icons */
 284
 285     char disable_root_mouse;           /* disable button events in root window */
 286
 287     char auto_focus;                   /* focus window when it's mapped */
 288
 289     char *icon_back_file;              /* background image for icons */
 290
 291     WCoord *root_menu_pos;             /* initial position of the root menu*/
 292     WCoord *app_menu_pos;
 293
 294     WCoord *win_menu_pos;
 295
 296     char icon_yard;                    /* aka iconbox */
 297
 298     int raise_delay;                   /* delay for autoraise. 0 is disabled */
 299
 300     int cmap_size;                     /* size of dithering colormap in colors
 301                                         * per channel */
 302
 303     int icon_size;                     /* size of the icon */
 304
 305     char ws_advance;                   /* Create new workspace and advance */
 306
 307     char ws_cycle;                     /* Cycle existing workspaces */
 308
 309
 310     unsigned int modifier_mask;        /* mask to use as kbd modifier */
 311
 312     char save_session_on_exit;         /* automatically save session on exit */
 313
 314     char sticky_icons;                 /* If miniwindows will be onmipresent */
 315
 316     char dont_confirm_kill;            /* do not confirm Kill application */
 317
 318     char disable_miniwindows;
 319
 320     char dont_blink;                   /* do not blink icon selection */
 321
 322     /* Appearance options */
 323     char new_style;                    /* Use newstyle buttons */
 324     char superfluous;                  /* Use superfluous things */
 325
 326     /* root window mouse bindings */
 327     char select_button;                /* button for window selection */
 328     char windowl_button;               /* button for window list menu */
 329     char menu_button;                  /* button for app menu */
 330
 331     /* balloon text */
 332     char window_balloon;
 333     char miniwin_balloon;
 334     char appicon_balloon;
 335 #ifdef WEENDOZE_CYCLE
 336     char windoze_cycling;              /* Windoze 95 style Alt+Tabbing */
 337     char popup_switchmenu;             /* Popup the switchmenu when Alt+Tabbing */
 338 #endif /* WEENDOZE_CYCLE */
 339     /* some constants */
 340     int dblclick_time;                 /* double click delay time in ms */
 341
 342     /* animate menus */
 343     char menu_scroll_speed;            /* how fast menus are scrolled */
 344
 345     /* animate icon sliding */
 346     char icon_slide_speed;             /* icon slide animation speed */
 347
 348     /* shading animation */
 349     char shade_speed;
 350
 351     int edge_resistance;
 352
 353     struct {
 354         unsigned int nodock:1;         /* don't display the dock */
 355         unsigned int noclip:1;        /* don't display the clip */
 356         unsigned int nocpp:1;          /* don't use cpp */
 357         unsigned int noupdates:1;      /* don't require ~/GNUstep (-static) */
 358     } flags;                           /* internal flags */
 359 } WPreferences;
 360
 361
 362
 363 /****** Global Variables  ******/
 364 extern Display  *dpy;
 365 extern char *ProgName;
 366 extern unsigned int ValidModMask;
 367 extern char WProgramState;
 368
 369 /****** Global Functions ******/
 370 extern void wAbort(Bool dumpCore);
 371
 372 #endif