#include "ui_main.h"
#include "ui_internal.h"
#include "ui_input.h"
#include "ui_node.h"
#include "ui_popup.h"
#include "node/ui_node_abstractnode.h"
#include "node/ui_node_window.h"
#include "node/ui_node_battlescape.h"
#include "../cl_video.h"
#include "../input/cl_input.h"
#include "../input/cl_keys.h"

Include dependency graph for ui_windows.cpp:

Macros
#define	WINDOWEXTRADATA(node)
#define	WINDOWEXTRADATACONST(node)

Functions
int	UI_GetLastFullScreenWindow (void)
	Returns the ID of the last fullscreen ID. Before this, window should be hidden.
void	UI_MoveWindowOnTop (uiNode_t *window)
	Move the window on top of compatible windows. "Compatible" mean non full screen windows, and windows with the same window parent.
static void	UI_DeleteWindowFromStack (uiNode_t *window)
	Remove the window from the window stack.
static int	UI_GetWindowPositionFromStackByName (const char *name)
	Searches the position in the current window stack for a given window id.
static void	UI_InsertWindowIntoStack (uiNode_t *window, int position)
	Insert a window at a position of the stack.
uiNode_t *	UI_PushWindow (const char name, const char parentName, linkedList_t *params)
	Push a window onto the window stack.
int	UI_CompleteWithWindow (const char partial, const char *match)
	Complete function for ui_push.
static void	UI_PushChildWindow_f (void)
	Console function to push a child window onto the window stack.
static void	UI_PushWindow_f (void)
	Console function to push a window onto the window stack.
static void	UI_PushDropDownWindow_f (void)
	Console function to push a dropdown window at a position. It work like UI_PushWindow but move the window at the right position.
static void	UI_RemoveWindowAtPositionFromStack (int position)
static void	UI_CloseAllWindow (void)
void	UI_InitStack (const char activeWindow, const char mainWindow)
	Init the stack to start with a window, and have an alternative window with ESC.
bool	UI_IsWindowOnStack (const char *name)
	Check if a named window is on the stack if active windows.
static void	UI_CloseWindowByRef (uiNode_t *window)
void	UI_CloseWindow (const char *name)
void	UI_PopWindow (bool all)
	Pops a window from the window stack.
static void	UI_CloseWindow_f (void)
	Console function to close a named window.
void	UI_PopWindowWithEscKey (void)
static void	UI_PopWindow_f (void)
	Console function to pop a window from the window stack.
uiNode_t *	UI_GetActiveWindow (void)
	Returns the current active window from the window stack or nullptr if there is none.
const char *	UI_GetActiveWindowName (void)
	Returns the name of the current window.
bool	UI_IsMouseOnWindow (void)
	Check if a point is over a window from the stack.
uiNode_t *	UI_GetWindow (const char *name)
	Searches all windows for the specified one.
void	UI_InvalidateStack (void)
	Invalidate all windows of the current stack.
void	UI_SetNewWindowPos (uiNode_t *window, int x, int y)
	Sets new x and y coordinates for a given window.
void	UI_InsertWindow (uiNode_t *window)
	Add a new window to the list of all windows.
void	UI_RemoveWindow (uiNode_t *window)
	Removes a window from the list of all windows.
void	UI_FinishWindowsInit (void)
	Finish windows initialization.
static void	UI_InitStack_f (void)
static void	UI_DebugTree (const uiNode_t *node, int depth)
	Display in the conde the tree of nodes.
static void	UI_DebugTree_f (void)
static void	UI_Popup_f (void)
static void	UI_DebugListWindows_f (void)
	Debug function to list all UI windows.
void	UI_InitWindows (void)

Variables
static cvar_t *	ui_sys_main
	Window name use as alternative for option.
static cvar_t *	ui_sys_active
	Main window of a stack.

Macro Definition Documentation

◆ WINDOWEXTRADATA

#define WINDOWEXTRADATA ( node )

Value:

UI_EXTRADATA(node, windowExtraData_t)

