oldXMenu/XMenu.h

   1 #include "copyright.h"
   2
   3 /* Copyright    Massachusetts Institute of Technology    1985   */
   4
   5 /*
   6  * XMenu:       MIT Project Athena, X Window system menu package
   7  *
   8  *      XMenu.h -       Include file for the MIT Project Athena
   9  *                      XMenu X window system menu package.
  10  *
  11  *      Author:         Tony Della Fera, DEC
  12  *                      August, 1984
  13  */
  14
  15 #ifndef _XMenu_h_
  16 #define _XMenu_h_
  17
  18 #include <X11/Xutil.h>
  19 #include "X10.h"
  20
  21 #define FAILURE                 -1
  22 #define SUCCESS                 1
  23 #define POST_ERROR              -1
  24 #define NO_SELECTION            -1
  25
  26 #define XM_FAILURE              -1
  27 #define XM_SUCCESS              1
  28 #define XM_NO_SELECT            2
  29 #define XM_IA_SELECT            3
  30
  31 #define XME_CODE_COUNT          17
  32
  33 #define XME_NO_ERROR            0
  34 #define XME_NOT_INIT            1
  35 #define XME_ARG_BOUNDS          2
  36 #define XME_P_NOT_FOUND         3
  37 #define XME_S_NOT_FOUND         4
  38 #define XME_STYLE_PARAM         5
  39 #define XME_GRAB_MOUSE          6
  40 #define XME_INTERP_LOC          7
  41 #define XME_CALLOC              8
  42 #define XME_CREATE_ASSOC        9
  43 #define XME_STORE_BITMAP        10
  44 #define XME_MAKE_TILES          11
  45 #define XME_MAKE_PIXMAP         12
  46 #define XME_CREATE_CURSOR       13
  47 #define XME_OPEN_FONT           14
  48 #define XME_CREATE_WINDOW       15
  49 #define XME_CREATE_TRANSP       16
  50
  51 /*
  52  * XMenu error code and error list definitions.
  53  */
  54 extern int _XMErrorCode;
  55 extern char *_XMErrorList[];
  56
  57 /*
  58  * Define the XMWindow datatypes.
  59  *
  60  * An XMWindow is either an XMPane or an XMSelect.
  61  *
  62  * XMWindow is wrapper used to identify the constant window
  63  * information that makes up XMPane and XMSelect objects.
  64  *
  65  * An XMPane is a menu pane made up of one or more XMSelect and a label.
  66  *
  67  * An XMSelect is a menu selection object with a label and a data pointer.
  68  */
  69 typedef enum _xmwintype {PANE, SELECTION, PL_HEADER, SL_HEADER, SEPARATOR} XMWType;
  70
  71 typedef struct _xmwindow {
  72     struct _xmwindow *next;     /* Next obj pointer (for emacs_insque). */
  73     struct _xmwindow *prev;     /* Prev obj pointer (for emacs_insque). */
  74     XMWType type;               /* Type of window. */
  75     Window window;              /* X Window Id. */
  76     int window_x;               /* Window upper left X coordinate. */
  77     int window_y;               /* Window upper left y coordinate. */
  78     int window_w;               /* Window width. */
  79     int window_h;               /* Window height. */
  80     int active;                 /* Window active? */
  81     int activated;              /* Window activated? */
  82     int pad_l1;                 /* ---- */
  83     char *pad_l2;               /* ---- */
  84     int pad_l3;                 /* ---- */
  85     int pad_l4;                 /* ---- */
  86     int pad_l5;                 /* ---- */
  87     int pad_l6;                 /* ---- */
  88     int pad_l7;                 /* ---- */
  89     int pad_l8;                 /* ---- */
  90     struct _xmwindow *pad_l9;   /* ---- */
  91     char *pad_l10;              /* ---- */
  92     struct _xmwindow *pad_l11;  /* ---- */
  93 } XMWindow;
  94
  95 typedef struct _xmpane {
  96     struct _xmpane *next;       /* Next obj pointer (for emacs_insque). */
  97     struct _xmpane *prev;       /* Prev obj pointer (for emacs_insque). */
  98     XMWType type;               /* Type of window. */
  99     Window window;              /* X Window Id. */
 100     int window_x;               /* Window upper left X coordinate. */
 101     int window_y;               /* Window upper left y coordinate. */
 102     int window_w;               /* Window width. */
 103     int window_h;               /* Window height. */
 104     int active;                 /* Window active? */
 105     int activated;              /* Window activated? */
 106     int serial;                 /* -- Pane serial number. */
 107     char *label;                /* -- Pane label. */
 108     int label_width;            /* -- Pane label width in pixels. */
 109     int label_length;           /* -- Pane label length in chars. */
 110     int label_x;                /* -- Pane label X offset. */
 111     int label_uy;               /* -- Pane label upper Y offset. */
 112     int label_ly;               /* -- Pane label lower Y offset. */
 113     int s_count;                /* -- Selections in this pane. */
 114     struct _xmselect *s_list;   /* -- Selection  window list. */
 115     char *pad_l10;              /* ---- */
 116     struct _xmwindow *pad_l11;  /* ---- */
 117 } XMPane;
 118
 119 typedef struct _xmselect {
 120     struct _xmselect *next;     /* Next obj pointer (for emacs_insque). */
 121     struct _xmselect *prev;     /* Prev obj pointer (for emacs_insque). */
 122     XMWType type;               /* Type of window. */
 123     Window window;              /* X Window Id. */
 124     Window parent;              /* X Window id of parent window. */
 125     int window_x;               /* Window upper left X coordinate. */
 126     int window_y;               /* Window upper left y coordinate. */
 127     int window_w;               /* Window width. */
 128     int window_h;               /* Window height. */
 129     int active;                 /* Window active? */
 130     int activated;              /* Window activated? */
 131     int serial;                 /* -- Selection serial number. */
 132     char *label;                /* -- Selection label. */
 133     int label_width;            /* -- Selection label width in pixels. */
 134     int label_length;           /* -- Selection label length in chars. */
 135     int label_x;                /* -- Selection label X offset. */
 136     int label_y;                /* -- Selection label Y offset. */
 137     int pad_l7;                 /* ---- */
 138     int pad_l8;                 /* ---- */
 139     struct _xmwindow *pad_l9;   /* ---- */
 140     char *data;                 /* -- Selection data pointer. */
 141     struct _xmpane *parent_p;   /* -- Selection parent pane structure. */
 142     char *help_string;          /* Help string or null.  */
 143 } XMSelect;
 144
 145
 146 /*
 147  * Define the XMStyle datatype.
 148  *
 149  * Menu presentation style information.
 150  *
 151  */
 152 typedef enum _xmstyle {
 153     LEFT,                       /* Left oriented obejct. */
 154     RIGHT,                      /* Right oriented obejct. */
 155     CENTER                      /* Center oriented object. */
 156 } XMStyle;
 157
 158
 159 /*
 160  * Define the XMMode datatype.
 161  *
 162  * Menu presentation mode information.
 163  *
 164  */
 165 typedef enum _xmmode {
 166     BOX,                        /* BOXed graphic rendition. */
 167     INVERT                      /* INVERTed graphic rendition. */
 168 } XMMode;
 169
 170
 171 /*
 172  * Define the XMenu datatype.
 173  *
 174  * All dimensions are in pixels unless otherwise noted.
 175  */
 176 typedef struct _xmenu {
 177     /* -------------------- Menu data -------------------- */
 178     XMStyle menu_style;         /* Menu display style. */
 179     XMMode menu_mode;           /* Menu display mode. */
 180     int freeze;                 /* Freeze server mode? */
 181     int aeq;                    /* Asynchronous Event Queuing mode? */
 182     int recompute;              /* Recompute menu dependencies? */
 183     Window parent;              /* Menu's parent window. */
 184     int width;                  /* Overall menu width. */
 185     int height;                 /* Overall menu height. */
 186     int x_pos;                  /* Oveall menu origin. */
 187     int y_pos;                  /* Overall menu origin. */
 188     Cursor mouse_cursor;        /* Mouse cursor raster. */
 189     XAssocTable *assoc_tab;     /* XMWindow association table. */
 190     XMPane *p_list;             /* List of XMPanes. */
 191     /* -------------------- Pane window data -------------------- */
 192     XMStyle p_style;            /* Pane display style. */
 193     int p_events;               /* Pane window X events. */
 194     XFontStruct *p_fnt_info;    /* Flag font info structure. */
 195     GC pane_GC;                 /* Pane graphics context. */
 196     int p_fnt_pad;              /* Fixed flag font padding in pixels. */
 197     double p_spread;            /* Pane spread in flag height fractions. */
 198     int p_bdr_width;            /* Pane border width. */
 199     int flag_height;            /* Flag height. */
 200     int p_width;                /* Menu pane width. */
 201     int p_height;               /* Menu pane height. */
 202     int p_x_off;                /* Pane window X offset. */
 203     int p_y_off;                /* Pane window Y offset. */
 204     int p_count;                /* Number of panes per menu. */
 205     /* -------------------- Selection window data -------------------- */
 206     XMStyle s_style;            /* Selection display style. */
 207     int s_events;               /* Selection window X events. */
 208     XFontStruct *s_fnt_info;    /* Body font info structure. */
 209     int s_fnt_pad;              /* Fixed body font padding in pixels. */
 210     double s_spread;            /* Select spread in line height fractions. */
 211     int s_bdr_width;            /* Select border width. */
 212     int s_width;                /* Selection window width. */
 213     int s_height;               /* Selection window height. */
 214     int s_x_off;                /* Selection window X offset. */
 215     int s_y_off;                /* Selection window Y offset. */
 216     int s_count;                /* Maximum number of selections per pane. */
 217     GC normal_select_GC;        /* GC used for inactive selections. */
 218     GC inverse_select_GC;       /* GC used for active (current) selection. */
 219     GC inact_GC;                /* GC used for inactive selections and */
 220                                 /* panes headers. */
 221     /* -------------------- Color data -------------------- */
 222     unsigned long p_bdr_color;  /* Color of pane border pixmap. */
 223     unsigned long s_bdr_color;  /* Color of selection border pixmap. */
 224     unsigned long p_frg_color;  /* Color of pane foreground pixmap. */
 225     unsigned long s_frg_color;  /* Color of selection pixmap. */
 226     unsigned long bkgnd_color;  /* Color of menu background pixmap. */
 227     /* -------------------- Pixmap data -------------------- */
 228     Pixmap p_bdr_pixmap;        /* Pane border pixmap. */
 229     Pixmap s_bdr_pixmap;        /* Selection border pixmap. */
 230     Pixmap p_frg_pixmap;        /* Pane foreground pixmap. */
 231     Pixmap s_frg_pixmap;        /* Selection foreground pixmap. */
 232     Pixmap bkgnd_pixmap;        /* Menu background pixmap. */
 233     Pixmap inact_pixmap;        /* Menu inactive pixmap. */
 234 } XMenu;
 235
 236 /*
 237  * XMenu library routine declarations.
 238  */
 239 XMenu *XMenuCreate();
 240 int XMenuAddPane();
 241 int XMenuAddSelection();
 242 int XMenuInsertPane();
 243 int XMenuInsertSelection();
 244 int XMenuFindPane();
 245 int XMenuFindSelection();
 246 int XMenuChangePane();
 247 int XMenuChangeSelection();
 248 int XMenuSetPane();
 249 int XMenuSetSelection();
 250 int XMenuRecompute();
 251 int XMenuEventHandler();        /* No value actually returned. */
 252 int XMenuLocate();
 253 int XMenuSetFreeze();           /* No value actually returned. */
 254 void XMenuActivateSetWaitFunction();
 255 int XMenuActivate();
 256 char *XMenuPost();
 257 int XMenuDeletePane();
 258 int XMenuDeleteSelection();
 259 int XMenuDestroy();             /* No value actually returned. */
 260 char *XMenuError();
 261
 262 #endif
 263 /* Don't add after this point. */
 264
 265 /* arch-tag: 7e57b5ac-9355-4057-9385-afbe6912d60f
 266    (do not change this comment) */