Add missing defines to PKG_CFLAGS
[gromacs.git] / src / ngmx / popup.h
blobd7ad201ca003edbc5d5c9608f4e90d65bc288f09
1 /*
2 * This file is part of the GROMACS molecular simulation package.
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, 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.
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.
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.
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.
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.
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.
39 #ifndef _popup_h
40 #define _popup_h
42 #include "x11.h"
43 #include "xutil.h"
45 typedef struct {
46 Window send_to; /* Window to send messages to */
47 int nreturn; /* Value returned when entry is selected */
48 gmx_bool bChecked; /* Indicate whether menu item is check-marked */
49 const char *str; /* Text for menu entry */
50 } t_mentry;
52 typedef struct {
53 t_windata wd; /* The window struct */
54 t_mentry *m; /* The menu entry */
55 Window Parent; /* Parent window id */
56 } t_child;
58 typedef struct {
59 t_windata wd; /* The window struct */
60 Window Parent; /* The parent of the menu */
61 int nitem; /* The number of menu items */
62 t_child *item; /* Array of child windows */
63 gmx_bool bGrabbed; /* Did this menu grab the pointer? */
64 } t_menu;
66 extern t_menu *init_menu(t_x11 *x11,Window Parent,unsigned long fg,unsigned long bg,
67 int nent,t_mentry ent[],int ncol);
68 /* This routine will create a popup menu. It will create a
69 * a base window, and child windows for all the items.
70 * If ncol != 0 then ncol columns of items will be created;
71 * otherwise the routine will try to evenly space the menu, eg. if there
72 * are 20 items then the menu will be 2x10 entries, depending on the
73 * string lengths.
74 * !!!
75 * !!! Do not destroy the ent structure while using this menu
76 * !!!
77 * The routine will create the windows but not map them. That is, this
78 * routine can be called once at the beginning of a program. When a menu
79 * has to be shown, call show_menu.
82 extern void show_menu(t_x11 *x11,t_menu *m,int x, int y,gmx_bool bGrab);
83 /* Show the menu in m at (x,y)
84 * This will popup the menu, and when a button is released in the
85 * menu send a ClientMessage to the Parent window of the menu
86 * specifying the selected menu item in xclient.data.l[0].
87 * bGrab specifies whether or not to grab the pointer.
90 extern void hide_menu(t_x11 *x11,t_menu *m);
91 /* Unmaps the window for m, hides the window */
93 extern void check_menu_item(t_menu *m,int nreturn,gmx_bool bStatus);
94 /* Set the bChecked field in the menu item with return code
95 * nreturn to bStatus. This function must always be called when
96 * the bChecked flag has to changed.
99 extern void done_menu(t_x11 *x11,t_menu *m);
100 /* This routine destroys the menu m, and unregisters it with x11 */
102 extern int menu_width(t_menu *m);
103 /* Return the width of the window */
105 extern int menu_height(t_menu *m);
106 /* Return the height of the window */
108 #endif /* _popup_h */