windowExtraData_t

extradata for the window node

Definition ui_node_window.h:63

UI_EXTRADATA

#define UI_EXTRADATA(NODE, TYPE)

Definition ui_nodes.h:185

Definition at line 38 of file ui_windows.cpp.

Referenced by UI_CloseAllWindow(), UI_CloseWindowByRef(), UI_FinishWindowsInit(), UI_IsMouseOnWindow(), UI_MoveWindowOnTop(), UI_PopWindow(), and UI_PushWindow().

◆ WINDOWEXTRADATACONST

#define WINDOWEXTRADATACONST ( node )

Value:

UI_EXTRADATACONST(node, windowExtraData_t)

UI_EXTRADATACONST

#define UI_EXTRADATACONST(NODE, TYPE)

Definition ui_nodes.h:187

Definition at line 39 of file ui_windows.cpp.

Referenced by UI_PopWindowWithEscKey().

Function Documentation

◆ UI_CloseAllWindow()

void UI_CloseAllWindow ( void )

static

Definition at line 332 of file ui_windows.cpp.

References i, ui_global, UI_Node_WindowClosed(), and WINDOWEXTRADATA.

Referenced by UI_PopWindow().

◆ UI_CloseWindow()

void UI_CloseWindow ( const char * name )

Definition at line 435 of file ui_windows.cpp.

References Com_Printf(), name, UI_CloseWindowByRef(), and UI_GetWindow().

Referenced by CL_BattlescapeRadarClose_f(), CL_GetTipOfTheDay_f(), CL_HudRadarUp_f(), and UI_CloseWindow_f().

◆ UI_CloseWindow_f()

void UI_CloseWindow_f ( void )

static

Console function to close a named window.

See also: UI_PushWindow

Definition at line 473 of file ui_windows.cpp.

References Cmd_Argc(), Cmd_Argv(), Com_Printf(), and UI_CloseWindow().

Referenced by UI_InitWindows().

◆ UI_CloseWindowByRef()

void UI_CloseWindowByRef ( uiNode_t * window )

static

Todo: Find better name

Todo: If the focus is not on the window we close, we don't need to remove it

Definition at line 381 of file ui_windows.cpp.

References Com_Printf(), i, m, uiNode_t::name, Q_streq, UI_GetActiveWindow(), UI_GetWindowPositionFromStackByName(), ui_global, UI_InvalidateMouse(), UI_Node_WindowActivate(), UI_Node_WindowClosed(), UI_PushWindow(), UI_ReleaseInput(), UI_RemoveWindowAtPositionFromStack(), ui_sys_active, ui_sys_main, and WINDOWEXTRADATA.

Referenced by UI_CloseWindow(), and UI_PopWindow().

◆ UI_CompleteWithWindow()

int UI_CompleteWithWindow	(	const char *	partial,
		const char **	match )

Complete function for ui_push.

See also: Cmd_AddParamCompleteFunction; UI_PushWindow

Note: Does not really complete the input - but shows at least all parsed windows

Definition at line 211 of file ui_windows.cpp.

References Cmd_GenericCompleteFunction(), Com_Printf(), i, name, and ui_global.

Referenced by UI_InitWindows(), and UI_RegisterEditorNode().

◆ UI_DebugListWindows_f()

void UI_DebugListWindows_f ( void )

static

Debug function to list all UI windows.

Definition at line 739 of file ui_windows.cpp.

References Com_Printf(), i, uiNode_t::name, and ui_global.

Referenced by UI_InitWindows().

◆ UI_DebugTree()

void UI_DebugTree	(	const uiNode_t *	node,
		int	depth )

static

Display in the conde the tree of nodes.

Definition at line 693 of file ui_windows.cpp.

References Com_Printf(), uiNode_t::firstChild, i, uiNode_t::name, uiNode_t::next, UI_DebugTree(), and UI_Node_GetWidgetName().

Referenced by UI_DebugTree(), and UI_DebugTree_f().

◆ UI_DebugTree_f()

