src/programs/view/popup.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37
  38 #ifndef _popup_h
  39 #define _popup_h
  40
  41 #include "x11.h"
  42 #include "xutil.h"
  43
  44 typedef struct {
  45     Window      send_to;  /* Window to send messages to                 */
  46     int         nreturn;  /* Value returned when entry is selected  */
  47     bool        bChecked; /* Indicate whether menu item is check-marked */
  48     const char *str;      /* Text for menu entry                                */
  49 } t_mentry;
  50
  51 typedef struct {
  52     t_windata  wd;     /* The window struct                             */
  53     t_mentry  *m;      /* The menu entry                                */
  54     Window     Parent; /* Parent window id                              */
  55 } t_child;
  56
  57 typedef struct {
  58     t_windata     wd;       /* The window struct                */
  59     Window        Parent;   /* The parent of the menu                   */
  60     int           nitem;    /* The number of menu items                 */
  61     t_child      *item;     /* Array of child windows                   */
  62     bool          bGrabbed; /* Did this menu grab the pointer?              */
  63 } t_menu;
  64
  65 extern t_menu *init_menu(t_x11 *x11, Window Parent, unsigned long fg, unsigned long bg,
  66                          int nent, t_mentry ent[], int ncol);
  67 /* This routine will create a popup menu. It will create a
  68  * a base window, and child windows for all the items.
  69  * If ncol != 0 then ncol columns of items will be created;
  70  * otherwise the routine will try to evenly space the menu, eg. if there
  71  * are 20 items then the menu will be 2x10 entries, depending on the
  72  * string lengths.
  73  * !!!
  74  * !!! Do not destroy the ent structure while using this menu
  75  * !!!
  76  * The routine will create the windows but not map them. That is, this
  77  * routine can be called once at the beginning of a program. When a menu
  78  * has to be shown, call show_menu.
  79  */
  80
  81 extern void show_menu(t_x11 *x11, t_menu *m, int x, int y, bool bGrab);
  82 /* Show the menu in m at (x,y)
  83  * This will popup the menu, and when a button is released in the
  84  * menu send a ClientMessage to the Parent window of the menu
  85  * specifying the selected menu item in xclient.data.l[0].
  86  * bGrab specifies whether or not to grab the pointer.
  87  */
  88
  89 extern void hide_menu(t_x11 *x11, t_menu *m);
  90 /* Unmaps the window for m, hides the window */
  91
  92 extern void check_menu_item(t_menu *m, int nreturn, bool bStatus);
  93 /* Set the bChecked field in the menu item with return code
  94  * nreturn to bStatus. This function must always be called when
  95  * the bChecked flag has to changed.
  96  */
  97
  98 extern void done_menu(t_x11 *x11, t_menu *m);
  99 /* This routine destroys the menu m, and unregisters it with x11 */
 100
 101 extern int menu_width(t_menu *m);
 102 /* Return the width of the window */
 103
 104 extern int menu_height(t_menu *m);
 105 /* Return the height of the window */
 106
 107 #endif  /* _popup_h */