Fixing copyright issues and code contributors
[alexxy/gromacs.git] / src / ngmx / 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  * check out http://www.gromacs.org for more information.
7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
9  * others, as listed in the AUTHORS file in the top-level source
10  * directory and at http://www.gromacs.org.
11  *
12  * GROMACS is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU Lesser General Public License
14  * as published by the Free Software Foundation; either version 2.1
15  * of the License, or (at your option) any later version.
16  *
17  * GROMACS is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20  * Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with GROMACS; if not, see
24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
26  *
27  * If you want to redistribute modifications to GROMACS, please
28  * consider that scientific software is very special. Version
29  * control is crucial - bugs must be traceable. We will be happy to
30  * consider code for inclusion in the official distribution, but
31  * derived work must not be called official GROMACS. Details are found
32  * in the README & COPYING files - if they are missing, get the
33  * official version at http://www.gromacs.org.
34  *
35  * To help us fund GROMACS development, we humbly ask that you cite
36  * the research papers on the package. Check out http://www.gromacs.org.
37  */
38
39 #ifndef _pulldown_h
40 #define _pulldown_h
41
42 #include "popup.h"
43
44 typedef struct {
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,Window Parent,int width,int height,
54                            unsigned long fg,unsigned long bg,
55                            int nmenu,int *nsub,t_mentry *ent[],
56                            const char **title);
57 /* nmenu is the number of submenus, title are the titles of
58  * the submenus, nsub are the numbers of entries in each submenu
59  * ent are the entries in the pulldown menu, analogous to these in the
60  * popup menu.
61  * The Parent is the parent window, the width is the width of the parent
62  * window. The Menu is constructed as a bar on the topside of the window
63  * (as usual). It calculates it own height by the font size.
64  * !!!
65  * !!! Do not destroy the ent structure, or the titles, while using
66  * !!! the menu.
67  * !!!
68  * When the menu is selected, a ClientMessage will be sent to the Parent
69  * specifying the selected item in xclient.data.l[0].
70  */
71
72 extern void hide_pd(t_x11 *x11,t_pulldown *pd);
73 /* Hides any menu that is still on the screen when it shouldn't */
74
75 extern void check_pd_item(t_pulldown *pd,int nreturn,gmx_bool bStatus);
76 /* Set the bChecked field in the pd item with return code
77  * nreturn to bStatus. This function must always be called when
78  * the bChecked flag has to changed.
79  */
80
81 extern void done_pd(t_x11 *x11,t_pulldown *pd);
82 /* This routine destroys the menu pd, and unregisters it with x11 */
83
84 extern int pd_width(t_pulldown *pd);
85 /* Return the width of the window */
86
87 extern int pd_height(t_pulldown *pd);
88 /* Return the height of the window */
89
90 #endif  /* _pulldown_h */