void UI_DebugTree_f ( void )

static

Definition at line 707 of file ui_windows.cpp.

References Cmd_Argc(), Cmd_Argv(), Com_Printf(), UI_DebugTree(), and UI_GetWindow().

Referenced by UI_InitWindows().

◆ UI_DeleteWindowFromStack()

void UI_DeleteWindowFromStack ( uiNode_t * window )

static

Remove the window from the window stack.

Parameters

[in] window The window to remove from the stack

Todo: Why dont we call onClose?

Definition at line 110 of file ui_windows.cpp.

References i, ui_global, and UI_InvalidateMouse().

Referenced by UI_PushWindow().

◆ UI_FinishWindowsInit()

void UI_FinishWindowsInit ( void )

Finish windows initialization.

Note: private function

Definition at line 665 of file ui_windows.cpp.

References i, UI_ExecuteEventActions(), ui_global, and WINDOWEXTRADATA.

Referenced by UI_FinishInit().

◆ UI_GetActiveWindow()

uiNode_t * UI_GetActiveWindow ( void )

Returns the current active window from the window stack or nullptr if there is none.

Returns: uiNode_t pointer from window stack

See also: UI_GetWindow

Definition at line 516 of file ui_windows.cpp.

References ui_global.

Referenced by Irc_Client_CmdPrivmsg(), UI_CloseWindowByRef(), UI_DisplayNotice(), and UI_GetActiveWindowName().

◆ UI_GetActiveWindowName()

const char * UI_GetActiveWindowName ( void )

Returns the name of the current window.

Returns: Active window name, else empty string

See also: UI_GetActiveWIndow

Definition at line 526 of file ui_windows.cpp.

References uiNode_t::name, and UI_GetActiveWindow().

Referenced by GAME_GetImportData(), GAME_SetMode_f(), HUD_UpdateButtons(), Irc_AppendToBuffer(), and Irc_Client_CmdPrivmsg().

◆ UI_GetLastFullScreenWindow()

int UI_GetLastFullScreenWindow ( void )

Returns the ID of the last fullscreen ID. Before this, window should be hidden.

Returns: The last full screen window on the screen, else 0. If the stack is empty, return -1

Definition at line 55 of file ui_windows.cpp.

References ui_global, and UI_WindowIsFullScreen().

Referenced by UI_Draw(), UI_FocusNextActionNode(), and UI_KeyPressed().

◆ UI_GetWindow()

uiNode_t * UI_GetWindow ( const char * name )

Searches all windows for the specified one.

Parameters

[in] name Name of the window we search

Returns: The window found, else nullptr

Note: Use dichotomic search

See also: UI_GetActiveWindow

Definition at line 567 of file ui_windows.cpp.

References name, and ui_global.

Referenced by _wrap_get_window(), HUD_CheckCLHud(), UFO_AnalyseTestWindow(), UI_CloseWindow(), UI_CreateWindow(), UI_DebugTree_f(), UI_DisplayNotice(), UI_EditorNodeExtract_f(), UI_ParseWindow(), UI_PopupButton(), UI_PopupList(), UI_PushWindow(), and UI_ReadNodePath().

◆ UI_GetWindowPositionFromStackByName()

int UI_GetWindowPositionFromStackByName ( const char * name )

inlinestatic

Searches the position in the current window stack for a given window id.

Returns: -1 if the window is not on the stack

Definition at line 133 of file ui_windows.cpp.

References i, name, Q_streq, and ui_global.

Referenced by UI_CloseWindowByRef(), UI_IsWindowOnStack(), and UI_PushWindow().

◆ UI_InitStack()

void UI_InitStack	(	const char *	activeWindow,
		const char *	mainWindow )

Init the stack to start with a window, and have an alternative window with ESC.

Note: Illustration about when/how we should use this http://ufoai.org/wiki/index.php/Image:UI_InitStack.jpg

Parameters

[in]	activeWindow	The first active window of the stack, else nullptr
[in]	mainWindow	The alternative window, else nullptr if nothing

