src/programs/view/pulldown.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,2019, 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 _pulldown_h
  39 #define _pulldown_h
  40
  41 #include "popup.h"
  42
  43 typedef struct
  44 {
  45     t_windata    wd;
  46     int          nmenu;
  47     int          nsel;
  48     int*         xpos;
  49     t_menu**     m;
  50     const char** title;
  51 } t_pulldown;
  52
  53 extern t_pulldown* init_pd(t_x11*        x11,
  54                            Window        Parent,
  55                            int           width,
  56                            unsigned long fg,
  57                            unsigned long bg,
  58                            int           nmenu,
  59                            int*          nsub,
  60                            t_mentry*     ent[],
  61                            const char**  title);
  62 /* nmenu is the number of submenus, title are the titles of
  63  * the submenus, nsub are the numbers of entries in each submenu
  64  * ent are the entries in the pulldown menu, analogous to these in the
  65  * popup menu.
  66  * The Parent is the parent window, the width is the width of the parent
  67  * window. The Menu is constructed as a bar on the topside of the window
  68  * (as usual). It calculates it own height by the font size.
  69  * !!!
  70  * !!! Do not destroy the ent structure, or the titles, while using
  71  * !!! the menu.
  72  * !!!
  73  * When the menu is selected, a ClientMessage will be sent to the Parent
  74  * specifying the selected item in xclient.data.l[0].
  75  */
  76
  77 extern void hide_pd(t_x11* x11, t_pulldown* pd);
  78 /* Hides any menu that is still on the screen when it shouldn't */
  79
  80 extern void check_pd_item(t_pulldown* pd, int nreturn, bool bStatus);
  81 /* Set the bChecked field in the pd item with return code
  82  * nreturn to bStatus. This function must always be called when
  83  * the bChecked flag has to changed.
  84  */
  85
  86 extern void done_pd(t_x11* x11, t_pulldown* pd);
  87 /* This routine destroys the menu pd, and unregisters it with x11 */
  88
  89 extern int pd_width(t_pulldown* pd);
  90 /* Return the width of the window */
  91
  92 extern int pd_height(t_pulldown* pd);
  93 /* Return the height of the window */
  94
  95 #endif /* _pulldown_h */