ScummVM API documentation
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_GUI_H
23#define AGS_ENGINE_AC_GUI_H
24
25#include "ags/engine/ac/dynobj/script_gui.h"
26#include "ags/shared/gui/gui_main.h"
27
28namespace AGS3 {
29
30using AGS::Shared::GUIMain;
31using AGS::Shared::GUIObject;
32
33ScriptGUI *GUI_AsTextWindow(ScriptGUI *tehgui);
34int GUI_GetPopupStyle(ScriptGUI *tehgui);
35void GUI_SetVisible(ScriptGUI *tehgui, int isvisible);
36int GUI_GetVisible(ScriptGUI *tehgui);
37int GUI_GetX(ScriptGUI *tehgui);
38void GUI_SetX(ScriptGUI *tehgui, int xx);
39int GUI_GetY(ScriptGUI *tehgui);
40void GUI_SetY(ScriptGUI *tehgui, int yy);
41void GUI_SetPosition(ScriptGUI *tehgui, int xx, int yy);
42void GUI_SetSize(ScriptGUI *sgui, int widd, int hitt);
43int GUI_GetWidth(ScriptGUI *sgui);
44int GUI_GetHeight(ScriptGUI *sgui);
45void GUI_SetWidth(ScriptGUI *sgui, int newwid);
46void GUI_SetHeight(ScriptGUI *sgui, int newhit);
47void GUI_SetZOrder(ScriptGUI *tehgui, int z);
48int GUI_GetZOrder(ScriptGUI *tehgui);
49void GUI_SetClickable(ScriptGUI *tehgui, int clickable);
50int GUI_GetClickable(ScriptGUI *tehgui);
51int GUI_GetID(ScriptGUI *tehgui);
52GUIObject *GUI_GetiControls(ScriptGUI *tehgui, int idx);
53int GUI_GetControlCount(ScriptGUI *tehgui);
54void GUI_SetPopupYPos(ScriptGUI *tehgui, int newpos);
55int GUI_GetPopupYPos(ScriptGUI *tehgui);
56void GUI_SetTransparency(ScriptGUI *tehgui, int trans);
57int GUI_GetTransparency(ScriptGUI *tehgui);
58void GUI_Centre(ScriptGUI *sgui);
59void GUI_SetBackgroundGraphic(ScriptGUI *tehgui, int slotn);
60int GUI_GetBackgroundGraphic(ScriptGUI *tehgui);
61void GUI_SetBackgroundColor(ScriptGUI *tehgui, int newcol);
62int GUI_GetBackgroundColor(ScriptGUI *tehgui);
63void GUI_SetBorderColor(ScriptGUI *tehgui, int newcol);
64int GUI_GetBorderColor(ScriptGUI *tehgui);
65void GUI_SetTextColor(ScriptGUI *tehgui, int newcol);
66int GUI_GetTextColor(ScriptGUI *tehgui);
67void GUI_SetTextPadding(ScriptGUI *tehgui, int newpos);
68int GUI_GetTextPadding(ScriptGUI *tehgui);
69ScriptGUI *GetGUIAtLocation(int xx, int yy);
70
71void remove_popup_interface(int ifacenum);
72void process_interface_click(int ifce, int btn, int mbut);
73void replace_macro_tokens(const char *text, AGS::Shared::String &fixed_text);
74void update_gui_zorder();
75void export_gui_controls(int ee);
76void unexport_gui_controls(int ee);
77void update_gui_disabled_status();
78int adjust_x_for_guis(int x, int y, bool assume_blocking = false);
79int adjust_y_for_guis(int y, bool assume_blocking = false);
80
81int gui_get_interactable(int x, int y);
82int gui_on_mouse_move(const int mx, const int my);
83void gui_on_mouse_hold(const int wasongui, const int wasbutdown);
84void gui_on_mouse_up(const int wasongui, const int wasbutdown, const int mx, const int my);
85void gui_on_mouse_down(const int guin, const int mbut, const int mx, const int my);
86
87} // namespace AGS3
88
89#endif