Todo

remove Cvar_Set we have direct access to the cvar

We should only call it a very few time. When we switch from/to this different par of the game: main-option-interface / geoscape-and-base / battlescape

Definition at line 354 of file ui_windows.cpp.

References Cvar_Set(), UI_FinishInit(), ui_global, UI_PopWindow(), and UI_PushWindow().

Referenced by GAME_Drop(), GAME_GetImportData(), GAME_SetMode(), HUD_InitUI(), and UI_InitStack_f().

◆ UI_InitStack_f()

void UI_InitStack_f ( void )

static

Definition at line 674 of file ui_windows.cpp.

References Cmd_Argc(), Cmd_Argv(), Com_Printf(), and UI_InitStack().

Referenced by UI_InitWindows().

◆ UI_InitWindows()

void UI_InitWindows ( void )

Definition at line 747 of file ui_windows.cpp.

References Cmd_AddCommand(), Cmd_AddParamCompleteFunction(), Cvar_Get(), UI_CloseWindow_f(), UI_CompleteWithWindow(), UI_DebugListWindows_f(), UI_DebugTree_f(), UI_InitStack_f(), UI_Popup_f(), UI_PopWindow_f(), UI_PushChildWindow_f(), UI_PushDropDownWindow_f(), UI_PushWindow_f(), ui_sys_active, and ui_sys_main.

Referenced by UI_Init().

◆ UI_InsertWindow()

void UI_InsertWindow ( uiNode_t * window )

Add a new window to the list of all windows.

Note: Sort windows by alphabet

Definition at line 616 of file ui_windows.cpp.

References Com_Error(), ERR_FATAL, i, uiNode_t::name, ui_global, and UI_MAX_WINDOWS.

Referenced by UI_CreateWindow(), and UI_ParseWindow().

◆ UI_InsertWindowIntoStack()

void UI_InsertWindowIntoStack	(	uiNode_t *	window,
		int	position )

inlinestatic

Insert a window at a position of the stack.

Parameters

[in]	window	The window to insert
[in]	position	Where we want to add the window (0 is the deeper element of the stack)

Definition at line 147 of file ui_windows.cpp.

References i, and ui_global.

Referenced by UI_PushWindow().

◆ UI_InvalidateStack()

void UI_InvalidateStack ( void )

Invalidate all windows of the current stack.

Definition at line 593 of file ui_windows.cpp.

References Cvar_SetValue(), ui_global, UI_Invalidate(), and viddef.

Referenced by R_SetMode().

◆ UI_IsMouseOnWindow()

bool UI_IsMouseOnWindow ( void )

Check if a point is over a window from the stack.

See also: IN_Parse

Definition at line 538 of file ui_windows.cpp.

References UI_GetHoveredNode(), UI_GetMouseCapture(), ui_global, UI_Node_IsBattleScape(), and WINDOWEXTRADATA.

Referenced by IN_Parse().

◆ UI_IsWindowOnStack()

bool UI_IsWindowOnStack ( const char * name )

Check if a named window is on the stack if active windows.

Definition at line 373 of file ui_windows.cpp.

References name, and UI_GetWindowPositionFromStackByName().

Referenced by GAME_SetMode(), UI_Popup(), UI_PopupButton(), and UI_PopupList().

◆ UI_MoveWindowOnTop()

void UI_MoveWindowOnTop ( uiNode_t * window )

Move the window on top of compatible windows. "Compatible" mean non full screen windows, and windows with the same window parent.

Parameters

window Window we want to move

Definition at line 74 of file ui_windows.cpp.

References i, ui_global, UI_WindowIsFullScreen(), and WINDOWEXTRADATA.

Referenced by UI_MouseDown().

◆ UI_Popup_f()

void UI_Popup_f ( void )

static

Definition at line 724 of file ui_windows.cpp.

References Cmd_Argc(), Cmd_Argv(), Com_Printf(), and UI_Popup().

Referenced by UI_InitWindows().

