ScummVM API documentation
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
global_gui.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 #ifndef AGS_ENGINE_AC_GLOBAL_GUI_H
23 #define AGS_ENGINE_AC_GLOBAL_GUI_H
24 
25 namespace AGS3 {
26 
27 // IsGUIOn tells whether GUI is actually displayed on screen right now
28 int IsGUIOn(int guinum);
29 // This is an internal script function, and is undocumented.
30 // It is used by the editor's automatic macro generation.
31 // TODO: find out how relevant this comment is?
32 int FindGUIID(const char *GUIName);
33 // Sets GUI visible property on
34 void InterfaceOn(int ifn);
35 // Sets GUI visible property off
36 void InterfaceOff(int ifn);
37 void CentreGUI(int ifn);
38 int GetTextWidth(const char *text, int fontnum);
39 int GetTextHeight(const char *text, int fontnum, int width);
40 int GetFontHeight(int fontnum);
41 int GetFontLineSpacing(int fontnum);
42 void SetGUIBackgroundPic(int guin, int slotn);
43 void DisableInterface();
44 void EnableInterface();
45 // Returns 1 if user interface is enabled, 0 if disabled
46 int IsInterfaceEnabled();
47 // pass trans=0 for fully solid, trans=100 for fully transparent
48 void SetGUITransparency(int ifn, int trans);
49 void SetGUIClickable(int guin, int clickable);
50 void SetGUIZOrder(int guin, int z);
51 void SetGUISize(int ifn, int widd, int hitt);
52 void SetGUIPosition(int ifn, int xx, int yy);
53 void SetGUIObjectSize(int ifn, int objn, int newwid, int newhit);
54 void SetGUIObjectEnabled(int guin, int objn, int enabled);
55 void SetGUIObjectPosition(int guin, int objn, int xx, int yy);
56 int GetGUIObjectAt(int xx, int yy);
57 int GetGUIAt(int xx, int yy);
58 void SetTextWindowGUI(int guinum);
59 
60 } // namespace AGS3
61 
62 #endif
AGS3
Definition: ags.h:40