src/ngmx/popup.h

   1 /*
   2  * $Id$
   3  *
   4  *                This source code is part of
   5  *
   6  *                 G   R   O   M   A   C   S
   7  *
   8  *          GROningen MAchine for Chemical Simulations
   9  *
  10  *                        VERSION 3.0
  11  *
  12  * Copyright (c) 1991-2001
  13  * BIOSON Research Institute, Dept. of Biophysical Chemistry
  14  * University of Groningen, The Netherlands
  15  *
  16  * This program is free software; you can redistribute it and/or
  17  * modify it under the terms of the GNU General Public License
  18  * as published by the Free Software Foundation; either version 2
  19  * of the License, or (at your option) any later version.
  20  *
  21  * If you want to redistribute modifications, please consider that
  22  * scientific software is very special. Version control is crucial -
  23  * bugs must be traceable. We will be happy to consider code for
  24  * inclusion in the official distribution, but derived work must not
  25  * be called official GROMACS. Details are found in the README & COPYING
  26  * files - if they are missing, get the official version at www.gromacs.org.
  27  *
  28  * To help us fund GROMACS development, we humbly ask that you cite
  29  * the papers on the package - you can find them in the top README file.
  30  *
  31  * Do check out http://www.gromacs.org , or mail us at gromacs@gromacs.org .
  32  *
  33  * And Hey:
  34  * Giving Russians Opium May Alter Current Situation
  35  */
  36
  37 #ifndef _popup_h
  38 #define _popup_h
  39
  40 static char *SRCID_popup_h = "$Id$";
  41 #ifdef HAVE_IDENT
  42 #ident  "@(#) popup.h 1.3 11/23/92"
  43 #endif /* HAVE_IDENT */
  44 #include "x11.h"
  45 #include "xutil.h"
  46
  47 typedef struct {
  48   Window send_to;       /* Window to send messages to                   */
  49   int    nreturn;       /* Value returned when entry is selected        */
  50   bool   bChecked;      /* Indicate whether menu item is check-marked   */
  51   char   *str;          /* Text for menu entry                          */
  52 } t_mentry;
  53
  54 typedef struct {
  55   t_windata wd;         /* The window struct                            */
  56   t_mentry  *m;         /* The menu entry                               */
  57   Window    Parent;     /* Parent window id                             */
  58 } t_child;
  59
  60 typedef struct {
  61   t_windata wd;         /* The window struct                            */
  62   Window    Parent;     /* The parent of the menu                       */
  63   int       nitem;      /* The number of menu items                     */
  64   t_child   *item;      /* Array of child windows                       */
  65   bool      bGrabbed;   /* Did this menu grab the pointer?              */
  66 } t_menu;
  67
  68 extern t_menu *init_menu(t_x11 *x11,Window Parent,unsigned long fg,unsigned long bg,
  69                          int nent,t_mentry ent[],int ncol);
  70 /* This routine will create a popup menu. It will create a
  71  * a base window, and child windows for all the items.
  72  * If ncol != 0 then ncol columns of items will be created;
  73  * otherwise the routine will try to evenly space the menu, eg. if there
  74  * are 20 items then the menu will be 2x10 entries, depending on the
  75  * string lengths.
  76  * !!!
  77  * !!! Do not destroy the ent structure while using this menu
  78  * !!!
  79  * The routine will create the windows but not map them. That is, this
  80  * routine can be called once at the beginning of a program. When a menu
  81  * has to be shown, call show_menu.
  82  */
  83
  84 extern void show_menu(t_x11 *x11,t_menu *m,int x, int y,bool bGrab);
  85 /* Show the menu in m at (x,y)
  86  * This will popup the menu, and when a button is released in the
  87  * menu send a ClientMessage to the Parent window of the menu
  88  * specifying the selected menu item in xclient.data.l[0].
  89  * bGrab specifies whether or not to grab the pointer.
  90  */
  91
  92 extern void hide_menu(t_x11 *x11,t_menu *m);
  93 /* Unmaps the window for m, hides the window */
  94
  95 extern void check_menu_item(t_menu *m,int nreturn,bool bStatus);
  96 /* Set the bChecked field in the menu item with return code
  97  * nreturn to bStatus. This function must always be called when
  98  * the bChecked flag has to changed.
  99  */
 100
 101 extern void done_menu(t_x11 *x11,t_menu *m);
 102 /* This routine destroys the menu m, and unregisters it with x11 */
 103
 104 extern int menu_width(t_menu *m);
 105 /* Return the width of the window */
 106
 107 extern int menu_height(t_menu *m);
 108 /* Return the height of the window */
 109
 110 #endif  /* _popup_h */