◆ UI_PopWindow()

void UI_PopWindow ( bool all )

Pops a window from the window stack.

Parameters

[in] all If true pop all windows from stack

See also: UI_PopWindow_f

Definition at line 452 of file ui_windows.cpp.

References key_game, Key_SetDest(), uiNode_t::parent, UI_CloseAllWindow(), UI_CloseWindowByRef(), ui_global, and WINDOWEXTRADATA.

Referenced by _wrap_pop_window(), GAME_GetImportData(), HUD_DisplayActions(), Irc_Input_Activate_f(), UI_InitStack(), UI_LeftClick(), UI_MaterialEditorStart_f(), UI_PopWindow_f(), UI_PopWindowWithEscKey(), uiWindowNode_t_close(), and cgame_import_t::void().

◆ UI_PopWindow_f()

void UI_PopWindow_f ( void )

static

Console function to pop a window from the window stack.

See also: UI_PopWindow

Definition at line 501 of file ui_windows.cpp.

References Cmd_Argc(), Cmd_Argv(), Com_Printf(), and UI_PopWindow().

Referenced by UI_InitWindows().

◆ UI_PopWindowWithEscKey()

void UI_PopWindowWithEscKey ( void )

Definition at line 483 of file ui_windows.cpp.

References ui_global, UI_PopWindow(), and WINDOWEXTRADATACONST.

Referenced by UI_KeyPressed().

◆ UI_PushChildWindow_f()

void UI_PushChildWindow_f ( void )

static

Console function to push a child window onto the window stack.

See also: UI_PushWindow

Definition at line 228 of file ui_windows.cpp.

References Cmd_Argc(), Cmd_Argv(), Com_Printf(), and UI_PushWindow().

Referenced by UI_InitWindows().

◆ UI_PushDropDownWindow_f()

void UI_PushDropDownWindow_f ( void )

static

Console function to push a dropdown window at a position. It work like UI_PushWindow but move the window at the right position.

See also: UI_PushWindow

Note: The usage is "ui_push_dropdown sourcenode pointposition destinationnode pointposition" sourcenode must be a node into the window we want to push, we will move the window to have sourcenode over destinationnode pointposition select for each node a position (like a corner).

Definition at line 263 of file ui_windows.cpp.

References uiNode_t::box, Cmd_Argc(), Cmd_Argv(), Com_ParseValue(), Com_Printf(), mousePosX, mousePosY, uiNode_t::name, uiBox_t::pos, Q_streq, RESULT_OK, uiNode_t::root, UI_GetNodeByPath(), UI_NodeGetPoint(), UI_NodeRelativeToAbsolutePoint(), UI_PushWindow(), and V_INT.

Referenced by UI_InitWindows().

◆ UI_PushWindow()

uiNode_t * UI_PushWindow	(	const char *	name,
		const char *	parentName,
		linkedList_t *	params )

Push a window onto the window stack.

Parameters

[in]	name	Name of the window to push onto window stack
[in]	parentName	Window name to link as parent-child (else nullptr)
[in]	params	List of string parameters to send to the onWindowOpened method. It can be nullptr when there is no parameters, else this object must be freed by the caller.

Returns: A pointer to uiNode_t

Definition at line 170 of file ui_windows.cpp.

References Com_Printf(), key_game, Key_SetDest(), name, UI_DeleteWindowFromStack(), UI_GetWindow(), UI_GetWindowPositionFromStackByName(), ui_global, UI_InsertWindowIntoStack(), UI_InvalidateMouse(), UI_MAX_WINDOWSTACK, UI_Node_WindowOpened(), UI_ReleaseInput(), and WINDOWEXTRADATA.

