Update instructions in containers.rst
[gromacs.git] / src / programs / view / xutil.h
blob8094ff55a31d010a082d27a59bebbd9285d680af
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 * Copyright (c) 2013,2014,2015,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.
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.
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.
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.
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.
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.
38 #ifndef _xutil_h
39 #define _xutil_h
41 #include <cstdio>
43 /* TODO: This include is needed here, because this header reuses eXPos and
44 * eYPos. It has nothing to do with PostScript output. */
45 #include "gromacs/fileio/writeps.h"
47 #include "Xstuff.h"
48 #include "x11.h"
50 #define OFFS_X 4
51 #define OFFS_Y 4
53 typedef struct
55 Window self, Parent;
56 unsigned long color;
57 char* text;
58 bool bFocus;
59 int x, y, width, height, bwidth;
60 Cursor cursor;
61 } t_windata;
63 extern int CheckWin(Window win, const char* file, int line);
65 #define CheckWindow(win) CheckWin(win, __FILE__, __LINE__)
67 extern void LightBorder(Display* disp, Window win, unsigned long color);
69 extern void SpecialTextInRect(t_x11* x11,
70 XFontStruct* font,
71 Drawable win,
72 const char* s,
73 int x,
74 int y,
75 int width,
76 int height,
77 eXPos eX,
78 eYPos eY);
80 extern void
81 TextInRect(t_x11* x11, Drawable win, const char* s, int x, int y, int width, int height, eXPos eX, eYPos eY);
83 extern void TextInWin(t_x11* x11, t_windata* win, const char* s, eXPos eX, eYPos eY);
85 extern void InitWin(t_windata* win, int x0, int y0, int w, int h, int bw, const char* text);
87 extern void FreeWin(Display* disp, t_windata* win);
89 extern void ExposeWin(Display* disp, Window win);
91 extern void RectWin(Display* disp, GC gc, t_windata* win, unsigned long color);
93 extern void XDrawRoundRect(Display* disp, Window win, GC gc, int x, int y, int w, int h);
95 extern void RoundRectWin(Display* disp, GC gc, t_windata* win, int offsx, int offsy, unsigned long color);
97 extern void PushMouse(Display* disp, Window dest, int x, int y);
99 extern void PopMouse(Display* disp);
101 extern bool HelpPressed(XEvent* event);
103 extern bool GrabOK(FILE* out, int err);
104 /* Return true if grab succeeded, prints a message to out
105 * and returns false otherwise.
108 #endif /* _xutil_h */