Referenced by _wrap_push_window(), CL_BattlescapeRadarOpen_f(), CL_ConnectionlessPacket(), CL_HudRadarDown_f(), GAME_InitMissionBriefing(), Irc_Client_CmdPrivmsg(), Irc_Client_Invite_f(), Irc_Input_Activate_f(), Irc_Proto_ProcessServerMsg(), UI_CloseWindowByRef(), UI_InitStack(), UI_Popup(), UI_PopupButton(), UI_PopupList(), UI_PushChildWindow_f(), UI_PushDropDownWindow_f(), UI_PushWindow_(), UI_PushWindow_f(), UI_Restart_f(), uiWindowNode_t_open(), cgame_import_t::void(), and WEB_CheckAuth().

◆ UI_PushWindow_f()

void UI_PushWindow_f ( void )

static

Console function to push a window onto the window stack.

See also: UI_PushWindow

Definition at line 240 of file ui_windows.cpp.

References Cmd_Argc(), Cmd_Argv(), Com_Printf(), i, LIST_AddString(), LIST_Delete(), and UI_PushWindow().

Referenced by UI_InitWindows().

◆ UI_RemoveWindow()

void UI_RemoveWindow ( uiNode_t * window )

Removes a window from the list of all windows.

Parameters

[in] window Pointer to the window node to remove

Note: Leaves no gap, keeps sorting

Definition at line 644 of file ui_windows.cpp.

References REMOVE_ELEM, and ui_global.

Referenced by uiWindowNode::deleteNode().

◆ UI_RemoveWindowAtPositionFromStack()

void UI_RemoveWindowAtPositionFromStack ( int position )

static

Definition at line 320 of file ui_windows.cpp.

References i, and ui_global.

Referenced by UI_CloseWindowByRef().

◆ UI_SetNewWindowPos()

void UI_SetNewWindowPos	(	uiNode_t *	window,
		int	x,
		int	y )

Sets new x and y coordinates for a given window.

Todo: remove that

Definition at line 606 of file ui_windows.cpp.

References uiNode_t::box, uiBox_t::pos, and Vector2Set.

Referenced by uiControlNode::onCapturedMouseMove().

Variable Documentation

◆ ui_sys_active

cvar_t* ui_sys_active

static

Main window of a stack.

Definition at line 49 of file ui_windows.cpp.

Referenced by UI_CloseWindowByRef(), and UI_InitWindows().

◆ ui_sys_main

cvar_t* ui_sys_main

static

Window name use as alternative for option.

Definition at line 44 of file ui_windows.cpp.

Referenced by UI_CloseWindowByRef(), and UI_InitWindows().

Macros

Functions

Variables

Macro Definition Documentation

◆ WINDOWEXTRADATA

◆ WINDOWEXTRADATACONST

Function Documentation

◆ UI_CloseAllWindow()

◆ UI_CloseWindow()

◆ UI_CloseWindow_f()

◆ UI_CloseWindowByRef()

◆ UI_CompleteWithWindow()

◆ UI_DebugListWindows_f()

◆ UI_DebugTree()

◆ UI_DebugTree_f()

◆ UI_DeleteWindowFromStack()

◆ UI_FinishWindowsInit()

◆ UI_GetActiveWindow()

◆ UI_GetActiveWindowName()

◆ UI_GetLastFullScreenWindow()

◆ UI_GetWindow()

◆ UI_GetWindowPositionFromStackByName()

◆ UI_InitStack()

◆ UI_InitStack_f()

◆ UI_InitWindows()

◆ UI_InsertWindow()

◆ UI_InsertWindowIntoStack()

◆ UI_InvalidateStack()

◆ UI_IsMouseOnWindow()

◆ UI_IsWindowOnStack()

◆ UI_MoveWindowOnTop()

◆ UI_Popup_f()

◆ UI_PopWindow()

◆ UI_PopWindow_f()

◆ UI_PopWindowWithEscKey()

◆ UI_PushChildWindow_f()

◆ UI_PushDropDownWindow_f()

◆ UI_PushWindow()

◆ UI_PushWindow_f()

◆ UI_RemoveWindow()

◆ UI_RemoveWindowAtPositionFromStack()

◆ UI_SetNewWindowPos()

Variable Documentation

◆ ui_sys_active

◆ ui_sys_main